aws-sdk-secretsmanager 1.73.0 → 1.74.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6abefbebaacfaa99c89c50b9f296319665fdcade051775e1ce656c75a9905a99
4
- data.tar.gz: cec4027bc9cd2336ca8ea530db46d340f2199048b962e70ee1ad62776626beea
3
+ metadata.gz: efb289211f35f0bd9dea1edfdb8ef72896e1a904edcfa196ebcce291100beb71
4
+ data.tar.gz: 823681750ab07ab8162b29e3a4c43975280265588ad38270e1aa563be6d7b43d
5
5
  SHA512:
6
- metadata.gz: 50a4c53dc111db3b0c37d4b3d3c7abe61a83d70370d17d012540b43e0abdc9fcbf43a026af856c901823bc2fd838309f787c99c66415cc893a1fe1d1ab7f423c
7
- data.tar.gz: c15e5469af6172361a61ec03cad163ada80885e765b2751644eb606c0a4e5df4d991496329613afadf34c1041ede1a2f0ee930aa8c36b7cfb8d879b6eed511e0
6
+ metadata.gz: d12ed123a3c05184b3317bbb8e0a0883dd6974afc09ee8cc7397164309383ab83b2418add47999c8b07243bb0b9cb5b7de536bc92c4cc5669838e18bbd172478
7
+ data.tar.gz: 20a0bbe1e4b917b6a38e23c59ee63fe93c7217fe1cb567e15c7c21a71f2154e9071306cab6ac41e0522528cf94f359c217b90d8122a02364888702b938df3646
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.74.0 (2023-04-19)
5
+ ------------------
6
+
7
+ * Feature - Documentation updates for Secrets Manager
8
+
4
9
  1.73.0 (2023-03-10)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.73.0
1
+ 1.74.0
@@ -688,7 +688,7 @@ module Aws::SecretsManager
688
688
  #
689
689
  # @option params [Boolean] :force_overwrite_replica_secret
690
690
  # Specifies whether to overwrite a secret with the same name in the
691
- # destination Region.
691
+ # destination Region. By default, secrets aren't overwritten.
692
692
  #
693
693
  # @return [Types::CreateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
694
694
  #
@@ -895,13 +895,13 @@ module Aws::SecretsManager
895
895
  # The number of days from 7 to 30 that Secrets Manager waits before
896
896
  # permanently deleting the secret. You can't use both this parameter
897
897
  # and `ForceDeleteWithoutRecovery` in the same call. If you don't use
898
- # either, then Secrets Manager defaults to a 30 day recovery window.
898
+ # either, then by default Secrets Manager uses a 30 day recovery window.
899
899
  #
900
900
  # @option params [Boolean] :force_delete_without_recovery
901
901
  # Specifies whether to delete the secret without any recovery window.
902
902
  # You can't use both this parameter and `RecoveryWindowInDays` in the
903
- # same call. If you don't use either, then Secrets Manager defaults to
904
- # a 30 day recovery window.
903
+ # same call. If you don't use either, then by default Secrets Manager
904
+ # uses a 30 day recovery window.
905
905
  #
906
906
  # Secrets Manager performs the actual deletion with an asynchronous
907
907
  # background process, so there might be a short delay before the secret
@@ -1456,6 +1456,7 @@ module Aws::SecretsManager
1456
1456
  # Specifies whether to include versions of secrets that don't have any
1457
1457
  # staging labels attached to them. Versions without staging labels are
1458
1458
  # considered deprecated and are subject to deletion by Secrets Manager.
1459
+ # By default, versions without staging labels aren't included.
1459
1460
  #
1460
1461
  # @return [Types::ListSecretVersionIdsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1461
1462
  #
@@ -1568,7 +1569,8 @@ module Aws::SecretsManager
1568
1569
  # [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
1569
1570
  #
1570
1571
  # @option params [Boolean] :include_planned_deletion
1571
- # Specifies whether to include secrets scheduled for deletion.
1572
+ # Specifies whether to include secrets scheduled for deletion. By
1573
+ # default, secrets scheduled for deletion aren't included.
1572
1574
  #
1573
1575
  # @option params [Integer] :max_results
1574
1576
  # The number of results to include in the response.
@@ -1727,7 +1729,7 @@ module Aws::SecretsManager
1727
1729
  # @option params [Boolean] :block_public_policy
1728
1730
  # Specifies whether to block resource-based policies that allow broad
1729
1731
  # access to the secret, for example those that use a wildcard for the
1730
- # principal.
1732
+ # principal. By default, public policies aren't blocked.
1731
1733
  #
1732
1734
  # @return [Types::PutResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1733
