aws-sdk-secretsmanager 1.73.0 → 1.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6abefbebaacfaa99c89c50b9f296319665fdcade051775e1ce656c75a9905a99
-  data.tar.gz: cec4027bc9cd2336ca8ea530db46d340f2199048b962e70ee1ad62776626beea
+  metadata.gz: a013e3267e462b36da1bf3bbd0aab16d4d0ed62debdfafed5dacf302f8d24549
+  data.tar.gz: e6df7b0a07b40e3dfd948cc0ad6051717ef4464e6bf61af9b9950d87f35be66f
 SHA512:
-  metadata.gz: 50a4c53dc111db3b0c37d4b3d3c7abe61a83d70370d17d012540b43e0abdc9fcbf43a026af856c901823bc2fd838309f787c99c66415cc893a1fe1d1ab7f423c
-  data.tar.gz: c15e5469af6172361a61ec03cad163ada80885e765b2751644eb606c0a4e5df4d991496329613afadf34c1041ede1a2f0ee930aa8c36b7cfb8d879b6eed511e0
+  metadata.gz: cad81313330f840c4463175a57b10a649b71a3cdc653bfc9c2e6fd0a983b0fcdadfa7f4c1f3bebabfdb62e05b67f448366eb09fcc2b64985c0da27f7df1d5a03
+  data.tar.gz: 217f9c20364cdcacd54f5dbd5113bee97cdab1f00322b541aa5a13853e2f1f6d9124e8b1d2f9394802f88d8ae5d25b977c5df994befa224044b91d03c8d64527

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.75.0 (2023-05-16)
+------------------
+
+* Feature - Documentation updates for Secrets Manager
+
+1.74.0 (2023-04-19)
+------------------
+
+* Feature - Documentation updates for Secrets Manager
+
 1.73.0 (2023-03-10)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.73.0
+1.75.0

data/lib/aws-sdk-secretsmanager/client.rb

@@ -688,7 +688,7 @@ module Aws::SecretsManager
     #
     # @option params [Boolean] :force_overwrite_replica_secret
     #   Specifies whether to overwrite a secret with the same name in the
-    #   destination Region.
+    #   destination Region. By default, secrets aren't overwritten.
     #
     # @return [Types::CreateSecretResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -895,13 +895,13 @@ module Aws::SecretsManager
     #   The number of days from 7 to 30 that Secrets Manager waits before
     #   permanently deleting the secret. You can't use both this parameter
     #   and `ForceDeleteWithoutRecovery` in the same call. If you don't use
-    #   either, then Secrets Manager defaults to a 30 day recovery window.
+    #   either, then by default Secrets Manager uses a 30 day recovery window.
     #
     # @option params [Boolean] :force_delete_without_recovery
     #   Specifies whether to delete the secret without any recovery window.
     #   You can't use both this parameter and `RecoveryWindowInDays` in the
-    #   same call. If you don't use either, then Secrets Manager defaults to
-    #   a 30 day recovery window.
+    #   same call. If you don't use either, then by default Secrets Manager
+    #   uses a 30 day recovery window.
     #
     #   Secrets Manager performs the actual deletion with an asynchronous
     #   background process, so there might be a short delay before the secret
@@ -909,6 +909,9 @@ module Aws::SecretsManager
     #   create a secret with the same name, use appropriate back off and retry
     #   logic.
     #
+    #   If you forcibly delete an already deleted or nonexistent secret, the
+    #   operation does not return `ResourceNotFoundException`.
+    #
     #   Use this parameter with caution. This parameter causes the operation
     #   to skip the normal recovery window before the permanent deletion that
     #   Secrets Manager would normally impose with the `RecoveryWindowInDays`
@@ -1456,6 +1459,7 @@ module Aws::SecretsManager
     #   Specifies whether to include versions of secrets that don't have any
     #   staging labels attached to them. Versions without staging labels are
     #   considered deprecated and are subject to deletion by Secrets Manager.
+    #   By default, versions without staging labels aren't included.
     #
     # @return [Types::ListSecretVersionIdsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1568,7 +1572,8 @@ module Aws::SecretsManager
     # [4]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
     #
     # @option params [Boolean] :include_planned_deletion
-    #   Specifies whether to include secrets scheduled for deletion.
+    #   Specifies whether to include secrets scheduled for deletion. By
+    #   default, secrets scheduled for deletion aren't included.
     #
     # @option params [Integer] :max_results
     #   The number of results to include in the response.
@@ -1727,7 +1732,7 @@ module Aws::SecretsManager
     # @option params [Boolean] :block_public_policy
     #   Specifies whether to block resource-based policies that allow broad
     #   access to the secret, for example those that use a wildcard for the