1735
  #
@@ -2043,13 +2045,41 @@ module Aws::SecretsManager
2043
2045
  #
2044
2046
  # @option params [Boolean] :force_overwrite_replica_secret
2045
2047
  # Specifies whether to overwrite a secret with the same name in the
2046
- # destination Region.
2048
+ # destination Region. By default, secrets aren't overwritten.
2047
2049
  #
2048
2050
  # @return [Types::ReplicateSecretToRegionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2049
2051
  #
2050
2052
  # * {Types::ReplicateSecretToRegionsResponse#arn #arn} => String
2051
2053
  # * {Types::ReplicateSecretToRegionsResponse#replication_status #replication_status} => Array<Types::ReplicationStatusType>
2052
2054
  #
2055
+ #
2056
+ # @example Example: Example
2057
+ #
2058
+ # # The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key
2059
+ # # aws/secretsmanager.
2060
+ #
2061
+ # resp = client.replicate_secret_to_regions({
2062
+ # add_replica_regions: [
2063
+ # {
2064
+ # region: "eu-west-3",
2065
+ # },
2066
+ # ],
2067
+ # force_overwrite_replica_secret: true,
2068
+ # secret_id: "MyTestSecret",
2069
+ # })
2070
+ #
2071
+ # resp.to_h outputs the following:
2072
+ # {
2073
+ # arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c",
2074
+ # replication_status: [
2075
+ # {
2076
+ # kms_key_id: "alias/aws/secretsmanager",
2077
+ # region: "eu-west-3",
2078
+ # status: "InProgress",
2079
+ # },
2080
+ # ],
2081
+ # }
2082
+ #
2053
2083
  # @example Request syntax with placeholder values
2054
2084
  #
2055
2085
  # resp = client.replicate_secret_to_regions({
@@ -2252,8 +2282,7 @@ module Aws::SecretsManager
2252
2282
  # Lambda rotation function. The test creates an `AWSPENDING` version of
2253
2283
  # the secret and then removes it.
2254
2284
  #
2255
- # If you don't specify this value, then by default, Secrets Manager
2256
- # rotates the secret immediately.
2285
+ # By default, Secrets Manager rotates the secret immediately.
2257
2286
  #
2258
2287
  #
2259
2288
  #
@@ -2968,9 +2997,10 @@ module Aws::SecretsManager
2968
2997
  # because it might be logged. For more information, see [Logging Secrets
2969
2998
  # Manager events with CloudTrail][2].
2970
2999
  #
2971
- # <b>Required permissions: </b> `secretsmanager:ValidateResourcePolicy`.
2972
- # For more information, see [ IAM policy actions for Secrets Manager][3]
2973
- # and [Authentication and access control in Secrets Manager][4].
3000
+ # <b>Required permissions: </b> `secretsmanager:ValidateResourcePolicy`
3001
+ # and `secretsmanager:PutResourcePolicy`. For more information, see [
3002
+ # IAM policy actions for Secrets Manager][3] and [Authentication and
3003
+ # access control in Secrets Manager][4].
2974
3004
  #
2975
3005
  #
2976
3006
  #
@@ -3050,7 +3080,7 @@ module Aws::SecretsManager
3050
3080
  params: params,
3051
3081
  config: config)
3052
3082
  context[:gem_name] = 'aws-sdk-secretsmanager'
3053
- context[:gem_version] = '1.73.0'
3083
+ context[:gem_version] = '1.74.0'
3054
3084
  Seahorse::Client::Request.new(handlers, context)
3055
3085
  end
3056
3086
 
@@ -225,7 +225,7 @@ module Aws::SecretsManager
225
225
  #
226
226
  # @!attribute [rw] force_overwrite_replica_secret
227
227
  # Specifies whether to overwrite a secret with the same name in the
228
- # destination Region.
228
+ # destination Region. By default, secrets aren't overwritten.
229
229
  # @return [Boolean]
230
230
  #
231
231
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CreateSecretRequest AWS API Documentation
@@ -350,14 +350,15 @@ module Aws::SecretsManager
350
350
  # The number of days from 7 to 30 that Secrets Manager waits before
351
351
  # permanently deleting the secret. You can't use both this parameter
352
352
  # and `ForceDeleteWithoutRecovery` in the same call. If you don't use
353
- # either, then Secrets Manager defaults to a 30 day recovery window.
353
+ # either, then by default Secrets Manager uses a 30 day recovery
354
+ # window.
354
355
  # @return [Integer]
355
356
  #
356
357
  # @!attribute [rw] force_delete_without_recovery
357
358
  # Specifies whether to delete the secret without any recovery window.
358
359
  # You can't use both this parameter and `RecoveryWindowInDays` in the
359
- # same call. If you don't use either, then Secrets Manager defaults
360
- # to a 30 day recovery window.
360
+ # same call. If you don't use either, then by default Secrets Manager
361
+ # uses a 30 day recovery window.
361
362
  #
362
363
  # Secrets Manager performs the actual deletion with an asynchronous
363
364
  # background process, so there might be a short delay before the
@@ -620,19 +621,19 @@ module Aws::SecretsManager
620
621
  # @!attribute [rw] key
621
622
  # The following are keys you can use:
622
623
  #
623
- # * **description**\: Prefix match, not case-sensitive.
624
+ # * **description**: Prefix match, not case-sensitive.
624
625
  #
625
- # * **name**\: Prefix match, case-sensitive.
626
+ # * **name**: Prefix match, case-sensitive.
626
627
  #
627
- # * **tag-key**\: Prefix match, case-sensitive.
628
+ # * **tag-key**: Prefix match, case-sensitive.
628
629
  #
629
- # * **tag-value**\: Prefix match, case-sensitive.
630
+ # * **tag-value**: Prefix match, case-sensitive.
630
631
  #
631
- # * **primary-region**\: Prefix match, case-sensitive.
632
+ # * **primary-region**: Prefix match, case-sensitive.
632
633
  #
633
- # * **owning-service**\: Prefix match, case-sensitive.
634
+ # * **owning-service**: Prefix match, case-sensitive.
634
635
  #
635
- # * **all**\: Breaks the filter value string into words and then
636
+ # * **all**: Breaks the filter value string into words and then
636
637
  # searches all attributes for matches. Not case-sensitive.
637
638
  # @return [String]
638
639
  #
@@ -993,7 +994,8 @@ module Aws::SecretsManager
993
994
  # Specifies whether to include versions of secrets that don't have
994
995
  # any staging labels attached to them. Versions without staging labels
995
996
  # are considered deprecated and are subject to deletion by Secrets
996
- # Manager.
997
+ # Manager. By default, versions without staging labels aren't
998
+ # included.
997
999
  # @return [Boolean]
998
1000
  #
999
1001
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListSecretVersionIdsRequest AWS API Documentation
@@ -1039,7 +1041,8 @@ module Aws::SecretsManager
1039
1041
  end
1040
1042
 
1041
1043
  # @!attribute [rw] include_planned_deletion
1042
- # Specifies whether to include secrets scheduled for deletion.
1044
+ # Specifies whether to include secrets scheduled for deletion. By
1045
+ # default, secrets scheduled for deletion aren't included.
1043
1046
  # @return [Boolean]
1044
1047
  #
1045
1048
  # @!attribute [rw] max_results
@@ -1161,7 +1164,7 @@ module Aws::SecretsManager
1161
1164
  # @!attribute [rw] block_public_policy
1162
1165
  # Specifies whether to block resource-based policies that allow broad
1163
1166
  # access to the secret, for example those that use a wildcard for the
1164
- # principal.
1167
+ # principal. By default, public policies aren't blocked.
1165
1168
  # @return [Boolean]
1166
1169
  #
1167
1170
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/PutResourcePolicyRequest AWS API Documentation
@@ -1395,7 +1398,7 @@ module Aws::SecretsManager
1395
1398
  #
1396
1399
  # @!attribute [rw] force_overwrite_replica_secret
1397
1400
  # Specifies whether to overwrite a secret with the same name in the
1398
- # destination Region.
1401
+ # destination Region. By default, secrets aren't overwritten.
1399
1402
  # @return [Boolean]
1400
1403
  #
1401
1404
  # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ReplicateSecretToRegionsRequest AWS API Documentation
@@ -1593,8 +1596,7 @@ module Aws::SecretsManager
1593
1596
  # Lambda rotation function. The test creates an `AWSPENDING` version
1594
1597
  # of the secret and then removes it.
1595
1598
  #
1596
- # If you don't specify this value, then by default, Secrets Manager
1597
- # rotates the secret immediately.
1599
+ # By default, Secrets Manager rotates the secret immediately.
1598
1600
  #
1599
1601
  #
1600
1602
  #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-secretsmanager/customizations'
52
52
  # @!group service
53
53
  module Aws::SecretsManager
54
54
 
55
- GEM_VERSION = '1.73.0'
55
+ GEM_VERSION = '1.74.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-secretsmanager
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.73.0
4
+ version: 1.74.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-03-10 00:00:00.000000000 Z
11
+ date: 2023-04-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core