-    #   principal.
+    #   principal. By default, public policies aren't blocked.
     #
     # @return [Types::PutResourcePolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -2043,13 +2048,41 @@ module Aws::SecretsManager
     #
     # @option params [Boolean] :force_overwrite_replica_secret
     #   Specifies whether to overwrite a secret with the same name in the
-    #   destination Region.
+    #   destination Region. By default, secrets aren't overwritten.
     #
     # @return [Types::ReplicateSecretToRegionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ReplicateSecretToRegionsResponse#arn #arn} => String
     #   * {Types::ReplicateSecretToRegionsResponse#replication_status #replication_status} => Array<Types::ReplicationStatusType>
     #
+    #
+    # @example Example: Example
+    #
+    #   # The following example replicates a secret to eu-west-3. The replica is encrypted with the AWS managed key
+    #   # aws/secretsmanager.
+    #
+    #   resp = client.replicate_secret_to_regions({
+    #     add_replica_regions: [
+    #       {
+    #         region: "eu-west-3", 
+    #       }, 
+    #     ], 
+    #     force_overwrite_replica_secret: true, 
+    #     secret_id: "MyTestSecret", 
+    #   })
+    #
+    #   resp.to_h outputs the following:
+    #   {
+    #     arn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestSecret-1a2b3c", 
+    #     replication_status: [
+    #       {
+    #         kms_key_id: "alias/aws/secretsmanager", 
+    #         region: "eu-west-3", 
+    #         status: "InProgress", 
+    #       }, 
+    #     ], 
+    #   }
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.replicate_secret_to_regions({
@@ -2252,8 +2285,7 @@ module Aws::SecretsManager
     #   Lambda rotation function. The test creates an `AWSPENDING` version of
     #   the secret and then removes it.
     #
-    #   If you don't specify this value, then by default, Secrets Manager
-    #   rotates the secret immediately.
+    #   By default, Secrets Manager rotates the secret immediately.
     #
     #
     #
@@ -2968,9 +3000,10 @@ module Aws::SecretsManager
     # because it might be logged. For more information, see [Logging Secrets
     # Manager events with CloudTrail][2].
     #
-    # <b>Required permissions: </b> `secretsmanager:ValidateResourcePolicy`.
-    # For more information, see [ IAM policy actions for Secrets Manager][3]
-    # and [Authentication and access control in Secrets Manager][4].
+    # <b>Required permissions: </b> `secretsmanager:ValidateResourcePolicy`
+    # and `secretsmanager:PutResourcePolicy`. For more information, see [
+    # IAM policy actions for Secrets Manager][3] and [Authentication and
+    # access control in Secrets Manager][4].
     #
     #
     #
@@ -3050,7 +3083,7 @@ module Aws::SecretsManager
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-secretsmanager'
-      context[:gem_version] = '1.73.0'
+      context[:gem_version] = '1.75.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-secretsmanager/types.rb

@@ -225,7 +225,7 @@ module Aws::SecretsManager
     #
     # @!attribute [rw] force_overwrite_replica_secret
     #   Specifies whether to overwrite a secret with the same name in the
-    #   destination Region.
+    #   destination Region. By default, secrets aren't overwritten.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/CreateSecretRequest AWS API Documentation
@@ -350,14 +350,15 @@ module Aws::SecretsManager
     #   The number of days from 7 to 30 that Secrets Manager waits before
     #   permanently deleting the secret. You can't use both this parameter
     #   and `ForceDeleteWithoutRecovery` in the same call. If you don't use
-    #   either, then Secrets Manager defaults to a 30 day recovery window.
+    #   either, then by default Secrets Manager uses a 30 day recovery
+    #   window.
     #   @return [Integer]
     #
     # @!attribute [rw] force_delete_without_recovery
     #   Specifies whether to delete the secret without any recovery window.
     #   You can't use both this parameter and `RecoveryWindowInDays` in the
-    #   same call. If you don't use either, then Secrets Manager defaults
-    #   to a 30 day recovery window.
+    #   same call. If you don't use either, then by default Secrets Manager
+    #   uses a 30 day recovery window.
     #
     #   Secrets Manager performs the actual deletion with an asynchronous
     #   background process, so there might be a short delay before the
@@ -365,6 +366,9 @@ module Aws::SecretsManager
     #   immediately create a secret with the same name, use appropriate back
     #   off and retry logic.
     #
+    #   If you forcibly delete an already deleted or nonexistent secret, the
+    #   operation does not return `ResourceNotFoundException`.
+    #
     #   Use this parameter with caution. This parameter causes the operation
     #   to skip the normal recovery window before the permanent deletion
     #   that Secrets Manager would normally impose with the
@@ -494,9 +498,9 @@ module Aws::SecretsManager
     #   @return [Time]
     #
     # @!attribute [rw] next_rotation_date
-    #   The next date and time that Secrets Manager will rotate the secret,
-    #   rounded to the nearest hour. If the secret isn't configured for
-    #   rotation, Secrets Manager returns null.
+    #   The next rotation is scheduled to occur on or before this date. If
+    #   the secret isn't configured for rotation, Secrets Manager returns
+    #   null.
     #   @return [Time]
     #
     # @!attribute [rw] tags
@@ -620,19 +624,19 @@ module Aws::SecretsManager
     # @!attribute [rw] key
     #   The following are keys you can use:
     #
-    #   * **description**\: Prefix match, not case-sensitive.
+    #   * **description**: Prefix match, not case-sensitive.
     #
-    #   * **name**\: Prefix match, case-sensitive.
+    #   * **name**: Prefix match, case-sensitive.
     #
-    #   * **tag-key**\: Prefix match, case-sensitive.
+    #   * **tag-key**: Prefix match, case-sensitive.
     #
-    #   * **tag-value**\: Prefix match, case-sensitive.
+    #   * **tag-value**: Prefix match, case-sensitive.
     #
-    #   * **primary-region**\: Prefix match, case-sensitive.
+    #   * **primary-region**: Prefix match, case-sensitive.
     #
-    #   * **owning-service**\: Prefix match, case-sensitive.
+    #   * **owning-service**: Prefix match, case-sensitive.
     #
-    #   * **all**\: Breaks the filter value string into words and then
+    #   * **all**: Breaks the filter value string into words and then
     #     searches all attributes for matches. Not case-sensitive.
     #   @return [String]
     #
@@ -993,7 +997,8 @@ module Aws::SecretsManager
     #   Specifies whether to include versions of secrets that don't have
     #   any staging labels attached to them. Versions without staging labels
     #   are considered deprecated and are subject to deletion by Secrets
-    #   Manager.
+    #   Manager. By default, versions without staging labels aren't
+    #   included.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ListSecretVersionIdsRequest AWS API Documentation
@@ -1039,7 +1044,8 @@ module Aws::SecretsManager
     end
 
     # @!attribute [rw] include_planned_deletion
-    #   Specifies whether to include secrets scheduled for deletion.
+    #   Specifies whether to include secrets scheduled for deletion. By
+    #   default, secrets scheduled for deletion aren't included.
     #   @return [Boolean]
     #
     # @!attribute [rw] max_results
@@ -1161,7 +1167,7 @@ module Aws::SecretsManager
     # @!attribute [rw] block_public_policy
     #   Specifies whether to block resource-based policies that allow broad
     #   access to the secret, for example those that use a wildcard for the
-    #   principal.
+    #   principal. By default, public policies aren't blocked.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/PutResourcePolicyRequest AWS API Documentation
@@ -1395,7 +1401,7 @@ module Aws::SecretsManager
     #
     # @!attribute [rw] force_overwrite_replica_secret
     #   Specifies whether to overwrite a secret with the same name in the
-    #   destination Region.
+    #   destination Region. By default, secrets aren't overwritten.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/ReplicateSecretToRegionsRequest AWS API Documentation
@@ -1593,8 +1599,7 @@ module Aws::SecretsManager
     #   Lambda rotation function. The test creates an `AWSPENDING` version
     #   of the secret and then removes it.
     #
-    #   If you don't specify this value, then by default, Secrets Manager
-    #   rotates the secret immediately.
+    #   By default, Secrets Manager rotates the secret immediately.
     #
     #
     #
@@ -1788,9 +1793,9 @@ module Aws::SecretsManager
     #   @return [Time]
     #
     # @!attribute [rw] next_rotation_date
-    #   The next date and time that Secrets Manager will attempt to rotate
-    #   the secret, rounded to the nearest hour. This value is null if the
-    #   secret is not set up for rotation.
+    #   The next rotation is scheduled to occur on or before this date. If
+    #   the secret isn't configured for rotation, Secrets Manager returns
+    #   null.
     #   @return [Time]
     #
     # @!attribute [rw] tags

data/lib/aws-sdk-secretsmanager.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-secretsmanager/customizations'
 # @!group service
 module Aws::SecretsManager
 
-  GEM_VERSION = '1.73.0'
+  GEM_VERSION = '1.75.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-secretsmanager
 version: !ruby/object:Gem::Version
-  version: 1.73.0
+  version: 1.75.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-10 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core