diff --git a/CHANGELOG.md b/CHANGELOG.md
index 532294c189c1..35731ef39a5c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,8 @@
+# __1.12.129__ __2021-12-13__
+## __AWS Secrets Manager__
+ - ### Features
+ - Documentation updates for Secrets Manager
+
# __1.12.128__ __2021-12-09__
## __AWS Network Firewall__
- ### Features
diff --git a/README.md b/README.md
index ad7d83225ec4..b156b372ed7c 100644
--- a/README.md
+++ b/README.md
@@ -51,7 +51,7 @@ dependencies.
Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including downloading and installing them, see Tools for Amazon Web Services.
We recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the Amazon Web Services Secrets Manager User Guide.
Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
How examples are presented
The JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a response to HTTP query requests contain single, long strings without line breaks or white space formatting. The JSON shown in the examples displays the code formatted with both line breaks and white space to improve readability. When example input parameters can also cause long strings extending beyond the screen, you can insert line breaks to enhance readability. You should always submit the input as a single JSON text string.
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
", + "documentation" : "Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including downloading and installing them, see Tools for Amazon Web Services.
We recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the Amazon Web Services Secrets Manager User Guide.
Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
How examples are presented
The JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a response to HTTP query requests contain single, long strings without line breaks or white space formatting. The JSON shown in the examples displays the code formatted with both line breaks and white space to improve readability. When example input parameters can also cause long strings extending beyond the screen, you can insert line breaks to enhance readability. You should always submit the input as a single JSON text string.
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
", "endpointPrefix" : "secretsmanager", "hasApiWithStreamInput" : false, "ionProtocol" : false, @@ -92,18 +92,18 @@ "asyncReturnType" : "CancelRotateSecretResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress.
To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. This immediately rotates your secret and then enables the automatic schedule.
If you cancel a rotation while in progress, it can leave the VersionStage
labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING
from the partially created version, specified by the VersionId
response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version VersionStage
field.
To successfully start a rotation, the staging label AWSPENDING
must be in one of the following states:
Not attached to any version at all
Attached to the same version as the staging label AWSCURRENT
If the staging label AWSPENDING
attached to a different version than the version with AWSCURRENT
then the attempt to rotate fails.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CancelRotateSecret
Related operations
To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.
To get the rotation configuration details for a secret, use DescribeSecret.
To list all of the currently available secrets, use ListSecrets.
To list all of the versions currently associated with a secret, use ListSecretVersionIds.
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
To turn on automatic rotation again, call RotateSecret.
If you cancel a rotation in progress, it can leave the VersionStage
labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING
from the partially created version, specified by the VersionId
response value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can delete a version by removing all staging labels from it.
We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -111,7 +111,7 @@ "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
Secrets Manager stores the encrypted secret data in one of a collection of \"versions\" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more \"staging labels\" that identify where the version is in the rotation cycle. The SecretVersionsToStages
field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and not included in the list.
You provide the secret data to be encrypted by putting text in either the SecretString
parameter or binary data in the SecretBinary
parameter, but not both. If you include SecretString
or SecretBinary
then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT
to the new version.
If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same Amazon Web Services account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId
. If you call an API that must encrypt or decrypt SecretString
or SecretBinary
using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CreateSecret
kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account default Amazon Web Services managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account default Amazon Web Services managed CMK for Secrets Manager.
secretsmanager:TagResource - needed only if you include the Tags
parameter.
Related operations
To delete a secret, use DeleteSecret.
To modify an existing secret, use UpdateSecret.
To create a new version of a secret, use PutSecretValue.
To retrieve the encrypted secure string and secure binary values, use GetSecretValue.
To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.
To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages
response value.
Creates a new secret. A secret is a set of credentials, such as a user name and password, that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
For information about creating a secret in the console, see Create a secret.
To create a secret, you can provide the secret value to be encrypted in either the SecretString
parameter or the SecretBinary
parameter, but not both. If you include SecretString
or SecretBinary
then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT
to it.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
The request failed because it would exceed one of the Secrets Manager internal limits.
", + "documentation" : "The request failed because it would exceed one of the Secrets Manager quotas.
", "httpStatusCode" : null }, { "exceptionName" : "EncryptionFailureException", - "documentation" : "Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
", + "documentation" : "Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
", "httpStatusCode" : null }, { "exceptionName" : "ResourceExistsException", @@ -168,11 +168,11 @@ "httpStatusCode" : null }, { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "MalformedPolicyDocumentException", - "documentation" : "You provided a resource-based policy with syntax errors.
", + "documentation" : "The resource policy has syntax errors.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -210,14 +210,14 @@ "asyncReturnType" : "DeleteResourcePolicyResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Deletes the resource-based permission policy attached to the secret.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DeleteResourcePolicy
Related operations
To attach a resource policy to a secret, use PutResourcePolicy.
To retrieve the current resource-based policy attached to a secret, use GetResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -225,11 +225,11 @@ "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null } ], "hasBlobMemberAsPayload" : false, @@ -259,22 +259,22 @@ "asyncReturnType" : "DeleteSecretResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Deletes an entire secret and all of the versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate
stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
and cancel the deletion of the secret.
You cannot access the encrypted secret information in any secret scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.
There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the VersionStage
field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions without any staging labels do not show up in ListSecretVersionIds unless you specify IncludeDeprecated
.
The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DeleteSecret
Related operations
To create a secret, use CreateSecret.
To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret.
Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate
stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
and cancel the deletion of the secret.
In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields populated with a value in the response.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DescribeSecret
Related operations
To create a secret, use CreateSecret.
To modify a secret, use UpdateSecret.
To retrieve the encrypted secret information in a version of the secret, use GetSecretValue.
To list all of the secrets in the Amazon Web Services account, use ListSecrets.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -323,7 +323,7 @@ "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null } ], "hasBlobMemberAsPayload" : false, @@ -353,18 +353,18 @@ "asyncReturnType" : "GetRandomPasswordResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetRandomPassword
Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetResourcePolicy
Related operations
To attach a resource policy to a secret, use PutResourcePolicy.
To delete the resource-based policy attached to a secret, use DeleteResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -413,11 +413,11 @@ "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null } ], "hasBlobMemberAsPayload" : false, @@ -447,22 +447,22 @@ "asyncReturnType" : "GetSecretValueResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Retrieves the contents of the encrypted fields SecretString
or SecretBinary
from the specified version of a secret, whichever contains content.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetSecretValue
kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager.
Related operations
To create a new version of the secret with different encrypted information, use PutSecretValue.
To retrieve the non-encrypted details for the secret, use DescribeSecret.
Retrieves the contents of the encrypted fields SecretString
or SecretBinary
from the specified version of a secret, whichever contains content.
For information about retrieving the secret value in the console, see Retrieve secrets.
To run this command, you must have secretsmanager:GetSecretValue
permissions. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager
, then you also need kms:Decrypt
permissions for that key.
We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
Lists all of the versions attached to the specified secret. The output does not include the SecretString
or SecretBinary
fields. By default, the list includes only versions that have at least one staging label in VersionStage
attached.
Always check the NextToken
response parameter when calling any of the List*
operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the NextToken
response parameter contains a value to pass to the next call to the same API to request the next part of the list.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:ListSecretVersionIds
Related operations
To list the secrets in an account, use ListSecrets.
Lists the versions for a secret.
To list the secrets in the account, use ListSecrets.
To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
Minimum permissions
To run this command, you must have secretsmanager:ListSecretVersionIds
permissions.
You provided an invalid NextToken
value.
The NextToken
value is invalid.
We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -519,7 +519,7 @@ "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null } ], "hasBlobMemberAsPayload" : false, @@ -549,18 +549,18 @@ "asyncReturnType" : "ListSecretsResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString
and SecretBinary
are not included in the output. To get that information, call the GetSecretValue operation.
Always check the NextToken
response parameter when calling any of the List*
operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the NextToken
response parameter contains a value to pass to the next call to the same API to request the next part of the list.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:ListSecrets
Related operations
To list the versions attached to a secret, use ListSecretVersionIds.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account.
To list the versions of a secret, use ListSecretVersionIds.
To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
For information about finding secrets in the console, see Enhanced search capabilities for secrets in Secrets Manager.
Minimum permissions
To run this command, you must have secretsmanager:ListSecrets
permissions.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidNextTokenException", - "documentation" : "You provided an invalid NextToken
value.
The NextToken
value is invalid.
Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources
element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for Amazon Web Services Secrets Manager. For the complete description of the Amazon Web Services policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:PutResourcePolicy
Related operations
To retrieve the resource policy attached to a secret, use GetResourcePolicy.
To delete the resource-based policy attached to a secret, use DeleteResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "MalformedPolicyDocumentException", - "documentation" : "You provided a resource-based policy with syntax errors.
", + "documentation" : "The resource policy has syntax errors.
", "httpStatusCode" : null }, { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -617,11 +617,11 @@ "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.
", + "documentation" : "The BlockPublicPolicy
parameter is set to true, and the resource policy did not prevent broad access to the secret.
Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString
value or a new SecretBinary
value. You can also specify the staging labels that are initially attached to the new version.
We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT
to the new version.
If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
If this operation moves the staging label AWSCURRENT
from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
This operation is idempotent. If a version with a VersionId
with the same value as the ClientRequestToken
parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.
If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same Amazon Web Services account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId
. If you call an API that must encrypt or decrypt SecretString
or SecretBinary
using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:PutSecretValue
kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager.
Related operations
To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
To create a secret, use CreateSecret.
To get the details for a secret, use DescribeSecret.
To list the versions attached to a secret, use ListSecretVersionIds.
Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString
value or a new SecretBinary
value.
We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages
. If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT
to it .
If this operation moves the staging label AWSCURRENT
from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
This operation is idempotent. If a version with a VersionId
with the same value as the ClientRequestToken
parameter already exists, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
The request failed because it would exceed one of the Secrets Manager internal limits.
", + "documentation" : "The request failed because it would exceed one of the Secrets Manager quotas.
", "httpStatusCode" : null }, { "exceptionName" : "EncryptionFailureException", - "documentation" : "Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
", + "documentation" : "Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
", "httpStatusCode" : null }, { "exceptionName" : "ResourceExistsException", @@ -678,7 +678,7 @@ "httpStatusCode" : null }, { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -712,22 +712,22 @@ "asyncReturnType" : "RemoveRegionsFromReplicationResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Remove regions from replication.
", + "documentation" : "For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -761,22 +761,22 @@ "asyncReturnType" : "ReplicateSecretToRegionsResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions.
", + "documentation" : "Replicates the secret to a new Regions. See Multi-Region secrets.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -810,22 +810,22 @@ "asyncReturnType" : "RestoreSecretResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. This makes the secret accessible to query once again.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:RestoreSecret
Related operations
To delete a secret, use DeleteSecret.
Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. You can access a secret again after it has been restored.
We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.
This required configuration information includes the ARN of an Amazon Web Services Lambda function and optionally, the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT
so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.
The rotation function must end with the versions of the secret in one of two states:
The AWSPENDING
and AWSCURRENT
staging labels are attached to the same version of the secret, or
The AWSPENDING
staging label is not attached to any version of the secret.
If the AWSPENDING
staging label is present but not attached to the same version as AWSCURRENT
then any later invocation of RotateSecret
assumes that a previous rotation request is still in progress and returns an error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:RotateSecret
lambda:InvokeFunction (on the function specified in the secret's metadata)
Related operations
To list the secrets in your account, use ListSecrets.
To get the details for a version of a secret, use DescribeSecret.
To create a new version of a secret, use CreateSecret.
To attach staging labels to or remove staging labels from a version of a secret, use UpdateSecretVersionStage.
Configures and starts the asynchronous process of rotating the secret.
If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. For more information about rotation, see Rotate secrets.
To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT
. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works.
When rotation is successful, the AWSPENDING
staging label might be attached to the same version as the AWSCURRENT
version, or it might not be attached to any version.
If the AWSPENDING
staging label is present but not attached to the same version as AWSCURRENT
, then any later invocation of RotateSecret
assumes that a previous rotation request is still in progress and returns an error.
To run this command, you must have secretsmanager:RotateSecret
permissions and lambda:InvokeFunction
permissions on the function specified in the secret's metadata.
We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -878,7 +878,7 @@ "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
Removes the secret from replication and promotes the secret to a regional secret in the replica Region.
", + "documentation" : "Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
You must call this operation from the Region in which you want to promote the replica to a primary secret.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -957,22 +957,22 @@ "asyncReturnType" : "TagResourceResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:TagResource
Related operations
To remove one or more tags from the collection attached to a secret, use UntagResource.
To view the list of tags attached to a secret, use DescribeSecret.
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -1006,22 +1006,22 @@ "asyncReturnType" : "UntagResourceResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Removes one or more tags from the specified secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UntagResource
Related operations
To add one or more tags to the collection attached to a secret, use TagResource.
To view the list of tags attached to a secret, use DescribeSecret.
Removes specific tags from a secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -1055,26 +1055,26 @@ "asyncReturnType" : "UpdateSecretResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Modifies many of the details of the specified secret.
To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
We recommend you avoid calling UpdateSecret
at a sustained rate of more than once every 10 minutes. When you call UpdateSecret
to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
The Secrets Manager console uses only the SecretString
parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
If a version with a VersionId
with the same value as the ClientRequestToken
parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.
If you include SecretString
or SecretBinary
to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT
to the new version.
If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same Amazon Web Services account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId
. If you call an API that must encrypt or decrypt SecretString
or SecretBinary
using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecret
kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager.
Related operations
To create a new secret, use CreateSecret.
To add only a new version to an existing secret, use PutSecretValue.
To get the details for a secret, use DescribeSecret.
To list the versions contained in a secret, use ListSecretVersionIds.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
We recommend you avoid calling UpdateSecret
at a sustained rate of more than once every 10 minutes. When you call UpdateSecret
to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If you include SecretString
or SecretBinary
to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT
to the new version.
If you call this operation with a VersionId
that matches an existing version's ClientRequestToken
, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed key.
To run this command, you must have secretsmanager:UpdateSecret
permissions. If you use a customer managed key, you must also have kms:GenerateDataKey
and kms:Decrypt
permissions .
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
The request failed because it would exceed one of the Secrets Manager internal limits.
", + "documentation" : "The request failed because it would exceed one of the Secrets Manager quotas.
", "httpStatusCode" : null }, { "exceptionName" : "EncryptionFailureException", - "documentation" : "Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
", + "documentation" : "Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
", "httpStatusCode" : null }, { "exceptionName" : "ResourceExistsException", @@ -1082,11 +1082,11 @@ "httpStatusCode" : null }, { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "MalformedPolicyDocumentException", - "documentation" : "You provided a resource-based policy with syntax errors.
", + "documentation" : "The resource policy has syntax errors.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -1124,26 +1124,26 @@ "asyncReturnType" : "UpdateSecretVersionStageResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
The staging labels that you specify in the VersionStage
parameter are added to the existing list of staging labels--they don't replace it.
You can move the AWSCURRENT
staging label to this version by including it in this call.
Whenever you move AWSCURRENT
, Secrets Manager automatically moves the label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecretVersionStage
Related operations
To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret
and examine the SecretVersionsToStages
response value.
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage
parameter are added to the existing list of staging labels for the version.
You can move the AWSCURRENT
staging label to this version by including it in this call.
Whenever you move AWSCURRENT
, Secrets Manager automatically moves the label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
", "endpointCacheRequired" : false, "endpointDiscovery" : null, "endpointOperation" : false, "endpointTrait" : null, "exceptions" : [ { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
The request failed because it would exceed one of the Secrets Manager internal limits.
", + "documentation" : "The request failed because it would exceed one of the Secrets Manager quotas.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -1177,22 +1177,22 @@ "asyncReturnType" : "ValidateResourcePolicyResult", "authenticated" : true, "deprecated" : false, - "documentation" : "Validates that the resource policy does not grant a wide range of IAM principals access to your secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string. A resource-based policy is optional for secrets.
The API performs three checks when validating the secret:
Sends a call to Zelkova, an automated reasoning engine, to ensure your Resource Policy does not allow broad access to your secret.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.
Minimum Permissions
You must have the permissions required to access the following APIs:
secretsmanager:PutResourcePolicy
secretsmanager:ValidateResourcePolicy
Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.
The API performs three checks when validating the policy:
Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.
You provided a resource-based policy with syntax errors.
", + "documentation" : "The resource policy has syntax errors.
", "httpStatusCode" : null }, { "exceptionName" : "ResourceNotFoundException", - "documentation" : "We can't find the resource that you asked for.
", + "documentation" : "Secrets Manager can't find the resource that you asked for.
", "httpStatusCode" : null }, { "exceptionName" : "InvalidParameterException", - "documentation" : "You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "httpStatusCode" : null }, { "exceptionName" : "InternalServiceErrorException", @@ -1200,7 +1200,7 @@ "httpStatusCode" : null }, { "exceptionName" : "InvalidRequestException", - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -1295,7 +1295,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -1310,13 +1310,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -1327,12 +1327,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -1366,7 +1366,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -1381,13 +1381,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -1437,12 +1437,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "The ARN of the secret for which rotation was canceled.
", + "documentation" : "The ARN of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret for which rotation was canceled.
\n@param aRN The ARN of the secret for which rotation was canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret for which rotation was canceled.
\n@return The ARN of the secret for which rotation was canceled.*/", + "getterDocumentation" : "/**The ARN of the secret.
\n@return The ARN of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -1476,7 +1476,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret for which rotation was canceled.
\n@param aRN The ARN of the secret for which rotation was canceled.*/", + "setterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -1491,13 +1491,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret for which rotation was canceled.
\n@param aRN The ARN of the secret for which rotation was canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret for which rotation was canceled.
", + "documentation" : "The ARN of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -1506,12 +1506,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret for which rotation was canceled.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret for which rotation was canceled.
\n@param name The friendly name of the secret for which rotation was canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret for which rotation was canceled.
\n@return The friendly name of the secret for which rotation was canceled.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -1545,7 +1545,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret for which rotation was canceled.
\n@param name The friendly name of the secret for which rotation was canceled.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -1560,13 +1560,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret for which rotation was canceled.
\n@param name The friendly name of the secret for which rotation was canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret for which rotation was canceled.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -1575,12 +1575,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withVersionId",
- "getterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.*/",
+ "getterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.*/",
"getterMethodName" : "getVersionId",
"getterModel" : {
"returnType" : "String",
@@ -1614,7 +1614,7 @@
"marshallingType" : "STRING",
"name" : "VersionId",
"sensitive" : false,
- "setterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.*/",
+ "setterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.*/",
"setterMethodName" : "setVersionId",
"setterModel" : {
"timestampFormat" : null,
@@ -1629,13 +1629,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "versionId",
"variableType" : "String",
- "documentation" : "The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
The ARN of the secret for which rotation was canceled.
", + "documentation" : "The ARN of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret for which rotation was canceled.
\n@param aRN The ARN of the secret for which rotation was canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret for which rotation was canceled.
\n@return The ARN of the secret for which rotation was canceled.*/", + "getterDocumentation" : "/**The ARN of the secret.
\n@return The ARN of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -1685,7 +1685,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret for which rotation was canceled.
\n@param aRN The ARN of the secret for which rotation was canceled.*/", + "setterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -1700,13 +1700,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret for which rotation was canceled.
\n@param aRN The ARN of the secret for which rotation was canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret for which rotation was canceled.
", + "documentation" : "The ARN of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -1716,12 +1716,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret for which rotation was canceled.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret for which rotation was canceled.
\n@param name The friendly name of the secret for which rotation was canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret for which rotation was canceled.
\n@return The friendly name of the secret for which rotation was canceled.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -1755,7 +1755,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret for which rotation was canceled.
\n@param name The friendly name of the secret for which rotation was canceled.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -1770,13 +1770,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret for which rotation was canceled.
\n@param name The friendly name of the secret for which rotation was canceled.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret for which rotation was canceled.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -1786,12 +1786,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withVersionId",
- "getterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.*/",
+ "getterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.*/",
"getterMethodName" : "getVersionId",
"getterModel" : {
"returnType" : "String",
@@ -1825,7 +1825,7 @@
"marshallingType" : "STRING",
"name" : "VersionId",
"sensitive" : false,
- "setterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.*/",
+ "setterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.*/",
"setterMethodName" : "setVersionId",
"setterModel" : {
"timestampFormat" : null,
@@ -1840,13 +1840,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "versionId",
"variableType" : "String",
- "documentation" : "The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
\n@param name The name of the new secret.The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
*/", + "getterDocumentation" : "/**The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
\n@return The name of the new secret.The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -1945,7 +1945,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
*/", + "setterDocumentation" : "/**The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
\n@param name The name of the new secret.The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -1960,13 +1960,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
\n@param name The name of the new secret.The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -1975,12 +1975,12 @@ "c2jName" : "ClientRequestToken", "c2jShape" : "ClientRequestTokenType", "deprecated" : false, - "documentation" : "(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withClientRequestToken",
- "getterDocumentation" : "/**
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.*/",
+ "getterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.*/",
"getterMethodName" : "getClientRequestToken",
"getterModel" : {
"returnType" : "String",
@@ -2014,7 +2014,7 @@
"marshallingType" : "STRING",
"name" : "ClientRequestToken",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.*/",
+ "setterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.*/",
"setterMethodName" : "setClientRequestToken",
"setterModel" : {
"timestampFormat" : null,
@@ -2029,13 +2029,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "clientRequestToken",
"variableType" : "String",
- "documentation" : "
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
(Optional) Specifies a user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies a user-provided description of the secret.
\n@param description (Optional) Specifies a user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withDescription", - "getterDocumentation" : "/**(Optional) Specifies a user-provided description of the secret.
\n@return (Optional) Specifies a user-provided description of the secret.*/", + "getterDocumentation" : "/**The description of the secret.
\n@return The description of the secret.*/", "getterMethodName" : "getDescription", "getterModel" : { "returnType" : "String", @@ -2083,7 +2083,7 @@ "marshallingType" : "STRING", "name" : "Description", "sensitive" : false, - "setterDocumentation" : "/**(Optional) Specifies a user-provided description of the secret.
\n@param description (Optional) Specifies a user-provided description of the secret.*/", + "setterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.*/", "setterMethodName" : "setDescription", "setterModel" : { "timestampFormat" : null, @@ -2098,13 +2098,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Specifies a user-provided description of the secret.
\n@param description (Optional) Specifies a user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "description", "variableType" : "String", - "documentation" : "(Optional) Specifies a user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -2113,12 +2113,12 @@ "c2jName" : "KmsKeyId", "c2jShape" : "KmsKeyIdType", "deprecated" : false, - "documentation" : "(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret. You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withKmsKeyId",
- "getterDocumentation" : "/**
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret. You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
*/", + "getterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.*/",
"getterMethodName" : "getKmsKeyId",
"getterModel" : {
"returnType" : "String",
@@ -2152,7 +2152,7 @@
"marshallingType" : "STRING",
"name" : "KmsKeyId",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret. You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
*/", + "setterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.*/",
"setterMethodName" : "setKmsKeyId",
"setterModel" : {
"timestampFormat" : null,
@@ -2167,13 +2167,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret. You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "kmsKeyId",
"variableType" : "String",
- "documentation" : "
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretBinary", - "getterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.*/", + "getterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.*/", "getterMethodName" : "getSecretBinary", "getterModel" : { "returnType" : "java.nio.ByteBuffer", @@ -2221,7 +2221,7 @@ "marshallingType" : "BYTE_BUFFER", "name" : "SecretBinary", "sensitive" : true, - "setterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.*/", + "setterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.*/", "setterMethodName" : "setSecretBinary", "setterModel" : { "timestampFormat" : null, @@ -2236,13 +2236,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.nio.ByteBuffer", "variableName" : "secretBinary", "variableType" : "java.nio.ByteBuffer", - "documentation" : "
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
", "simpleType" : "ByteBuffer", "variableSetterType" : "java.nio.ByteBuffer" }, @@ -2251,12 +2251,12 @@ "c2jName" : "SecretString", "c2jShape" : "SecretStringType", "deprecated" : false, - "documentation" : "(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withSecretString",
- "getterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.*/",
"getterMethodName" : "getSecretString",
"getterModel" : {
"returnType" : "String",
@@ -2290,7 +2290,7 @@
"marshallingType" : "STRING",
"name" : "SecretString",
"sensitive" : true,
- "setterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.*/",
"setterMethodName" : "setSecretString",
"setterModel" : {
"timestampFormat" : null,
@@ -2305,13 +2305,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "secretString",
"variableType" : "String",
- "documentation" : "
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
NOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
NOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
", + "documentation" : "A list of Regions and KMS keys to replicate secrets.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
\n@param addReplicaRegions (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A list of Regions and KMS keys to replicate secrets.
\n@param addReplicaRegions A list of Regions and KMS keys to replicate secrets.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withAddReplicaRegions", - "getterDocumentation" : "/**(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
\n@return (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.*/", + "getterDocumentation" : "/**A list of Regions and KMS keys to replicate secrets.
\n@return A list of Regions and KMS keys to replicate secrets.*/", "getterMethodName" : "getAddReplicaRegions", "getterModel" : { "returnType" : "java.util.List(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
\n@param addReplicaRegions (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.*/", + "setterDocumentation" : "/**A list of Regions and KMS keys to replicate secrets.
\n@param addReplicaRegions A list of Regions and KMS keys to replicate secrets.*/", "setterMethodName" : "setAddReplicaRegions", "setterModel" : { "timestampFormat" : null, @@ -2611,13 +2611,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setAddReplicaRegions(java.util.Collection)} or {@link #withAddReplicaRegions(java.util.Collection)} if you want to override the existing values.
\n@param addReplicaRegions (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A list of Regions and KMS keys to replicate secrets.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setAddReplicaRegions(java.util.Collection)} or {@link #withAddReplicaRegions(java.util.Collection)} if you want to override the existing values.
\n@param addReplicaRegions A list of Regions and KMS keys to replicate secrets.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.List(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
", + "documentation" : "A list of Regions and KMS keys to replicate secrets.
", "simpleType" : "List(Optional) If set, the replication overwrites a secret with the same name in the destination region.
", + "documentation" : "Specifies whether to overwrite a secret with the same name in the destination Region.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) If set, the replication overwrites a secret with the same name in the destination region.
\n@param forceOverwriteReplicaSecret (Optional) If set, the replication overwrites a secret with the same name in the destination region.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to overwrite a secret with the same name in the destination Region.
\n@param forceOverwriteReplicaSecret Specifies whether to overwrite a secret with the same name in the destination Region.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withForceOverwriteReplicaSecret", - "getterDocumentation" : "/**(Optional) If set, the replication overwrites a secret with the same name in the destination region.
\n@return (Optional) If set, the replication overwrites a secret with the same name in the destination region.*/", + "getterDocumentation" : "/**Specifies whether to overwrite a secret with the same name in the destination Region.
\n@return Specifies whether to overwrite a secret with the same name in the destination Region.*/", "getterMethodName" : "getForceOverwriteReplicaSecret", "getterModel" : { "returnType" : "Boolean", @@ -2665,7 +2665,7 @@ "marshallingType" : "BOOLEAN", "name" : "ForceOverwriteReplicaSecret", "sensitive" : false, - "setterDocumentation" : "/**(Optional) If set, the replication overwrites a secret with the same name in the destination region.
\n@param forceOverwriteReplicaSecret (Optional) If set, the replication overwrites a secret with the same name in the destination region.*/", + "setterDocumentation" : "/**Specifies whether to overwrite a secret with the same name in the destination Region.
\n@param forceOverwriteReplicaSecret Specifies whether to overwrite a secret with the same name in the destination Region.*/", "setterMethodName" : "setForceOverwriteReplicaSecret", "setterModel" : { "timestampFormat" : null, @@ -2680,13 +2680,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) If set, the replication overwrites a secret with the same name in the destination region.
\n@param forceOverwriteReplicaSecret (Optional) If set, the replication overwrites a secret with the same name in the destination region.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to overwrite a secret with the same name in the destination Region.
\n@param forceOverwriteReplicaSecret Specifies whether to overwrite a secret with the same name in the destination Region.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "forceOverwriteReplicaSecret", "variableType" : "Boolean", - "documentation" : "(Optional) If set, the replication overwrites a secret with the same name in the destination region.
", + "documentation" : "Specifies whether to overwrite a secret with the same name in the destination Region.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -2697,12 +2697,12 @@ "c2jName" : "AddReplicaRegions", "c2jShape" : "AddReplicaRegionListType", "deprecated" : false, - "documentation" : "(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
", + "documentation" : "A list of Regions and KMS keys to replicate secrets.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
\n@param addReplicaRegions (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A list of Regions and KMS keys to replicate secrets.
\n@param addReplicaRegions A list of Regions and KMS keys to replicate secrets.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withAddReplicaRegions", - "getterDocumentation" : "/**(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
\n@return (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.*/", + "getterDocumentation" : "/**A list of Regions and KMS keys to replicate secrets.
\n@return A list of Regions and KMS keys to replicate secrets.*/", "getterMethodName" : "getAddReplicaRegions", "getterModel" : { "returnType" : "java.util.List(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
\n@param addReplicaRegions (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.*/", + "setterDocumentation" : "/**A list of Regions and KMS keys to replicate secrets.
\n@param addReplicaRegions A list of Regions and KMS keys to replicate secrets.*/", "setterMethodName" : "setAddReplicaRegions", "setterModel" : { "timestampFormat" : null, @@ -2835,13 +2835,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setAddReplicaRegions(java.util.Collection)} or {@link #withAddReplicaRegions(java.util.Collection)} if you want to override the existing values.
\n@param addReplicaRegions (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A list of Regions and KMS keys to replicate secrets.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setAddReplicaRegions(java.util.Collection)} or {@link #withAddReplicaRegions(java.util.Collection)} if you want to override the existing values.
\n@param addReplicaRegions A list of Regions and KMS keys to replicate secrets.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.List(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
", + "documentation" : "A list of Regions and KMS keys to replicate secrets.
", "simpleType" : "List(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withClientRequestToken",
- "getterDocumentation" : "/**
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.*/",
+ "getterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.*/",
"getterMethodName" : "getClientRequestToken",
"getterModel" : {
"returnType" : "String",
@@ -2890,7 +2890,7 @@
"marshallingType" : "STRING",
"name" : "ClientRequestToken",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.*/",
+ "setterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.*/",
"setterMethodName" : "setClientRequestToken",
"setterModel" : {
"timestampFormat" : null,
@@ -2905,13 +2905,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "clientRequestToken",
"variableType" : "String",
- "documentation" : "
(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
(Optional) Specifies a user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies a user-provided description of the secret.
\n@param description (Optional) Specifies a user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withDescription", - "getterDocumentation" : "/**(Optional) Specifies a user-provided description of the secret.
\n@return (Optional) Specifies a user-provided description of the secret.*/", + "getterDocumentation" : "/**The description of the secret.
\n@return The description of the secret.*/", "getterMethodName" : "getDescription", "getterModel" : { "returnType" : "String", @@ -2960,7 +2960,7 @@ "marshallingType" : "STRING", "name" : "Description", "sensitive" : false, - "setterDocumentation" : "/**(Optional) Specifies a user-provided description of the secret.
\n@param description (Optional) Specifies a user-provided description of the secret.*/", + "setterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.*/", "setterMethodName" : "setDescription", "setterModel" : { "timestampFormat" : null, @@ -2975,13 +2975,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Specifies a user-provided description of the secret.
\n@param description (Optional) Specifies a user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "description", "variableType" : "String", - "documentation" : "(Optional) Specifies a user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -2991,12 +2991,12 @@ "c2jName" : "ForceOverwriteReplicaSecret", "c2jShape" : "BooleanType", "deprecated" : false, - "documentation" : "(Optional) If set, the replication overwrites a secret with the same name in the destination region.
", + "documentation" : "Specifies whether to overwrite a secret with the same name in the destination Region.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) If set, the replication overwrites a secret with the same name in the destination region.
\n@param forceOverwriteReplicaSecret (Optional) If set, the replication overwrites a secret with the same name in the destination region.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to overwrite a secret with the same name in the destination Region.
\n@param forceOverwriteReplicaSecret Specifies whether to overwrite a secret with the same name in the destination Region.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withForceOverwriteReplicaSecret", - "getterDocumentation" : "/**(Optional) If set, the replication overwrites a secret with the same name in the destination region.
\n@return (Optional) If set, the replication overwrites a secret with the same name in the destination region.*/", + "getterDocumentation" : "/**Specifies whether to overwrite a secret with the same name in the destination Region.
\n@return Specifies whether to overwrite a secret with the same name in the destination Region.*/", "getterMethodName" : "getForceOverwriteReplicaSecret", "getterModel" : { "returnType" : "Boolean", @@ -3030,7 +3030,7 @@ "marshallingType" : "BOOLEAN", "name" : "ForceOverwriteReplicaSecret", "sensitive" : false, - "setterDocumentation" : "/**(Optional) If set, the replication overwrites a secret with the same name in the destination region.
\n@param forceOverwriteReplicaSecret (Optional) If set, the replication overwrites a secret with the same name in the destination region.*/", + "setterDocumentation" : "/**Specifies whether to overwrite a secret with the same name in the destination Region.
\n@param forceOverwriteReplicaSecret Specifies whether to overwrite a secret with the same name in the destination Region.*/", "setterMethodName" : "setForceOverwriteReplicaSecret", "setterModel" : { "timestampFormat" : null, @@ -3045,13 +3045,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) If set, the replication overwrites a secret with the same name in the destination region.
\n@param forceOverwriteReplicaSecret (Optional) If set, the replication overwrites a secret with the same name in the destination region.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to overwrite a secret with the same name in the destination Region.
\n@param forceOverwriteReplicaSecret Specifies whether to overwrite a secret with the same name in the destination Region.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "forceOverwriteReplicaSecret", "variableType" : "Boolean", - "documentation" : "(Optional) If set, the replication overwrites a secret with the same name in the destination region.
", + "documentation" : "Specifies whether to overwrite a secret with the same name in the destination Region.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -3061,12 +3061,12 @@ "c2jName" : "KmsKeyId", "c2jShape" : "KmsKeyIdType", "deprecated" : false, - "documentation" : "(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret. You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withKmsKeyId",
- "getterDocumentation" : "/**
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret. You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
*/", + "getterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.*/",
"getterMethodName" : "getKmsKeyId",
"getterModel" : {
"returnType" : "String",
@@ -3100,7 +3100,7 @@
"marshallingType" : "STRING",
"name" : "KmsKeyId",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret. You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
*/", + "setterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.*/",
"setterMethodName" : "setKmsKeyId",
"setterModel" : {
"timestampFormat" : null,
@@ -3115,13 +3115,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
SecretString
or SecretBinary
values in the versions stored in this secret. You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "kmsKeyId",
"variableType" : "String",
- "documentation" : "
(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
\n@param name The name of the new secret.The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
*/", + "getterDocumentation" : "/**The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
\n@return The name of the new secret.The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -3170,7 +3170,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
*/", + "setterDocumentation" : "/**The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
\n@param name The name of the new secret.The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -3185,13 +3185,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
\n@param name The name of the new secret.The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -3201,12 +3201,12 @@ "c2jName" : "SecretBinary", "c2jShape" : "SecretBinaryType", "deprecated" : false, - "documentation" : "(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretBinary", - "getterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.*/", + "getterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.*/", "getterMethodName" : "getSecretBinary", "getterModel" : { "returnType" : "java.nio.ByteBuffer", @@ -3240,7 +3240,7 @@ "marshallingType" : "BYTE_BUFFER", "name" : "SecretBinary", "sensitive" : true, - "setterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.*/", + "setterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.*/", "setterMethodName" : "setSecretBinary", "setterModel" : { "timestampFormat" : null, @@ -3255,13 +3255,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.nio.ByteBuffer", "variableName" : "secretBinary", "variableType" : "java.nio.ByteBuffer", - "documentation" : "
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
", "simpleType" : "ByteBuffer", "variableSetterType" : "java.nio.ByteBuffer" }, @@ -3271,12 +3271,12 @@ "c2jName" : "SecretString", "c2jShape" : "SecretStringType", "deprecated" : false, - "documentation" : "(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withSecretString",
- "getterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.*/",
"getterMethodName" : "getSecretString",
"getterModel" : {
"returnType" : "String",
@@ -3310,7 +3310,7 @@
"marshallingType" : "STRING",
"name" : "SecretString",
"sensitive" : true,
- "setterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.*/",
"setterMethodName" : "setSecretString",
"setterModel" : {
"timestampFormat" : null,
@@ -3325,13 +3325,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "secretString",
"variableType" : "String",
- "documentation" : "
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
NOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
NOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
\n@param aRN The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "getterDocumentation" : "/**The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
\n@return The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -3574,7 +3574,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "setterDocumentation" : "/**The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
\n@param aRN The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -3589,13 +3589,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
\n@param aRN The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -3604,12 +3604,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that you just created.
", + "documentation" : "The name of the new secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that you just created.
\n@param name The friendly name of the secret that you just created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the new secret.
\n@param name The name of the new secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that you just created.
\n@return The friendly name of the secret that you just created.*/", + "getterDocumentation" : "/**The name of the new secret.
\n@return The name of the new secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -3643,7 +3643,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that you just created.
\n@param name The friendly name of the secret that you just created.*/", + "setterDocumentation" : "/**The name of the new secret.
\n@param name The name of the new secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -3658,13 +3658,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that you just created.
\n@param name The friendly name of the secret that you just created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the new secret.
\n@param name The name of the new secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that you just created.
", + "documentation" : "The name of the new secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -3673,12 +3673,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "The unique identifier associated with the version of the secret you just created.
", + "documentation" : "The unique identifier associated with the version of the new secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The unique identifier associated with the version of the secret you just created.
\n@param versionId The unique identifier associated with the version of the secret you just created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The unique identifier associated with the version of the new secret.
\n@param versionId The unique identifier associated with the version of the new secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersionId", - "getterDocumentation" : "/**The unique identifier associated with the version of the secret you just created.
\n@return The unique identifier associated with the version of the secret you just created.*/", + "getterDocumentation" : "/**The unique identifier associated with the version of the new secret.
\n@return The unique identifier associated with the version of the new secret.*/", "getterMethodName" : "getVersionId", "getterModel" : { "returnType" : "String", @@ -3712,7 +3712,7 @@ "marshallingType" : "STRING", "name" : "VersionId", "sensitive" : false, - "setterDocumentation" : "/**The unique identifier associated with the version of the secret you just created.
\n@param versionId The unique identifier associated with the version of the secret you just created.*/", + "setterDocumentation" : "/**The unique identifier associated with the version of the new secret.
\n@param versionId The unique identifier associated with the version of the new secret.*/", "setterMethodName" : "setVersionId", "setterModel" : { "timestampFormat" : null, @@ -3727,13 +3727,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The unique identifier associated with the version of the secret you just created.
\n@param versionId The unique identifier associated with the version of the secret you just created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The unique identifier associated with the version of the new secret.
\n@param versionId The unique identifier associated with the version of the new secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "versionId", "variableType" : "String", - "documentation" : "The unique identifier associated with the version of the secret you just created.
", + "documentation" : "The unique identifier associated with the version of the new secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -3742,12 +3742,12 @@ "c2jName" : "ReplicationStatus", "c2jShape" : "ReplicationStatusListType", "deprecated" : false, - "documentation" : "Describes a list of replication status objects as InProgress
, Failed
or InSync
.
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
InProgress
, Failed
or InSync
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
InProgress
, Failed
or InSync
.*/",
+ "getterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
InProgress
, Failed
or InSync
.*/",
+ "setterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values.
\n@param replicationStatus Describes a list of replication status objects asInProgress
, Failed
or InSync
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values.
\n@param replicationStatus A list of the replicas of this secret and their status: Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
\n@param aRN The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "getterDocumentation" : "/**The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
\n@return The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -3936,7 +3936,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "setterDocumentation" : "/**The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
\n@param aRN The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -3951,13 +3951,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
\n@param aRN The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -3967,12 +3967,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that you just created.
", + "documentation" : "The name of the new secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that you just created.
\n@param name The friendly name of the secret that you just created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the new secret.
\n@param name The name of the new secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that you just created.
\n@return The friendly name of the secret that you just created.*/", + "getterDocumentation" : "/**The name of the new secret.
\n@return The name of the new secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -4006,7 +4006,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that you just created.
\n@param name The friendly name of the secret that you just created.*/", + "setterDocumentation" : "/**The name of the new secret.
\n@param name The name of the new secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -4021,13 +4021,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that you just created.
\n@param name The friendly name of the secret that you just created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the new secret.
\n@param name The name of the new secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that you just created.
", + "documentation" : "The name of the new secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -4037,12 +4037,12 @@ "c2jName" : "ReplicationStatus", "c2jShape" : "ReplicationStatusListType", "deprecated" : false, - "documentation" : "Describes a list of replication status objects as InProgress
, Failed
or InSync
.
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
InProgress
, Failed
or InSync
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
InProgress
, Failed
or InSync
.*/",
+ "getterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
InProgress
, Failed
or InSync
.*/",
+ "setterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values.
\n@param replicationStatus Describes a list of replication status objects asInProgress
, Failed
or InSync
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values.
\n@param replicationStatus A list of the replicas of this secret and their status: Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
The unique identifier associated with the version of the secret you just created.
", + "documentation" : "The unique identifier associated with the version of the new secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The unique identifier associated with the version of the secret you just created.
\n@param versionId The unique identifier associated with the version of the secret you just created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The unique identifier associated with the version of the new secret.
\n@param versionId The unique identifier associated with the version of the new secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersionId", - "getterDocumentation" : "/**The unique identifier associated with the version of the secret you just created.
\n@return The unique identifier associated with the version of the secret you just created.*/", + "getterDocumentation" : "/**The unique identifier associated with the version of the new secret.
\n@return The unique identifier associated with the version of the new secret.*/", "getterMethodName" : "getVersionId", "getterModel" : { "returnType" : "String", @@ -4230,7 +4230,7 @@ "marshallingType" : "STRING", "name" : "VersionId", "sensitive" : false, - "setterDocumentation" : "/**The unique identifier associated with the version of the secret you just created.
\n@param versionId The unique identifier associated with the version of the secret you just created.*/", + "setterDocumentation" : "/**The unique identifier associated with the version of the new secret.
\n@param versionId The unique identifier associated with the version of the new secret.*/", "setterMethodName" : "setVersionId", "setterModel" : { "timestampFormat" : null, @@ -4245,13 +4245,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The unique identifier associated with the version of the secret you just created.
\n@param versionId The unique identifier associated with the version of the secret you just created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The unique identifier associated with the version of the new secret.
\n@param versionId The unique identifier associated with the version of the new secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "versionId", "variableType" : "String", - "documentation" : "The unique identifier associated with the version of the secret you just created.
", + "documentation" : "The unique identifier associated with the version of the new secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -4352,12 +4352,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to delete the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -4391,7 +4391,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -4406,13 +4406,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -4423,12 +4423,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to delete the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -4462,7 +4462,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -4477,13 +4477,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -4602,12 +4602,12 @@ "c2jName" : "Name", "c2jShape" : "NameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that the resource-based policy was deleted for.
", + "documentation" : "The name of the secret that the resource-based policy was deleted for.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that the resource-based policy was deleted for.
\n@param name The friendly name of the secret that the resource-based policy was deleted for.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that the resource-based policy was deleted for.
\n@param name The name of the secret that the resource-based policy was deleted for.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that the resource-based policy was deleted for.
\n@return The friendly name of the secret that the resource-based policy was deleted for.*/", + "getterDocumentation" : "/**The name of the secret that the resource-based policy was deleted for.
\n@return The name of the secret that the resource-based policy was deleted for.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -4641,7 +4641,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that the resource-based policy was deleted for.
\n@param name The friendly name of the secret that the resource-based policy was deleted for.*/", + "setterDocumentation" : "/**The name of the secret that the resource-based policy was deleted for.
\n@param name The name of the secret that the resource-based policy was deleted for.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -4656,13 +4656,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that the resource-based policy was deleted for.
\n@param name The friendly name of the secret that the resource-based policy was deleted for.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that the resource-based policy was deleted for.
\n@param name The name of the secret that the resource-based policy was deleted for.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that the resource-based policy was deleted for.
", + "documentation" : "The name of the secret that the resource-based policy was deleted for.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -4743,12 +4743,12 @@ "c2jName" : "Name", "c2jShape" : "NameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that the resource-based policy was deleted for.
", + "documentation" : "The name of the secret that the resource-based policy was deleted for.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that the resource-based policy was deleted for.
\n@param name The friendly name of the secret that the resource-based policy was deleted for.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that the resource-based policy was deleted for.
\n@param name The name of the secret that the resource-based policy was deleted for.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that the resource-based policy was deleted for.
\n@return The friendly name of the secret that the resource-based policy was deleted for.*/", + "getterDocumentation" : "/**The name of the secret that the resource-based policy was deleted for.
\n@return The name of the secret that the resource-based policy was deleted for.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -4782,7 +4782,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that the resource-based policy was deleted for.
\n@param name The friendly name of the secret that the resource-based policy was deleted for.*/", + "setterDocumentation" : "/**The name of the secret that the resource-based policy was deleted for.
\n@param name The name of the secret that the resource-based policy was deleted for.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -4797,13 +4797,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that the resource-based policy was deleted for.
\n@param name The friendly name of the secret that the resource-based policy was deleted for.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that the resource-based policy was deleted for.
\n@param name The name of the secret that the resource-based policy was deleted for.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that the resource-based policy was deleted for.
", + "documentation" : "The name of the secret that the resource-based policy was deleted for.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -4863,12 +4863,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to delete.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -4902,7 +4902,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -4917,13 +4917,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -4932,12 +4932,12 @@ "c2jName" : "RecoveryWindowInDays", "c2jShape" : "RecoveryWindowInDaysType", "deprecated" : false, - "documentation" : "(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
", + "documentation" : "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.
(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
\n@param recoveryWindowInDays (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and theForceDeleteWithoutRecovery
parameter in the same API call. This value can range from 7 to 30 days with a default value of 30.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
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.
ForceDeleteWithoutRecovery
in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withRecoveryWindowInDays",
- "getterDocumentation" : "/**(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
\n@return (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and theForceDeleteWithoutRecovery
parameter in the same API call. This value can range from 7 to 30 days with a default value of 30.*/", + "getterDocumentation" : "/**
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.
ForceDeleteWithoutRecovery
in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.*/",
"getterMethodName" : "getRecoveryWindowInDays",
"getterModel" : {
"returnType" : "Long",
@@ -4971,7 +4971,7 @@
"marshallingType" : "LONG",
"name" : "RecoveryWindowInDays",
"sensitive" : false,
- "setterDocumentation" : "/**(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
\n@param recoveryWindowInDays (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and theForceDeleteWithoutRecovery
parameter in the same API call. This value can range from 7 to 30 days with a default value of 30.*/", + "setterDocumentation" : "/**
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.
ForceDeleteWithoutRecovery
in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.*/",
"setterMethodName" : "setRecoveryWindowInDays",
"setterModel" : {
"timestampFormat" : null,
@@ -4986,13 +4986,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
\n@param recoveryWindowInDays (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and theForceDeleteWithoutRecovery
parameter in the same API call. This value can range from 7 to 30 days with a default value of 30.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
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.
ForceDeleteWithoutRecovery
in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "Long",
"variableName" : "recoveryWindowInDays",
"variableType" : "Long",
- "documentation" : "(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
", + "documentation" : "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.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
RecoveryWindowInDays
parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays
in the same call. If you don't use either, then Secrets Manager defaults to 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 is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
RecoveryWindowInDays
parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays
in the same call. If you don't use either, then Secrets Manager defaults to 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 is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
RecoveryWindowInDays
parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays
in the same call. If you don't use either, then Secrets Manager defaults to 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 is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
RecoveryWindowInDays
parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays
in the same call. If you don't use either, then Secrets Manager defaults to 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 is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
RecoveryWindowInDays
parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays
in the same call. If you don't use either, then Secrets Manager defaults to 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 is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
RecoveryWindowInDays
parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays
in the same call. If you don't use either, then Secrets Manager defaults to 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 is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
RecoveryWindowInDays
parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays
in the same call. If you don't use either, then Secrets Manager defaults to 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 is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
RecoveryWindowInDays
parameter in the same API call. An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
RecoveryWindowInDays
in the same call. If you don't use either, then Secrets Manager defaults to 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 is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
", + "documentation" : "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.
(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
\n@param recoveryWindowInDays (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and theForceDeleteWithoutRecovery
parameter in the same API call. This value can range from 7 to 30 days with a default value of 30.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
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.
ForceDeleteWithoutRecovery
in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withRecoveryWindowInDays",
- "getterDocumentation" : "/**(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
\n@return (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and theForceDeleteWithoutRecovery
parameter in the same API call. This value can range from 7 to 30 days with a default value of 30.*/", + "getterDocumentation" : "/**
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.
ForceDeleteWithoutRecovery
in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.*/",
"getterMethodName" : "getRecoveryWindowInDays",
"getterModel" : {
"returnType" : "Long",
@@ -5181,7 +5181,7 @@
"marshallingType" : "LONG",
"name" : "RecoveryWindowInDays",
"sensitive" : false,
- "setterDocumentation" : "/**(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
\n@param recoveryWindowInDays (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and theForceDeleteWithoutRecovery
parameter in the same API call. This value can range from 7 to 30 days with a default value of 30.*/", + "setterDocumentation" : "/**
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.
ForceDeleteWithoutRecovery
in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.*/",
"setterMethodName" : "setRecoveryWindowInDays",
"setterModel" : {
"timestampFormat" : null,
@@ -5196,13 +5196,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
\n@param recoveryWindowInDays (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and theForceDeleteWithoutRecovery
parameter in the same API call. This value can range from 7 to 30 days with a default value of 30.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
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.
ForceDeleteWithoutRecovery
in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "Long",
"variableName" : "recoveryWindowInDays",
"variableType" : "Long",
- "documentation" : "(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
", + "documentation" : "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.
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to delete.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -5251,7 +5251,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -5266,13 +5266,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to delete.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -5322,12 +5322,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "The ARN of the secret that is now scheduled for deletion.
", + "documentation" : "The ARN of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret that is now scheduled for deletion.
\n@param aRN The ARN of the secret that is now scheduled for deletion.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret that is now scheduled for deletion.
\n@return The ARN of the secret that is now scheduled for deletion.*/", + "getterDocumentation" : "/**The ARN of the secret.
\n@return The ARN of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -5361,7 +5361,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret that is now scheduled for deletion.
\n@param aRN The ARN of the secret that is now scheduled for deletion.*/", + "setterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -5376,13 +5376,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret that is now scheduled for deletion.
\n@param aRN The ARN of the secret that is now scheduled for deletion.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret that is now scheduled for deletion.
", + "documentation" : "The ARN of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -5391,12 +5391,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret currently scheduled for deletion.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret currently scheduled for deletion.
\n@param name The friendly name of the secret currently scheduled for deletion.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret currently scheduled for deletion.
\n@return The friendly name of the secret currently scheduled for deletion.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -5430,7 +5430,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret currently scheduled for deletion.
\n@param name The friendly name of the secret currently scheduled for deletion.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -5445,13 +5445,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret currently scheduled for deletion.
\n@param name The friendly name of the secret currently scheduled for deletion.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret currently scheduled for deletion.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -5460,12 +5460,12 @@ "c2jName" : "DeletionDate", "c2jShape" : "DeletionDateType", "deprecated" : false, - "documentation" : "The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
RecoveryWindowInDays
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
RecoveryWindowInDays
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withDeletionDate",
- "getterDocumentation" : "/**The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
RecoveryWindowInDays
.*/",
+ "getterDocumentation" : "/**The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
RecoveryWindowInDays
.*/",
"getterMethodName" : "getDeletionDate",
"getterModel" : {
"returnType" : "java.util.Date",
@@ -5499,7 +5499,7 @@
"marshallingType" : "DATE",
"name" : "DeletionDate",
"sensitive" : false,
- "setterDocumentation" : "/**The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
RecoveryWindowInDays
.*/",
+ "setterDocumentation" : "/**The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
RecoveryWindowInDays
.*/",
"setterMethodName" : "setDeletionDate",
"setterModel" : {
"timestampFormat" : null,
@@ -5514,13 +5514,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
RecoveryWindowInDays
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
RecoveryWindowInDays
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : "unixTimestamp",
"variableDeclarationType" : "java.util.Date",
"variableName" : "deletionDate",
"variableType" : "java.util.Date",
- "documentation" : "The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
The ARN of the secret that is now scheduled for deletion.
", + "documentation" : "The ARN of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret that is now scheduled for deletion.
\n@param aRN The ARN of the secret that is now scheduled for deletion.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret that is now scheduled for deletion.
\n@return The ARN of the secret that is now scheduled for deletion.*/", + "getterDocumentation" : "/**The ARN of the secret.
\n@return The ARN of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -5570,7 +5570,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret that is now scheduled for deletion.
\n@param aRN The ARN of the secret that is now scheduled for deletion.*/", + "setterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -5585,13 +5585,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret that is now scheduled for deletion.
\n@param aRN The ARN of the secret that is now scheduled for deletion.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret that is now scheduled for deletion.
", + "documentation" : "The ARN of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -5601,12 +5601,12 @@ "c2jName" : "DeletionDate", "c2jShape" : "DeletionDateType", "deprecated" : false, - "documentation" : "The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
RecoveryWindowInDays
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
RecoveryWindowInDays
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withDeletionDate",
- "getterDocumentation" : "/**The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
RecoveryWindowInDays
.*/",
+ "getterDocumentation" : "/**The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
RecoveryWindowInDays
.*/",
"getterMethodName" : "getDeletionDate",
"getterModel" : {
"returnType" : "java.util.Date",
@@ -5640,7 +5640,7 @@
"marshallingType" : "DATE",
"name" : "DeletionDate",
"sensitive" : false,
- "setterDocumentation" : "/**The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
RecoveryWindowInDays
.*/",
+ "setterDocumentation" : "/**The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
RecoveryWindowInDays
.*/",
"setterMethodName" : "setDeletionDate",
"setterModel" : {
"timestampFormat" : null,
@@ -5655,13 +5655,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
RecoveryWindowInDays
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
RecoveryWindowInDays
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : "unixTimestamp",
"variableDeclarationType" : "java.util.Date",
"variableName" : "deletionDate",
"variableType" : "java.util.Date",
- "documentation" : "The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
The friendly name of the secret currently scheduled for deletion.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret currently scheduled for deletion.
\n@param name The friendly name of the secret currently scheduled for deletion.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret currently scheduled for deletion.
\n@return The friendly name of the secret currently scheduled for deletion.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -5710,7 +5710,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret currently scheduled for deletion.
\n@param name The friendly name of the secret currently scheduled for deletion.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -5725,13 +5725,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret currently scheduled for deletion.
\n@param name The friendly name of the secret currently scheduled for deletion.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret currently scheduled for deletion.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -5791,12 +5791,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -5830,7 +5830,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -5845,13 +5845,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -5862,12 +5862,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -5901,7 +5901,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -5916,13 +5916,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -6041,12 +6041,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The user-provided friendly name of the secret.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The user-provided friendly name of the secret.
\n@param name The user-provided friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The user-provided friendly name of the secret.
\n@return The user-provided friendly name of the secret.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -6080,7 +6080,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The user-provided friendly name of the secret.
\n@param name The user-provided friendly name of the secret.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -6095,13 +6095,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The user-provided friendly name of the secret.
\n@param name The user-provided friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The user-provided friendly name of the secret.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -6110,12 +6110,12 @@ "c2jName" : "Description", "c2jShape" : "DescriptionType", "deprecated" : false, - "documentation" : "The user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The user-provided description of the secret.
\n@param description The user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withDescription", - "getterDocumentation" : "/**The user-provided description of the secret.
\n@return The user-provided description of the secret.*/", + "getterDocumentation" : "/**The description of the secret.
\n@return The description of the secret.*/", "getterMethodName" : "getDescription", "getterModel" : { "returnType" : "String", @@ -6149,7 +6149,7 @@ "marshallingType" : "STRING", "name" : "Description", "sensitive" : false, - "setterDocumentation" : "/**The user-provided description of the secret.
\n@param description The user-provided description of the secret.*/", + "setterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.*/", "setterMethodName" : "setDescription", "setterModel" : { "timestampFormat" : null, @@ -6164,13 +6164,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The user-provided description of the secret.
\n@param description The user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "description", "variableType" : "String", - "documentation" : "The user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -6179,12 +6179,12 @@ "c2jName" : "KmsKeyId", "c2jShape" : "KmsKeyIdType", "deprecated" : false, - "documentation" : "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withKmsKeyId",
- "getterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.*/",
+ "getterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.*/",
"getterMethodName" : "getKmsKeyId",
"getterModel" : {
"returnType" : "String",
@@ -6218,7 +6218,7 @@
"marshallingType" : "STRING",
"name" : "KmsKeyId",
"sensitive" : false,
- "setterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.*/",
+ "setterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.*/",
"setterMethodName" : "setKmsKeyId",
"setterModel" : {
"timestampFormat" : null,
@@ -6233,13 +6233,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "kmsKeyId",
"variableType" : "String",
- "documentation" : "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
\n@param rotationEnabled Specifies whether automatic rotation is turned on for this secret.To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRotationEnabled", - "getterDocumentation" : "/**
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.*/",
+ "getterDocumentation" : "/**
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
\n@return Specifies whether automatic rotation is turned on for this secret.To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.*/", "getterMethodName" : "getRotationEnabled", "getterModel" : { "returnType" : "Boolean", @@ -6287,7 +6287,7 @@ "marshallingType" : "BOOLEAN", "name" : "RotationEnabled", "sensitive" : false, - "setterDocumentation" : "/**
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.*/",
+ "setterDocumentation" : "/**
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
\n@param rotationEnabled Specifies whether automatic rotation is turned on for this secret.To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.*/", "setterMethodName" : "setRotationEnabled", "setterModel" : { "timestampFormat" : null, @@ -6302,13 +6302,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
\n@param rotationEnabled Specifies whether automatic rotation is turned on for this secret.To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "rotationEnabled", "variableType" : "Boolean", - "documentation" : "
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -6317,12 +6317,12 @@ "c2jName" : "RotationLambdaARN", "c2jShape" : "RotationLambdaARNType", "deprecated" : false, - "documentation" : "The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
RotateSecret
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRotationLambdaARN", - "getterDocumentation" : "/**The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
RotateSecret
.*/",
+ "getterDocumentation" : "/**The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
\n@return The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.*/", "getterMethodName" : "getRotationLambdaARN", "getterModel" : { "returnType" : "String", @@ -6356,7 +6356,7 @@ "marshallingType" : "STRING", "name" : "RotationLambdaARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
RotateSecret
.*/",
+ "setterDocumentation" : "/**The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.*/", "setterMethodName" : "setRotationLambdaARN", "setterModel" : { "timestampFormat" : null, @@ -6371,13 +6371,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
RotateSecret
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "rotationLambdaARN", "variableType" : "String", - "documentation" : "The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -6386,12 +6386,12 @@ "c2jName" : "RotationRules", "c2jShape" : "RotationRulesType", "deprecated" : false, - "documentation" : "A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
", + "documentation" : "The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
\n@param rotationRules A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
\n@param rotationRules The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRotationRules", - "getterDocumentation" : "/**A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
\n@return A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.*/", + "getterDocumentation" : "/**The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
\n@return The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.*/", "getterMethodName" : "getRotationRules", "getterModel" : { "returnType" : "RotationRulesType", @@ -6425,7 +6425,7 @@ "marshallingType" : "STRUCTURED", "name" : "RotationRules", "sensitive" : false, - "setterDocumentation" : "/**A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
\n@param rotationRules A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.*/", + "setterDocumentation" : "/**The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
\n@param rotationRules The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.*/", "setterMethodName" : "setRotationRules", "setterModel" : { "timestampFormat" : null, @@ -6440,13 +6440,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
\n@param rotationRules A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
\n@param rotationRules The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "RotationRulesType", "variableName" : "rotationRules", "variableType" : "RotationRulesType", - "documentation" : "A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
", + "documentation" : "The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
", "simpleType" : "RotationRulesType", "variableSetterType" : "RotationRulesType" }, @@ -6455,12 +6455,12 @@ "c2jName" : "LastRotatedDate", "c2jShape" : "LastRotatedDateType", "deprecated" : false, - "documentation" : "The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
", + "documentation" : "The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
\n@param lastRotatedDate The last date and time that the rotation process for this secret was invoked.The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
\n@param lastRotatedDate The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withLastRotatedDate", - "getterDocumentation" : "/**The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
\n@return The last date and time that the rotation process for this secret was invoked.The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.*/", + "getterDocumentation" : "/**
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
\n@return The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.*/", "getterMethodName" : "getLastRotatedDate", "getterModel" : { "returnType" : "java.util.Date", @@ -6494,7 +6494,7 @@ "marshallingType" : "DATE", "name" : "LastRotatedDate", "sensitive" : false, - "setterDocumentation" : "/**The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
\n@param lastRotatedDate The last date and time that the rotation process for this secret was invoked.The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.*/", + "setterDocumentation" : "/**
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
\n@param lastRotatedDate The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.*/", "setterMethodName" : "setLastRotatedDate", "setterModel" : { "timestampFormat" : null, @@ -6509,13 +6509,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
\n@param lastRotatedDate The last date and time that the rotation process for this secret was invoked.The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
\n@param lastRotatedDate The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : "unixTimestamp", "variableDeclarationType" : "java.util.Date", "variableName" : "lastRotatedDate", "variableType" : "java.util.Date", - "documentation" : "The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
", + "documentation" : "The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
", "simpleType" : "Date", "variableSetterType" : "java.util.Date" }, @@ -6593,12 +6593,12 @@ "c2jName" : "LastAccessedDate", "c2jShape" : "LastAccessedDateType", "deprecated" : false, - "documentation" : "The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
", + "documentation" : "The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
\n@param lastAccessedDate The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
\n@param lastAccessedDate The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withLastAccessedDate", - "getterDocumentation" : "/**The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
\n@return The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.*/", + "getterDocumentation" : "/**The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
\n@return The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.*/", "getterMethodName" : "getLastAccessedDate", "getterModel" : { "returnType" : "java.util.Date", @@ -6632,7 +6632,7 @@ "marshallingType" : "DATE", "name" : "LastAccessedDate", "sensitive" : false, - "setterDocumentation" : "/**The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
\n@param lastAccessedDate The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.*/", + "setterDocumentation" : "/**The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
\n@param lastAccessedDate The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.*/", "setterMethodName" : "setLastAccessedDate", "setterModel" : { "timestampFormat" : null, @@ -6647,13 +6647,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
\n@param lastAccessedDate The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
\n@param lastAccessedDate The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : "unixTimestamp", "variableDeclarationType" : "java.util.Date", "variableName" : "lastAccessedDate", "variableType" : "java.util.Date", - "documentation" : "The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
", + "documentation" : "The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
", "simpleType" : "Date", "variableSetterType" : "java.util.Date" }, @@ -6662,12 +6662,12 @@ "c2jName" : "DeletedDate", "c2jShape" : "DeletedDateType", "deprecated" : false, - "documentation" : "This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
", + "documentation" : "The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
\n@param deletedDate This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
\n@param deletedDate The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withDeletedDate", - "getterDocumentation" : "/**
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
\n@return This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.*/", + "getterDocumentation" : "/**
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
\n@return The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.*/", "getterMethodName" : "getDeletedDate", "getterModel" : { "returnType" : "java.util.Date", @@ -6701,7 +6701,7 @@ "marshallingType" : "DATE", "name" : "DeletedDate", "sensitive" : false, - "setterDocumentation" : "/**
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
\n@param deletedDate This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.*/", + "setterDocumentation" : "/**
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
\n@param deletedDate The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.*/", "setterMethodName" : "setDeletedDate", "setterModel" : { "timestampFormat" : null, @@ -6716,13 +6716,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
\n@param deletedDate This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
\n@param deletedDate The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : "unixTimestamp", "variableDeclarationType" : "java.util.Date", "variableName" : "deletedDate", "variableType" : "java.util.Date", - "documentation" : "
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
", + "documentation" : "The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
", "simpleType" : "Date", "variableSetterType" : "java.util.Date" }, @@ -6731,12 +6731,12 @@ "c2jName" : "Tags", "c2jShape" : "TagListType", "deprecated" : false, - "documentation" : "The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
", + "documentation" : "The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@param tags The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@param tags The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withTags", - "getterDocumentation" : "/**The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@return The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.*/", + "getterDocumentation" : "/**The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@return The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.*/", "getterMethodName" : "getTags", "getterModel" : { "returnType" : "java.util.ListThe list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@param tags The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.*/", + "setterDocumentation" : "/**The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@param tags The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.*/", "setterMethodName" : "setTags", "setterModel" : { "timestampFormat" : null, @@ -6869,13 +6869,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.ListThe list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
", + "documentation" : "The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
", "simpleType" : "ListA list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process. A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
\n@param versionIdsToStages A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersionIdsToStages", - "getterDocumentation" : "/**
A list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process. A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
*/", + "getterDocumentation" : "/**A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
\n@return A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.*/",
"getterMethodName" : "getVersionIdsToStages",
"getterModel" : {
"returnType" : "java.util.Map A list of all of the currently assigned A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
*/", + "setterDocumentation" : "/**A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
\n@param versionIdsToStages A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.*/", "setterMethodName" : "setVersionIdsToStages", "setterModel" : { "timestampFormat" : null, @@ -7106,13 +7106,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
A list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process. A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
\n@param versionIdsToStages A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.Map A list of all of the currently assigned A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list. A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them. Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are: During rotation, Secrets Manager creates an For more information about rotation and staging labels, see How rotation works. Returns the name of the service that created this secret. The name of the service that created this secret. Returns the name of the service that created this secret. The name of the service that created this secret. Returns the name of the service that created this secret. The name of the service that created this secret. Returns the name of the service that created this secret. The name of the service that created this secret. Returns the name of the service that created this secret. The name of the service that created this secret. Returns the name of the service that created this secret. The name of the service that created this secret. The date you created the secret. The date the secret was created. The date you created the secret. The date the secret was created. The date you created the secret. The date the secret was created. The date you created the secret. The date the secret was created. The date you created the secret. The date the secret was created. The date you created the secret. The date the secret was created. Specifies the primary region for secret replication. The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in Specifies the primary region for secret replication. The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in Specifies the primary region for secret replication. The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in Specifies the primary region for secret replication. The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in Specifies the primary region for secret replication. The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in Specifies the primary region for secret replication. The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in Describes a list of replication status objects as A list of the replicas of this secret and their status: Describes a list of replication status objects as A list of the replicas of this secret and their status: VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
AWSCURRENT
, which indicates the current version of the secret.AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.ReplicationStatus
. ReplicationStatus
. ReplicationStatus
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withPrimaryRegion",
- "getterDocumentation" : "/**ReplicationStatus
. ReplicationStatus
.*/",
"getterMethodName" : "getPrimaryRegion",
"getterModel" : {
"returnType" : "String",
@@ -7298,7 +7298,7 @@
"marshallingType" : "STRING",
"name" : "PrimaryRegion",
"sensitive" : false,
- "setterDocumentation" : "/**ReplicationStatus
. ReplicationStatus
.*/",
"setterMethodName" : "setPrimaryRegion",
"setterModel" : {
"timestampFormat" : null,
@@ -7313,13 +7313,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**ReplicationStatus
. ReplicationStatus
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "primaryRegion",
"variableType" : "String",
- "documentation" : "ReplicationStatus
. InProgress
, Failed
or InSync
.P
",
"endpointDiscoveryId" : false,
"enumType" : null,
- "fluentSetterDocumentation" : "/**Failed
, which indicates that the replica was not created.InProgress
, which indicates that Secrets Manager is in the process of creating the replica.InSync
, which indicates that the replica was created.InProgress
, Failed
or InSync
.P
InProgress
, Failed
or InSync
.P
\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
\n@param replicationStatus A list of the replicas of this secret and their status: Failed
, which indicates that the replica was not created.InProgress
, which indicates that Secrets Manager is in the process of creating the replica.InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
InProgress
, Failed
or InSync
.P
*/",
+ "getterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
InProgress
, Failed
or InSync
.P
*/",
+ "setterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values.
\n@param replicationStatus Describes a list of replication status objects asInProgress
, Failed
or InSync
.P
\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values.
\n@param replicationStatus A list of the replicas of this secret and their status: Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
The date you created the secret.
", + "documentation" : "The date the secret was created.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The date you created the secret.
\n@param createdDate The date you created the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The date the secret was created.
\n@param createdDate The date the secret was created.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withCreatedDate", - "getterDocumentation" : "/**The date you created the secret.
\n@return The date you created the secret.*/", + "getterDocumentation" : "/**The date the secret was created.
\n@return The date the secret was created.*/", "getterMethodName" : "getCreatedDate", "getterModel" : { "returnType" : "java.util.Date", @@ -7592,7 +7592,7 @@ "marshallingType" : "DATE", "name" : "CreatedDate", "sensitive" : false, - "setterDocumentation" : "/**The date you created the secret.
\n@param createdDate The date you created the secret.*/", + "setterDocumentation" : "/**The date the secret was created.
\n@param createdDate The date the secret was created.*/", "setterMethodName" : "setCreatedDate", "setterModel" : { "timestampFormat" : null, @@ -7607,13 +7607,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The date you created the secret.
\n@param createdDate The date you created the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The date the secret was created.
\n@param createdDate The date the secret was created.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : "unixTimestamp", "variableDeclarationType" : "java.util.Date", "variableName" : "createdDate", "variableType" : "java.util.Date", - "documentation" : "The date you created the secret.
", + "documentation" : "The date the secret was created.
", "simpleType" : "Date", "variableSetterType" : "java.util.Date" }, @@ -7623,12 +7623,12 @@ "c2jName" : "DeletedDate", "c2jShape" : "DeletedDateType", "deprecated" : false, - "documentation" : "This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
", + "documentation" : "The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
\n@param deletedDate This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
\n@param deletedDate The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withDeletedDate", - "getterDocumentation" : "/**
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
\n@return This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.*/", + "getterDocumentation" : "/**
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
\n@return The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.*/", "getterMethodName" : "getDeletedDate", "getterModel" : { "returnType" : "java.util.Date", @@ -7662,7 +7662,7 @@ "marshallingType" : "DATE", "name" : "DeletedDate", "sensitive" : false, - "setterDocumentation" : "/**
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
\n@param deletedDate This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.*/", + "setterDocumentation" : "/**
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
\n@param deletedDate The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.*/", "setterMethodName" : "setDeletedDate", "setterModel" : { "timestampFormat" : null, @@ -7677,13 +7677,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
\n@param deletedDate This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
\n@param deletedDate The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : "unixTimestamp", "variableDeclarationType" : "java.util.Date", "variableName" : "deletedDate", "variableType" : "java.util.Date", - "documentation" : "
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
", + "documentation" : "The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
", "simpleType" : "Date", "variableSetterType" : "java.util.Date" }, @@ -7693,12 +7693,12 @@ "c2jName" : "Description", "c2jShape" : "DescriptionType", "deprecated" : false, - "documentation" : "The user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The user-provided description of the secret.
\n@param description The user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withDescription", - "getterDocumentation" : "/**The user-provided description of the secret.
\n@return The user-provided description of the secret.*/", + "getterDocumentation" : "/**The description of the secret.
\n@return The description of the secret.*/", "getterMethodName" : "getDescription", "getterModel" : { "returnType" : "String", @@ -7732,7 +7732,7 @@ "marshallingType" : "STRING", "name" : "Description", "sensitive" : false, - "setterDocumentation" : "/**The user-provided description of the secret.
\n@param description The user-provided description of the secret.*/", + "setterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.*/", "setterMethodName" : "setDescription", "setterModel" : { "timestampFormat" : null, @@ -7747,13 +7747,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The user-provided description of the secret.
\n@param description The user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "description", "variableType" : "String", - "documentation" : "The user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -7763,12 +7763,12 @@ "c2jName" : "KmsKeyId", "c2jShape" : "KmsKeyIdType", "deprecated" : false, - "documentation" : "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withKmsKeyId",
- "getterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.*/",
+ "getterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.*/",
"getterMethodName" : "getKmsKeyId",
"getterModel" : {
"returnType" : "String",
@@ -7802,7 +7802,7 @@
"marshallingType" : "STRING",
"name" : "KmsKeyId",
"sensitive" : false,
- "setterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.*/",
+ "setterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.*/",
"setterMethodName" : "setKmsKeyId",
"setterModel" : {
"timestampFormat" : null,
@@ -7817,13 +7817,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "kmsKeyId",
"variableType" : "String",
- "documentation" : "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
", + "documentation" : "The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
\n@param lastAccessedDate The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
\n@param lastAccessedDate The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withLastAccessedDate", - "getterDocumentation" : "/**The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
\n@return The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.*/", + "getterDocumentation" : "/**The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
\n@return The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.*/", "getterMethodName" : "getLastAccessedDate", "getterModel" : { "returnType" : "java.util.Date", @@ -7872,7 +7872,7 @@ "marshallingType" : "DATE", "name" : "LastAccessedDate", "sensitive" : false, - "setterDocumentation" : "/**The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
\n@param lastAccessedDate The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.*/", + "setterDocumentation" : "/**The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
\n@param lastAccessedDate The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.*/", "setterMethodName" : "setLastAccessedDate", "setterModel" : { "timestampFormat" : null, @@ -7887,13 +7887,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
\n@param lastAccessedDate The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
\n@param lastAccessedDate The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : "unixTimestamp", "variableDeclarationType" : "java.util.Date", "variableName" : "lastAccessedDate", "variableType" : "java.util.Date", - "documentation" : "The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
", + "documentation" : "The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
", "simpleType" : "Date", "variableSetterType" : "java.util.Date" }, @@ -7973,12 +7973,12 @@ "c2jName" : "LastRotatedDate", "c2jShape" : "LastRotatedDateType", "deprecated" : false, - "documentation" : "The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
", + "documentation" : "The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
\n@param lastRotatedDate The last date and time that the rotation process for this secret was invoked.The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
\n@param lastRotatedDate The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withLastRotatedDate", - "getterDocumentation" : "/**The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
\n@return The last date and time that the rotation process for this secret was invoked.The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.*/", + "getterDocumentation" : "/**
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
\n@return The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.*/", "getterMethodName" : "getLastRotatedDate", "getterModel" : { "returnType" : "java.util.Date", @@ -8012,7 +8012,7 @@ "marshallingType" : "DATE", "name" : "LastRotatedDate", "sensitive" : false, - "setterDocumentation" : "/**The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
\n@param lastRotatedDate The last date and time that the rotation process for this secret was invoked.The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.*/", + "setterDocumentation" : "/**
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
\n@param lastRotatedDate The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.*/", "setterMethodName" : "setLastRotatedDate", "setterModel" : { "timestampFormat" : null, @@ -8027,13 +8027,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
\n@param lastRotatedDate The last date and time that the rotation process for this secret was invoked.The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
\n@param lastRotatedDate The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : "unixTimestamp", "variableDeclarationType" : "java.util.Date", "variableName" : "lastRotatedDate", "variableType" : "java.util.Date", - "documentation" : "The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
", + "documentation" : "The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
", "simpleType" : "Date", "variableSetterType" : "java.util.Date" }, @@ -8043,12 +8043,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The user-provided friendly name of the secret.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The user-provided friendly name of the secret.
\n@param name The user-provided friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The user-provided friendly name of the secret.
\n@return The user-provided friendly name of the secret.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -8082,7 +8082,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The user-provided friendly name of the secret.
\n@param name The user-provided friendly name of the secret.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -8097,13 +8097,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The user-provided friendly name of the secret.
\n@param name The user-provided friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The user-provided friendly name of the secret.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -8113,12 +8113,12 @@ "c2jName" : "OwningService", "c2jShape" : "OwningServiceType", "deprecated" : false, - "documentation" : "Returns the name of the service that created this secret.
", + "documentation" : "The name of the service that created this secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Returns the name of the service that created this secret.
\n@param owningService Returns the name of the service that created this secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the service that created this secret.
\n@param owningService The name of the service that created this secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withOwningService", - "getterDocumentation" : "/**Returns the name of the service that created this secret.
\n@return Returns the name of the service that created this secret.*/", + "getterDocumentation" : "/**The name of the service that created this secret.
\n@return The name of the service that created this secret.*/", "getterMethodName" : "getOwningService", "getterModel" : { "returnType" : "String", @@ -8152,7 +8152,7 @@ "marshallingType" : "STRING", "name" : "OwningService", "sensitive" : false, - "setterDocumentation" : "/**Returns the name of the service that created this secret.
\n@param owningService Returns the name of the service that created this secret.*/", + "setterDocumentation" : "/**The name of the service that created this secret.
\n@param owningService The name of the service that created this secret.*/", "setterMethodName" : "setOwningService", "setterModel" : { "timestampFormat" : null, @@ -8167,13 +8167,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Returns the name of the service that created this secret.
\n@param owningService Returns the name of the service that created this secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the service that created this secret.
\n@param owningService The name of the service that created this secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "owningService", "variableType" : "String", - "documentation" : "Returns the name of the service that created this secret.
", + "documentation" : "The name of the service that created this secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -8183,12 +8183,12 @@ "c2jName" : "PrimaryRegion", "c2jShape" : "RegionType", "deprecated" : false, - "documentation" : "Specifies the primary region for secret replication.
", + "documentation" : "The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus
.
Specifies the primary region for secret replication.
\n@param primaryRegion Specifies the primary region for secret replication.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus
.
ReplicationStatus
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withPrimaryRegion",
- "getterDocumentation" : "/**Specifies the primary region for secret replication.
\n@return Specifies the primary region for secret replication.*/", + "getterDocumentation" : "/**The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus
.
ReplicationStatus
.*/",
"getterMethodName" : "getPrimaryRegion",
"getterModel" : {
"returnType" : "String",
@@ -8222,7 +8222,7 @@
"marshallingType" : "STRING",
"name" : "PrimaryRegion",
"sensitive" : false,
- "setterDocumentation" : "/**Specifies the primary region for secret replication.
\n@param primaryRegion Specifies the primary region for secret replication.*/", + "setterDocumentation" : "/**The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus
.
ReplicationStatus
.*/",
"setterMethodName" : "setPrimaryRegion",
"setterModel" : {
"timestampFormat" : null,
@@ -8237,13 +8237,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**Specifies the primary region for secret replication.
\n@param primaryRegion Specifies the primary region for secret replication.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus
.
ReplicationStatus
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "primaryRegion",
"variableType" : "String",
- "documentation" : "Specifies the primary region for secret replication.
", + "documentation" : "The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus
.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
InProgress
, Failed
or InSync
.P
\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
InProgress
, Failed
or InSync
.P
*/",
+ "getterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
InProgress
, Failed
or InSync
.P
*/",
+ "setterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values.
\n@param replicationStatus Describes a list of replication status objects asInProgress
, Failed
or InSync
.P
\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values.
\n@param replicationStatus A list of the replicas of this secret and their status: Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
\n@param rotationEnabled Specifies whether automatic rotation is turned on for this secret.To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRotationEnabled", - "getterDocumentation" : "/**
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.*/",
+ "getterDocumentation" : "/**
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
\n@return Specifies whether automatic rotation is turned on for this secret.To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.*/", "getterMethodName" : "getRotationEnabled", "getterModel" : { "returnType" : "Boolean", @@ -8446,7 +8446,7 @@ "marshallingType" : "BOOLEAN", "name" : "RotationEnabled", "sensitive" : false, - "setterDocumentation" : "/**
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.*/",
+ "setterDocumentation" : "/**
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
\n@param rotationEnabled Specifies whether automatic rotation is turned on for this secret.To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.*/", "setterMethodName" : "setRotationEnabled", "setterModel" : { "timestampFormat" : null, @@ -8461,13 +8461,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
\n@param rotationEnabled Specifies whether automatic rotation is turned on for this secret.To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "rotationEnabled", "variableType" : "Boolean", - "documentation" : "
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -8477,12 +8477,12 @@ "c2jName" : "RotationLambdaARN", "c2jShape" : "RotationLambdaARNType", "deprecated" : false, - "documentation" : "The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
RotateSecret
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRotationLambdaARN", - "getterDocumentation" : "/**The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
RotateSecret
.*/",
+ "getterDocumentation" : "/**The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
\n@return The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.*/", "getterMethodName" : "getRotationLambdaARN", "getterModel" : { "returnType" : "String", @@ -8516,7 +8516,7 @@ "marshallingType" : "STRING", "name" : "RotationLambdaARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
RotateSecret
.*/",
+ "setterDocumentation" : "/**The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.*/", "setterMethodName" : "setRotationLambdaARN", "setterModel" : { "timestampFormat" : null, @@ -8531,13 +8531,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
RotateSecret
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "rotationLambdaARN", "variableType" : "String", - "documentation" : "The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -8547,12 +8547,12 @@ "c2jName" : "RotationRules", "c2jShape" : "RotationRulesType", "deprecated" : false, - "documentation" : "A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
", + "documentation" : "The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
\n@param rotationRules A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
\n@param rotationRules The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRotationRules", - "getterDocumentation" : "/**A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
\n@return A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.*/", + "getterDocumentation" : "/**The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
\n@return The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.*/", "getterMethodName" : "getRotationRules", "getterModel" : { "returnType" : "RotationRulesType", @@ -8586,7 +8586,7 @@ "marshallingType" : "STRUCTURED", "name" : "RotationRules", "sensitive" : false, - "setterDocumentation" : "/**A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
\n@param rotationRules A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.*/", + "setterDocumentation" : "/**The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
\n@param rotationRules The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.*/", "setterMethodName" : "setRotationRules", "setterModel" : { "timestampFormat" : null, @@ -8601,13 +8601,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
\n@param rotationRules A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
\n@param rotationRules The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "RotationRulesType", "variableName" : "rotationRules", "variableType" : "RotationRulesType", - "documentation" : "A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
", + "documentation" : "The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
", "simpleType" : "RotationRulesType", "variableSetterType" : "RotationRulesType" }, @@ -8617,12 +8617,12 @@ "c2jName" : "Tags", "c2jShape" : "TagListType", "deprecated" : false, - "documentation" : "The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
", + "documentation" : "The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@param tags The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@param tags The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withTags", - "getterDocumentation" : "/**The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@return The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.*/", + "getterDocumentation" : "/**The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@return The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.*/", "getterMethodName" : "getTags", "getterModel" : { "returnType" : "java.util.ListThe list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@param tags The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.*/", + "setterDocumentation" : "/**The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\n@param tags The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.*/", "setterMethodName" : "setTags", "setterModel" : { "timestampFormat" : null, @@ -8755,13 +8755,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.ListThe list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
", + "documentation" : "The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
", "simpleType" : "ListA list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process. A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
\n@param versionIdsToStages A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersionIdsToStages", - "getterDocumentation" : "/**
A list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process. A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
*/", + "getterDocumentation" : "/**A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
\n@return A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.*/",
"getterMethodName" : "getVersionIdsToStages",
"getterModel" : {
"returnType" : "java.util.Map A list of all of the currently assigned A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
*/", + "setterDocumentation" : "/**A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
\n@param versionIdsToStages A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.*/", "setterMethodName" : "setVersionIdsToStages", "setterModel" : { "timestampFormat" : null, @@ -8993,13 +8993,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
A list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process. A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
\n@param versionIdsToStages A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.Map A list of all of the currently assigned A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list. A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them. Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are: During rotation, Secrets Manager creates an For more information about rotation and staging labels, see How rotation works. Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key. Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key. Allows you to add filters when you use the search function in Secrets Manager. Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager. Filters your list of secrets by a specific key. The following are keys you can use: description: Prefix match, not case-sensitive. name: Prefix match, case-sensitive. tag-key: Prefix match, case-sensitive. tag-value: Prefix match, case-sensitive. primary-region: Prefix match, case-sensitive. all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive. Filters your list of secrets by a specific key. The following are keys you can use: description: Prefix match, not case-sensitive. name: Prefix match, case-sensitive. tag-key: Prefix match, case-sensitive. tag-value: Prefix match, case-sensitive. primary-region: Prefix match, case-sensitive. all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
AWSCURRENT
, which indicates the current version of the secret.AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
",
"endpointDiscoveryId" : false,
"enumType" : "FilterNameStringType",
- "fluentSetterDocumentation" : "/**
\n@param key The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific key.
\n@return Filters your list of secrets by a specific key.\n@see FilterNameStringType*/", + "getterDocumentation" : "/**The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific key.
\n@param key Filters your list of secrets by a specific key.\n@see FilterNameStringType*/", + "setterDocumentation" : "/**The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific key.
\n@param key Filters your list of secrets by a specific key.\n@return Returns a reference to this object so that method calls can be chained together.\n@see FilterNameStringType*/", + "varargSetterDocumentation" : "/**The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific key.
", + "documentation" : "The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withValues",
- "getterDocumentation" : "/**
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.*/",
+ "getterDocumentation" : "/**
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark ( Filters your list of secrets by a specific value. You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.*/",
"getterMethodName" : "getValues",
"getterModel" : {
"returnType" : "java.util.List!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.*/",
+ "setterDocumentation" : "/**
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.*/",
"setterMethodName" : "setValues",
"setterModel" : {
"timestampFormat" : null,
@@ -9300,13 +9300,13 @@
"shouldFullyQualify" : false,
"simple" : false,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
NOTE: This method appends the values to the existing list (if any). Use {@link #setValues(java.util.Collection)} or {@link #withValues(java.util.Collection)} if you want to override the existing values.
\n@param values Filters your list of secrets by a specific value.You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
NOTE: This method appends the values to the existing list (if any). Use {@link #setValues(java.util.Collection)} or {@link #withValues(java.util.Collection)} if you want to override the existing values.
\n@param values The keyword to filter for.You can prefix your search value with an exclamation mark ( Filters your list of secrets by a specific value. You can prefix your search value with an exclamation mark ( The keyword to filter for. You can prefix your search value with an exclamation mark ( Filters your list of secrets by a specific key. The following are keys you can use: description: Prefix match, not case-sensitive. name: Prefix match, case-sensitive. tag-key: Prefix match, case-sensitive. tag-value: Prefix match, case-sensitive. primary-region: Prefix match, case-sensitive. all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive. Filters your list of secrets by a specific key. The following are keys you can use: description: Prefix match, not case-sensitive. name: Prefix match, case-sensitive. tag-key: Prefix match, case-sensitive. tag-value: Prefix match, case-sensitive. primary-region: Prefix match, case-sensitive. all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.!
) in order to perform negation filters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.List!
) in order to perform negation filters. !
) in order to perform negation filters.
",
"endpointDiscoveryId" : false,
"enumType" : "FilterNameStringType",
- "fluentSetterDocumentation" : "/**
\n@param key The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific key.
\n@return Filters your list of secrets by a specific key.\n@see FilterNameStringType*/", + "getterDocumentation" : "/**The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific key.
\n@param key Filters your list of secrets by a specific key.\n@see FilterNameStringType*/", + "setterDocumentation" : "/**The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific key.
\n@param key Filters your list of secrets by a specific key.\n@return Returns a reference to this object so that method calls can be chained together.\n@see FilterNameStringType*/", + "varargSetterDocumentation" : "/**The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific key.
", + "documentation" : "The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withValues",
- "getterDocumentation" : "/**
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.*/",
+ "getterDocumentation" : "/**
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark ( Filters your list of secrets by a specific value. You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.*/",
"getterMethodName" : "getValues",
"getterModel" : {
"returnType" : "java.util.List!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.*/",
+ "setterDocumentation" : "/**
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.*/",
"setterMethodName" : "setValues",
"setterModel" : {
"timestampFormat" : null,
@@ -9525,13 +9525,13 @@
"shouldFullyQualify" : false,
"simple" : false,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
NOTE: This method appends the values to the existing list (if any). Use {@link #setValues(java.util.Collection)} or {@link #withValues(java.util.Collection)} if you want to override the existing values.
\n@param values Filters your list of secrets by a specific value.You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
NOTE: This method appends the values to the existing list (if any). Use {@link #setValues(java.util.Collection)} or {@link #withValues(java.util.Collection)} if you want to override the existing values.
\n@param values The keyword to filter for.You can prefix your search value with an exclamation mark ( Filters your list of secrets by a specific value. You can prefix your search value with an exclamation mark ( The keyword to filter for. You can prefix your search value with an exclamation mark ( The desired length of the generated password. The default value if you do not include this parameter is 32 characters. The length of the password. If you don't include this parameter, the default length is 32 characters. The desired length of the generated password. The default value if you do not include this parameter is 32 characters. The length of the password. If you don't include this parameter, the default length is 32 characters. The desired length of the generated password. The default value if you do not include this parameter is 32 characters. The length of the password. If you don't include this parameter, the default length is 32 characters. The desired length of the generated password. The default value if you do not include this parameter is 32 characters. The length of the password. If you don't include this parameter, the default length is 32 characters. The desired length of the generated password. The default value if you do not include this parameter is 32 characters. The length of the password. If you don't include this parameter, the default length is 32 characters. The desired length of the generated password. The default value if you do not include this parameter is 32 characters. The length of the password. If you don't include this parameter, the default length is 32 characters. A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. A string of the characters that you don't want in the password. A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. A string of the characters that you don't want in the password. A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. A string of the characters that you don't want in the password. A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. A string of the characters that you don't want in the password. A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. A string of the characters that you don't want in the password. A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used. A string of the characters that you don't want in the password. Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included. Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included. Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included. Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included. Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included. Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included. Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included. The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with Specifies whether to exclude the following punctuation characters from the password: Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included. The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with !
) in order to perform negation filters.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.List!
) in order to perform negation filters. !
) in order to perform negation filters. ExcludeCharacters
or ExcludePunctuation
:! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.ExcludeCharacters
or ExcludePunctuation
:! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withExcludePunctuation",
- "getterDocumentation" : "/**Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
*/",
+ "getterDocumentation" : "/**
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.*/",
"getterMethodName" : "getExcludePunctuation",
"getterModel" : {
"returnType" : "Boolean",
@@ -9899,7 +9899,7 @@
"marshallingType" : "BOOLEAN",
"name" : "ExcludePunctuation",
"sensitive" : false,
- "setterDocumentation" : "/**Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
*/",
+ "setterDocumentation" : "/**
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.*/",
"setterMethodName" : "setExcludePunctuation",
"setterModel" : {
"timestampFormat" : null,
@@ -9914,13 +9914,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "Boolean",
"variableName" : "excludePunctuation",
"variableType" : "Boolean",
- "documentation" : "Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
", + "documentation" : "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
\n@param excludeUppercase Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
\n@param excludeUppercase Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withExcludeUppercase", - "getterDocumentation" : "/**Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
\n@return Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.*/", + "getterDocumentation" : "/**Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
\n@return Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.*/", "getterMethodName" : "getExcludeUppercase", "getterModel" : { "returnType" : "Boolean", @@ -9968,7 +9968,7 @@ "marshallingType" : "BOOLEAN", "name" : "ExcludeUppercase", "sensitive" : false, - "setterDocumentation" : "/**Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
\n@param excludeUppercase Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.*/", + "setterDocumentation" : "/**Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
\n@param excludeUppercase Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.*/", "setterMethodName" : "setExcludeUppercase", "setterModel" : { "timestampFormat" : null, @@ -9983,13 +9983,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
\n@param excludeUppercase Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
\n@param excludeUppercase Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "excludeUppercase", "variableType" : "Boolean", - "documentation" : "Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
", + "documentation" : "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -9998,12 +9998,12 @@ "c2jName" : "ExcludeLowercase", "c2jShape" : "ExcludeLowercaseType", "deprecated" : false, - "documentation" : "Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
", + "documentation" : "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
\n@param excludeLowercase Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
\n@param excludeLowercase Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withExcludeLowercase", - "getterDocumentation" : "/**Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
\n@return Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.*/", + "getterDocumentation" : "/**Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
\n@return Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.*/", "getterMethodName" : "getExcludeLowercase", "getterModel" : { "returnType" : "Boolean", @@ -10037,7 +10037,7 @@ "marshallingType" : "BOOLEAN", "name" : "ExcludeLowercase", "sensitive" : false, - "setterDocumentation" : "/**Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
\n@param excludeLowercase Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.*/", + "setterDocumentation" : "/**Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
\n@param excludeLowercase Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.*/", "setterMethodName" : "setExcludeLowercase", "setterModel" : { "timestampFormat" : null, @@ -10052,13 +10052,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
\n@param excludeLowercase Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
\n@param excludeLowercase Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "excludeLowercase", "variableType" : "Boolean", - "documentation" : "Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
", + "documentation" : "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -10067,12 +10067,12 @@ "c2jName" : "IncludeSpace", "c2jShape" : "IncludeSpaceType", "deprecated" : false, - "documentation" : "Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
", + "documentation" : "Specifies whether to include the space character. If you include this switch, the password can contain space characters.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
\n@param includeSpace Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to include the space character. If you include this switch, the password can contain space characters.
\n@param includeSpace Specifies whether to include the space character. If you include this switch, the password can contain space characters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withIncludeSpace", - "getterDocumentation" : "/**Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
\n@return Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.*/", + "getterDocumentation" : "/**Specifies whether to include the space character. If you include this switch, the password can contain space characters.
\n@return Specifies whether to include the space character. If you include this switch, the password can contain space characters.*/", "getterMethodName" : "getIncludeSpace", "getterModel" : { "returnType" : "Boolean", @@ -10106,7 +10106,7 @@ "marshallingType" : "BOOLEAN", "name" : "IncludeSpace", "sensitive" : false, - "setterDocumentation" : "/**Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
\n@param includeSpace Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.*/", + "setterDocumentation" : "/**Specifies whether to include the space character. If you include this switch, the password can contain space characters.
\n@param includeSpace Specifies whether to include the space character. If you include this switch, the password can contain space characters.*/", "setterMethodName" : "setIncludeSpace", "setterModel" : { "timestampFormat" : null, @@ -10121,13 +10121,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
\n@param includeSpace Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to include the space character. If you include this switch, the password can contain space characters.
\n@param includeSpace Specifies whether to include the space character. If you include this switch, the password can contain space characters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "includeSpace", "variableType" : "Boolean", - "documentation" : "Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
", + "documentation" : "Specifies whether to include the space character. If you include this switch, the password can contain space characters.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -10136,12 +10136,12 @@ "c2jName" : "RequireEachIncludedType", "c2jShape" : "RequireEachIncludedTypeType", "deprecated" : false, - "documentation" : "A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
True
and the operation requires at least one of every character type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
\n@param requireEachIncludedType Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRequireEachIncludedType", - "getterDocumentation" : "/**A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
True
and the operation requires at least one of every character type.*/",
+ "getterDocumentation" : "/**Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
\n@return Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.*/", "getterMethodName" : "getRequireEachIncludedType", "getterModel" : { "returnType" : "Boolean", @@ -10175,7 +10175,7 @@ "marshallingType" : "BOOLEAN", "name" : "RequireEachIncludedType", "sensitive" : false, - "setterDocumentation" : "/**A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
True
and the operation requires at least one of every character type.*/",
+ "setterDocumentation" : "/**Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
\n@param requireEachIncludedType Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.*/", "setterMethodName" : "setRequireEachIncludedType", "setterModel" : { "timestampFormat" : null, @@ -10190,13 +10190,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
True
and the operation requires at least one of every character type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
\n@param requireEachIncludedType Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "requireEachIncludedType", "variableType" : "Boolean", - "documentation" : "A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -10207,12 +10207,12 @@ "c2jName" : "ExcludeCharacters", "c2jShape" : "ExcludeCharactersType", "deprecated" : false, - "documentation" : "A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
", + "documentation" : "A string of the characters that you don't want in the password.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
\n@param excludeCharacters A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A string of the characters that you don't want in the password.
\n@param excludeCharacters A string of the characters that you don't want in the password.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withExcludeCharacters", - "getterDocumentation" : "/**A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
\n@return A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.*/", + "getterDocumentation" : "/**A string of the characters that you don't want in the password.
\n@return A string of the characters that you don't want in the password.*/", "getterMethodName" : "getExcludeCharacters", "getterModel" : { "returnType" : "String", @@ -10246,7 +10246,7 @@ "marshallingType" : "STRING", "name" : "ExcludeCharacters", "sensitive" : false, - "setterDocumentation" : "/**A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
\n@param excludeCharacters A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.*/", + "setterDocumentation" : "/**A string of the characters that you don't want in the password.
\n@param excludeCharacters A string of the characters that you don't want in the password.*/", "setterMethodName" : "setExcludeCharacters", "setterModel" : { "timestampFormat" : null, @@ -10261,13 +10261,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
\n@param excludeCharacters A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A string of the characters that you don't want in the password.
\n@param excludeCharacters A string of the characters that you don't want in the password.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "excludeCharacters", "variableType" : "String", - "documentation" : "A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
", + "documentation" : "A string of the characters that you don't want in the password.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -10277,12 +10277,12 @@ "c2jName" : "ExcludeLowercase", "c2jShape" : "ExcludeLowercaseType", "deprecated" : false, - "documentation" : "Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
", + "documentation" : "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
\n@param excludeLowercase Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
\n@param excludeLowercase Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withExcludeLowercase", - "getterDocumentation" : "/**Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
\n@return Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.*/", + "getterDocumentation" : "/**Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
\n@return Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.*/", "getterMethodName" : "getExcludeLowercase", "getterModel" : { "returnType" : "Boolean", @@ -10316,7 +10316,7 @@ "marshallingType" : "BOOLEAN", "name" : "ExcludeLowercase", "sensitive" : false, - "setterDocumentation" : "/**Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
\n@param excludeLowercase Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.*/", + "setterDocumentation" : "/**Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
\n@param excludeLowercase Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.*/", "setterMethodName" : "setExcludeLowercase", "setterModel" : { "timestampFormat" : null, @@ -10331,13 +10331,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
\n@param excludeLowercase Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
\n@param excludeLowercase Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "excludeLowercase", "variableType" : "Boolean", - "documentation" : "Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
", + "documentation" : "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -10347,12 +10347,12 @@ "c2jName" : "ExcludeNumbers", "c2jShape" : "ExcludeNumbersType", "deprecated" : false, - "documentation" : "Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
", + "documentation" : "Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
\n@param excludeNumbers Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
\n@param excludeNumbers Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withExcludeNumbers", - "getterDocumentation" : "/**Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
\n@return Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.*/", + "getterDocumentation" : "/**Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
\n@return Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.*/", "getterMethodName" : "getExcludeNumbers", "getterModel" : { "returnType" : "Boolean", @@ -10386,7 +10386,7 @@ "marshallingType" : "BOOLEAN", "name" : "ExcludeNumbers", "sensitive" : false, - "setterDocumentation" : "/**Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
\n@param excludeNumbers Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.*/", + "setterDocumentation" : "/**Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
\n@param excludeNumbers Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.*/", "setterMethodName" : "setExcludeNumbers", "setterModel" : { "timestampFormat" : null, @@ -10401,13 +10401,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
\n@param excludeNumbers Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
\n@param excludeNumbers Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "excludeNumbers", "variableType" : "Boolean", - "documentation" : "Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
", + "documentation" : "Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -10417,12 +10417,12 @@ "c2jName" : "ExcludePunctuation", "c2jShape" : "ExcludePunctuationType", "deprecated" : false, - "documentation" : "Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withExcludePunctuation",
- "getterDocumentation" : "/**Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
*/",
+ "getterDocumentation" : "/**
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.*/",
"getterMethodName" : "getExcludePunctuation",
"getterModel" : {
"returnType" : "Boolean",
@@ -10456,7 +10456,7 @@
"marshallingType" : "BOOLEAN",
"name" : "ExcludePunctuation",
"sensitive" : false,
- "setterDocumentation" : "/**Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
*/",
+ "setterDocumentation" : "/**
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.*/",
"setterMethodName" : "setExcludePunctuation",
"setterModel" : {
"timestampFormat" : null,
@@ -10471,13 +10471,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "Boolean",
"variableName" : "excludePunctuation",
"variableType" : "Boolean",
- "documentation" : "Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
", + "documentation" : "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
\n@param excludeUppercase Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
\n@param excludeUppercase Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withExcludeUppercase", - "getterDocumentation" : "/**Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
\n@return Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.*/", + "getterDocumentation" : "/**Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
\n@return Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.*/", "getterMethodName" : "getExcludeUppercase", "getterModel" : { "returnType" : "Boolean", @@ -10526,7 +10526,7 @@ "marshallingType" : "BOOLEAN", "name" : "ExcludeUppercase", "sensitive" : false, - "setterDocumentation" : "/**Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
\n@param excludeUppercase Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.*/", + "setterDocumentation" : "/**Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
\n@param excludeUppercase Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.*/", "setterMethodName" : "setExcludeUppercase", "setterModel" : { "timestampFormat" : null, @@ -10541,13 +10541,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
\n@param excludeUppercase Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
\n@param excludeUppercase Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "excludeUppercase", "variableType" : "Boolean", - "documentation" : "Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
", + "documentation" : "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -10557,12 +10557,12 @@ "c2jName" : "IncludeSpace", "c2jShape" : "IncludeSpaceType", "deprecated" : false, - "documentation" : "Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
", + "documentation" : "Specifies whether to include the space character. If you include this switch, the password can contain space characters.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
\n@param includeSpace Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Specifies whether to include the space character. If you include this switch, the password can contain space characters.
\n@param includeSpace Specifies whether to include the space character. If you include this switch, the password can contain space characters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withIncludeSpace", - "getterDocumentation" : "/**Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
\n@return Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.*/", + "getterDocumentation" : "/**Specifies whether to include the space character. If you include this switch, the password can contain space characters.
\n@return Specifies whether to include the space character. If you include this switch, the password can contain space characters.*/", "getterMethodName" : "getIncludeSpace", "getterModel" : { "returnType" : "Boolean", @@ -10596,7 +10596,7 @@ "marshallingType" : "BOOLEAN", "name" : "IncludeSpace", "sensitive" : false, - "setterDocumentation" : "/**Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
\n@param includeSpace Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.*/", + "setterDocumentation" : "/**Specifies whether to include the space character. If you include this switch, the password can contain space characters.
\n@param includeSpace Specifies whether to include the space character. If you include this switch, the password can contain space characters.*/", "setterMethodName" : "setIncludeSpace", "setterModel" : { "timestampFormat" : null, @@ -10611,13 +10611,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
\n@param includeSpace Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Specifies whether to include the space character. If you include this switch, the password can contain space characters.
\n@param includeSpace Specifies whether to include the space character. If you include this switch, the password can contain space characters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "includeSpace", "variableType" : "Boolean", - "documentation" : "Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
", + "documentation" : "Specifies whether to include the space character. If you include this switch, the password can contain space characters.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -10627,12 +10627,12 @@ "c2jName" : "PasswordLength", "c2jShape" : "PasswordLengthType", "deprecated" : false, - "documentation" : "The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
", + "documentation" : "The length of the password. If you don't include this parameter, the default length is 32 characters.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
\n@param passwordLength The desired length of the generated password. The default value if you do not include this parameter is 32 characters.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The length of the password. If you don't include this parameter, the default length is 32 characters.
\n@param passwordLength The length of the password. If you don't include this parameter, the default length is 32 characters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withPasswordLength", - "getterDocumentation" : "/**The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
\n@return The desired length of the generated password. The default value if you do not include this parameter is 32 characters.*/", + "getterDocumentation" : "/**The length of the password. If you don't include this parameter, the default length is 32 characters.
\n@return The length of the password. If you don't include this parameter, the default length is 32 characters.*/", "getterMethodName" : "getPasswordLength", "getterModel" : { "returnType" : "Long", @@ -10666,7 +10666,7 @@ "marshallingType" : "LONG", "name" : "PasswordLength", "sensitive" : false, - "setterDocumentation" : "/**The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
\n@param passwordLength The desired length of the generated password. The default value if you do not include this parameter is 32 characters.*/", + "setterDocumentation" : "/**The length of the password. If you don't include this parameter, the default length is 32 characters.
\n@param passwordLength The length of the password. If you don't include this parameter, the default length is 32 characters.*/", "setterMethodName" : "setPasswordLength", "setterModel" : { "timestampFormat" : null, @@ -10681,13 +10681,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
\n@param passwordLength The desired length of the generated password. The default value if you do not include this parameter is 32 characters.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The length of the password. If you don't include this parameter, the default length is 32 characters.
\n@param passwordLength The length of the password. If you don't include this parameter, the default length is 32 characters.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Long", "variableName" : "passwordLength", "variableType" : "Long", - "documentation" : "The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
", + "documentation" : "The length of the password. If you don't include this parameter, the default length is 32 characters.
", "simpleType" : "Long", "variableSetterType" : "Long" }, @@ -10697,12 +10697,12 @@ "c2jName" : "RequireEachIncludedType", "c2jShape" : "RequireEachIncludedTypeType", "deprecated" : false, - "documentation" : "A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
True
and the operation requires at least one of every character type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
\n@param requireEachIncludedType Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRequireEachIncludedType", - "getterDocumentation" : "/**A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
True
and the operation requires at least one of every character type.*/",
+ "getterDocumentation" : "/**Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
\n@return Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.*/", "getterMethodName" : "getRequireEachIncludedType", "getterModel" : { "returnType" : "Boolean", @@ -10736,7 +10736,7 @@ "marshallingType" : "BOOLEAN", "name" : "RequireEachIncludedType", "sensitive" : false, - "setterDocumentation" : "/**A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
True
and the operation requires at least one of every character type.*/",
+ "setterDocumentation" : "/**Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
\n@param requireEachIncludedType Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.*/", "setterMethodName" : "setRequireEachIncludedType", "setterModel" : { "timestampFormat" : null, @@ -10751,13 +10751,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
True
and the operation requires at least one of every character type.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
\n@param requireEachIncludedType Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "requireEachIncludedType", "variableType" : "Boolean", - "documentation" : "A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -10807,12 +10807,12 @@ "c2jName" : "RandomPassword", "c2jShape" : "RandomPasswordType", "deprecated" : false, - "documentation" : "A string with the generated password.
", + "documentation" : "A string with the password.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A string with the generated password.
\n@param randomPassword A string with the generated password.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A string with the password.
\n@param randomPassword A string with the password.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRandomPassword", - "getterDocumentation" : "/**A string with the generated password.
\n@return A string with the generated password.*/", + "getterDocumentation" : "/**A string with the password.
\n@return A string with the password.*/", "getterMethodName" : "getRandomPassword", "getterModel" : { "returnType" : "String", @@ -10846,7 +10846,7 @@ "marshallingType" : "STRING", "name" : "RandomPassword", "sensitive" : true, - "setterDocumentation" : "/**A string with the generated password.
\n@param randomPassword A string with the generated password.*/", + "setterDocumentation" : "/**A string with the password.
\n@param randomPassword A string with the password.*/", "setterMethodName" : "setRandomPassword", "setterModel" : { "timestampFormat" : null, @@ -10861,13 +10861,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A string with the generated password.
\n@param randomPassword A string with the generated password.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A string with the password.
\n@param randomPassword A string with the password.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "randomPassword", "variableType" : "String", - "documentation" : "A string with the generated password.
", + "documentation" : "A string with the password.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -10878,12 +10878,12 @@ "c2jName" : "RandomPassword", "c2jShape" : "RandomPasswordType", "deprecated" : false, - "documentation" : "A string with the generated password.
", + "documentation" : "A string with the password.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A string with the generated password.
\n@param randomPassword A string with the generated password.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A string with the password.
\n@param randomPassword A string with the password.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRandomPassword", - "getterDocumentation" : "/**A string with the generated password.
\n@return A string with the generated password.*/", + "getterDocumentation" : "/**A string with the password.
\n@return A string with the password.*/", "getterMethodName" : "getRandomPassword", "getterModel" : { "returnType" : "String", @@ -10917,7 +10917,7 @@ "marshallingType" : "STRING", "name" : "RandomPassword", "sensitive" : true, - "setterDocumentation" : "/**A string with the generated password.
\n@param randomPassword A string with the generated password.*/", + "setterDocumentation" : "/**A string with the password.
\n@param randomPassword A string with the password.*/", "setterMethodName" : "setRandomPassword", "setterModel" : { "timestampFormat" : null, @@ -10932,13 +10932,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A string with the generated password.
\n@param randomPassword A string with the generated password.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A string with the password.
\n@param randomPassword A string with the password.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "randomPassword", "variableType" : "String", - "documentation" : "A string with the generated password.
", + "documentation" : "A string with the password.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -10998,12 +10998,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to retrieve the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -11037,7 +11037,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -11052,13 +11052,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11069,12 +11069,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to retrieve the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -11108,7 +11108,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -11123,13 +11123,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve the attached resource-based policy for.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11248,12 +11248,12 @@ "c2jName" : "Name", "c2jShape" : "NameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that the resource-based policy was retrieved for.
", + "documentation" : "The name of the secret that the resource-based policy was retrieved for.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that the resource-based policy was retrieved for.
\n@param name The friendly name of the secret that the resource-based policy was retrieved for.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that the resource-based policy was retrieved for.
\n@param name The name of the secret that the resource-based policy was retrieved for.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that the resource-based policy was retrieved for.
\n@return The friendly name of the secret that the resource-based policy was retrieved for.*/", + "getterDocumentation" : "/**The name of the secret that the resource-based policy was retrieved for.
\n@return The name of the secret that the resource-based policy was retrieved for.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -11287,7 +11287,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that the resource-based policy was retrieved for.
\n@param name The friendly name of the secret that the resource-based policy was retrieved for.*/", + "setterDocumentation" : "/**The name of the secret that the resource-based policy was retrieved for.
\n@param name The name of the secret that the resource-based policy was retrieved for.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -11302,13 +11302,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that the resource-based policy was retrieved for.
\n@param name The friendly name of the secret that the resource-based policy was retrieved for.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that the resource-based policy was retrieved for.
\n@param name The name of the secret that the resource-based policy was retrieved for.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that the resource-based policy was retrieved for.
", + "documentation" : "The name of the secret that the resource-based policy was retrieved for.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11317,12 +11317,12 @@ "c2jName" : "ResourcePolicy", "c2jShape" : "NonEmptyResourcePolicyType", "deprecated" : false, - "documentation" : "A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
", + "documentation" : "A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
\n@param resourcePolicy A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
\n@param resourcePolicy A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withResourcePolicy", - "getterDocumentation" : "/**A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
\n@return A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.*/", + "getterDocumentation" : "/**A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
\n@return A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.*/", "getterMethodName" : "getResourcePolicy", "getterModel" : { "returnType" : "String", @@ -11356,7 +11356,7 @@ "marshallingType" : "STRING", "name" : "ResourcePolicy", "sensitive" : false, - "setterDocumentation" : "/**A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
\n@param resourcePolicy A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.*/", + "setterDocumentation" : "/**A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
\n@param resourcePolicy A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.*/", "setterMethodName" : "setResourcePolicy", "setterModel" : { "timestampFormat" : null, @@ -11371,13 +11371,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
\n@param resourcePolicy A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
\n@param resourcePolicy A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "resourcePolicy", "variableType" : "String", - "documentation" : "A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
", + "documentation" : "A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11458,12 +11458,12 @@ "c2jName" : "Name", "c2jShape" : "NameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that the resource-based policy was retrieved for.
", + "documentation" : "The name of the secret that the resource-based policy was retrieved for.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that the resource-based policy was retrieved for.
\n@param name The friendly name of the secret that the resource-based policy was retrieved for.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that the resource-based policy was retrieved for.
\n@param name The name of the secret that the resource-based policy was retrieved for.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that the resource-based policy was retrieved for.
\n@return The friendly name of the secret that the resource-based policy was retrieved for.*/", + "getterDocumentation" : "/**The name of the secret that the resource-based policy was retrieved for.
\n@return The name of the secret that the resource-based policy was retrieved for.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -11497,7 +11497,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that the resource-based policy was retrieved for.
\n@param name The friendly name of the secret that the resource-based policy was retrieved for.*/", + "setterDocumentation" : "/**The name of the secret that the resource-based policy was retrieved for.
\n@param name The name of the secret that the resource-based policy was retrieved for.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -11512,13 +11512,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that the resource-based policy was retrieved for.
\n@param name The friendly name of the secret that the resource-based policy was retrieved for.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that the resource-based policy was retrieved for.
\n@param name The name of the secret that the resource-based policy was retrieved for.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that the resource-based policy was retrieved for.
", + "documentation" : "The name of the secret that the resource-based policy was retrieved for.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11528,12 +11528,12 @@ "c2jName" : "ResourcePolicy", "c2jShape" : "NonEmptyResourcePolicyType", "deprecated" : false, - "documentation" : "A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
", + "documentation" : "A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
\n@param resourcePolicy A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
\n@param resourcePolicy A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withResourcePolicy", - "getterDocumentation" : "/**A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
\n@return A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.*/", + "getterDocumentation" : "/**A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
\n@return A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.*/", "getterMethodName" : "getResourcePolicy", "getterModel" : { "returnType" : "String", @@ -11567,7 +11567,7 @@ "marshallingType" : "STRING", "name" : "ResourcePolicy", "sensitive" : false, - "setterDocumentation" : "/**A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
\n@param resourcePolicy A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.*/", + "setterDocumentation" : "/**A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
\n@param resourcePolicy A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.*/", "setterMethodName" : "setResourcePolicy", "setterModel" : { "timestampFormat" : null, @@ -11582,13 +11582,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
\n@param resourcePolicy A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
\n@param resourcePolicy A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "resourcePolicy", "variableType" : "String", - "documentation" : "A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
", + "documentation" : "A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11648,12 +11648,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to retrieve.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -11687,7 +11687,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -11702,13 +11702,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11717,12 +11717,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
", + "documentation" : "The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
. This value is typically a UUID-type value with 32 hexadecimal digits.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version. This value is typically a UUID-type value with 32 hexadecimal digits.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersionId", - "getterDocumentation" : "/**
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@return Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
. This value is typically a UUID-type value with 32 hexadecimal digits.*/", + "getterDocumentation" : "/**
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@return The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version. This value is typically a UUID-type value with 32 hexadecimal digits.*/", "getterMethodName" : "getVersionId", "getterModel" : { "returnType" : "String", @@ -11756,7 +11756,7 @@ "marshallingType" : "STRING", "name" : "VersionId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
. This value is typically a UUID-type value with 32 hexadecimal digits.*/", + "setterDocumentation" : "/**
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version. This value is typically a UUID-type value with 32 hexadecimal digits.*/", "setterMethodName" : "setVersionId", "setterModel" : { "timestampFormat" : null, @@ -11771,13 +11771,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
. This value is typically a UUID-type value with 32 hexadecimal digits.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version. This value is typically a UUID-type value with 32 hexadecimal digits.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "versionId", "variableType" : "String", - "documentation" : "
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
", + "documentation" : "The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11786,12 +11786,12 @@ "c2jName" : "VersionStage", "c2jShape" : "SecretVersionStageType", "deprecated" : false, - "documentation" : "Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withVersionStage",
- "getterDocumentation" : "/**
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.*/",
+ "getterDocumentation" : "/**
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.*/",
"getterMethodName" : "getVersionStage",
"getterModel" : {
"returnType" : "String",
@@ -11825,7 +11825,7 @@
"marshallingType" : "STRING",
"name" : "VersionStage",
"sensitive" : false,
- "setterDocumentation" : "/**
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.*/",
+ "setterDocumentation" : "/**
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.*/",
"setterMethodName" : "setVersionStage",
"setterModel" : {
"timestampFormat" : null,
@@ -11840,13 +11840,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "versionStage",
"variableType" : "String",
- "documentation" : "
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to retrieve.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -11896,7 +11896,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -11911,13 +11911,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to retrieve.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11927,12 +11927,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
", + "documentation" : "The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
. This value is typically a UUID-type value with 32 hexadecimal digits.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version. This value is typically a UUID-type value with 32 hexadecimal digits.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersionId", - "getterDocumentation" : "/**
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@return Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
. This value is typically a UUID-type value with 32 hexadecimal digits.*/", + "getterDocumentation" : "/**
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@return The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version. This value is typically a UUID-type value with 32 hexadecimal digits.*/", "getterMethodName" : "getVersionId", "getterModel" : { "returnType" : "String", @@ -11966,7 +11966,7 @@ "marshallingType" : "STRING", "name" : "VersionId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
. This value is typically a UUID-type value with 32 hexadecimal digits.*/", + "setterDocumentation" : "/**
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version. This value is typically a UUID-type value with 32 hexadecimal digits.*/", "setterMethodName" : "setVersionId", "setterModel" : { "timestampFormat" : null, @@ -11981,13 +11981,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
. This value is typically a UUID-type value with 32 hexadecimal digits.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
\n@param versionId The unique identifier of the version of the secret to retrieve. If you include both this parameter andVersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version. This value is typically a UUID-type value with 32 hexadecimal digits.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "versionId", "variableType" : "String", - "documentation" : "
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
", + "documentation" : "The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -11997,12 +11997,12 @@ "c2jName" : "VersionStage", "c2jShape" : "SecretVersionStageType", "deprecated" : false, - "documentation" : "Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withVersionStage",
- "getterDocumentation" : "/**
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.*/",
+ "getterDocumentation" : "/**
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.*/",
"getterMethodName" : "getVersionStage",
"getterModel" : {
"returnType" : "String",
@@ -12036,7 +12036,7 @@
"marshallingType" : "STRING",
"name" : "VersionStage",
"sensitive" : false,
- "setterDocumentation" : "/**
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.*/",
+ "setterDocumentation" : "/**
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.*/",
"setterMethodName" : "setVersionStage",
"setterModel" : {
"timestampFormat" : null,
@@ -12051,13 +12051,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "versionStage",
"variableType" : "String",
- "documentation" : "
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withSecretBinary",
- "getterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.*/",
+ "getterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.*/",
"getterMethodName" : "getSecretBinary",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
@@ -12353,7 +12353,7 @@
"marshallingType" : "BYTE_BUFFER",
"name" : "SecretBinary",
"sensitive" : true,
- "setterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.*/",
+ "setterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.*/",
"setterMethodName" : "setSecretBinary",
"setterModel" : {
"timestampFormat" : null,
@@ -12368,13 +12368,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "secretBinary",
"variableType" : "java.nio.ByteBuffer",
- "documentation" : "
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
", + "documentation" : "The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
\n@param secretString The decrypted part of the protected secret information that was originally provided as a string.If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
\n@param secretString The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretString", - "getterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
\n@return The decrypted part of the protected secret information that was originally provided as a string.If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.*/", + "getterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
\n@return The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.*/", "getterMethodName" : "getSecretString", "getterModel" : { "returnType" : "String", @@ -12422,7 +12422,7 @@ "marshallingType" : "STRING", "name" : "SecretString", "sensitive" : true, - "setterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
\n@param secretString The decrypted part of the protected secret information that was originally provided as a string.If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.*/", + "setterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
\n@param secretString The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.*/", "setterMethodName" : "setSecretString", "setterModel" : { "timestampFormat" : null, @@ -12437,13 +12437,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
\n@param secretString The decrypted part of the protected secret information that was originally provided as a string.If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
\n@param secretString The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretString", "variableType" : "String", - "documentation" : "
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
", + "documentation" : "The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -12605,12 +12605,12 @@ "c2jName" : "CreatedDate", "c2jShape" : "CreatedDateType", "deprecated" : false, - "documentation" : "The date and time that this version of the secret was created.
", + "documentation" : "The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
The date and time that this version of the secret was created.
\n@param createdDate The date and time that this version of the secret was created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withCreatedDate",
- "getterDocumentation" : "/**The date and time that this version of the secret was created.
\n@return The date and time that this version of the secret was created.*/", + "getterDocumentation" : "/**The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.*/",
"getterMethodName" : "getCreatedDate",
"getterModel" : {
"returnType" : "java.util.Date",
@@ -12644,7 +12644,7 @@
"marshallingType" : "DATE",
"name" : "CreatedDate",
"sensitive" : false,
- "setterDocumentation" : "/**The date and time that this version of the secret was created.
\n@param createdDate The date and time that this version of the secret was created.*/", + "setterDocumentation" : "/**The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.*/",
"setterMethodName" : "setCreatedDate",
"setterModel" : {
"timestampFormat" : null,
@@ -12659,13 +12659,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The date and time that this version of the secret was created.
\n@param createdDate The date and time that this version of the secret was created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : "unixTimestamp",
"variableDeclarationType" : "java.util.Date",
"variableName" : "createdDate",
"variableType" : "java.util.Date",
- "documentation" : "The date and time that this version of the secret was created.
", + "documentation" : "The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
The date and time that this version of the secret was created.
", + "documentation" : "The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
The date and time that this version of the secret was created.
\n@param createdDate The date and time that this version of the secret was created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withCreatedDate",
- "getterDocumentation" : "/**The date and time that this version of the secret was created.
\n@return The date and time that this version of the secret was created.*/", + "getterDocumentation" : "/**The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.*/",
"getterMethodName" : "getCreatedDate",
"getterModel" : {
"returnType" : "java.util.Date",
@@ -12785,7 +12785,7 @@
"marshallingType" : "DATE",
"name" : "CreatedDate",
"sensitive" : false,
- "setterDocumentation" : "/**The date and time that this version of the secret was created.
\n@param createdDate The date and time that this version of the secret was created.*/", + "setterDocumentation" : "/**The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.*/",
"setterMethodName" : "setCreatedDate",
"setterModel" : {
"timestampFormat" : null,
@@ -12800,13 +12800,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The date and time that this version of the secret was created.
\n@param createdDate The date and time that this version of the secret was created.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : "unixTimestamp",
"variableDeclarationType" : "java.util.Date",
"variableName" : "createdDate",
"variableType" : "java.util.Date",
- "documentation" : "The date and time that this version of the secret was created.
", + "documentation" : "The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withSecretBinary",
- "getterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.*/",
+ "getterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.*/",
"getterMethodName" : "getSecretBinary",
"getterModel" : {
"returnType" : "java.nio.ByteBuffer",
@@ -12925,7 +12925,7 @@
"marshallingType" : "BYTE_BUFFER",
"name" : "SecretBinary",
"sensitive" : true,
- "setterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.*/",
+ "setterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.*/",
"setterMethodName" : "setSecretBinary",
"setterModel" : {
"timestampFormat" : null,
@@ -12940,13 +12940,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.nio.ByteBuffer",
"variableName" : "secretBinary",
"variableType" : "java.nio.ByteBuffer",
- "documentation" : "
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
", + "documentation" : "The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
\n@param secretString The decrypted part of the protected secret information that was originally provided as a string.If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
\n@param secretString The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretString", - "getterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
\n@return The decrypted part of the protected secret information that was originally provided as a string.If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.*/", + "getterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
\n@return The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.*/", "getterMethodName" : "getSecretString", "getterModel" : { "returnType" : "String", @@ -12995,7 +12995,7 @@ "marshallingType" : "STRING", "name" : "SecretString", "sensitive" : true, - "setterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
\n@param secretString The decrypted part of the protected secret information that was originally provided as a string.If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.*/", + "setterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
\n@param secretString The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.*/", "setterMethodName" : "setSecretString", "setterModel" : { "timestampFormat" : null, @@ -13010,13 +13010,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
\n@param secretString The decrypted part of the protected secret information that was originally provided as a string.If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
\n@param secretString The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretString", "variableType" : "String", - "documentation" : "
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
", + "documentation" : "The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -13319,7 +13319,7 @@ "skipGeneratingUnmarshaller" : false }, "deprecated" : false, - "documentation" : "You provided an invalid NextToken
value.
The NextToken
value is invalid.
You provided an invalid value for a parameter.
", + "documentation" : "The parameter name is invalid value.
", "endpointDiscoveryMembers" : null, "enums" : null, "errorCode" : "InvalidParameterException", @@ -13401,7 +13401,7 @@ "skipGeneratingUnmarshaller" : false }, "deprecated" : false, - "documentation" : "You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
The request failed because it would exceed one of the Secrets Manager internal limits.
", + "documentation" : "The request failed because it would exceed one of the Secrets Manager quotas.
", "endpointDiscoveryMembers" : null, "enums" : null, "errorCode" : "LimitExceededException", @@ -13505,12 +13505,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret whose versions you want to list.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret whose versions you want to list.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -13544,7 +13544,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret whose versions you want to list.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -13559,13 +13559,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret whose versions you want to list.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -13574,12 +13574,12 @@ "c2jName" : "MaxResults", "c2jShape" : "MaxResultsType", "deprecated" : false, - "documentation" : "(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withMaxResults",
- "getterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.*/",
+ "getterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.*/",
"getterMethodName" : "getMaxResults",
"getterModel" : {
"returnType" : "Integer",
@@ -13613,7 +13613,7 @@
"marshallingType" : "INTEGER",
"name" : "MaxResults",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.*/",
+ "setterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.*/",
"setterMethodName" : "setMaxResults",
"setterModel" : {
"timestampFormat" : null,
@@ -13628,13 +13628,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "Integer",
"variableName" : "maxResults",
"variableType" : "Integer",
- "documentation" : "
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withNextToken",
- "getterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.*/",
+ "getterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.*/",
"getterMethodName" : "getNextToken",
"getterModel" : {
"returnType" : "String",
@@ -13682,7 +13682,7 @@
"marshallingType" : "STRING",
"name" : "NextToken",
"sensitive" : false,
- "setterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.*/",
+ "setterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.*/",
"setterMethodName" : "setNextToken",
"setterModel" : {
"timestampFormat" : null,
@@ -13697,13 +13697,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "nextToken",
"variableType" : "String",
- "documentation" : "(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
", + "documentation" : "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.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
\n@param includeDeprecated (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**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.
\n@param includeDeprecated 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.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withIncludeDeprecated", - "getterDocumentation" : "/**(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
\n@return (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.*/", + "getterDocumentation" : "/**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.
\n@return 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.*/", "getterMethodName" : "getIncludeDeprecated", "getterModel" : { "returnType" : "Boolean", @@ -13751,7 +13751,7 @@ "marshallingType" : "BOOLEAN", "name" : "IncludeDeprecated", "sensitive" : false, - "setterDocumentation" : "/**(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
\n@param includeDeprecated (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.*/", + "setterDocumentation" : "/**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.
\n@param includeDeprecated 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.*/", "setterMethodName" : "setIncludeDeprecated", "setterModel" : { "timestampFormat" : null, @@ -13766,13 +13766,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
\n@param includeDeprecated (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**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.
\n@param includeDeprecated 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.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "includeDeprecated", "variableType" : "Boolean", - "documentation" : "(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
", + "documentation" : "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.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -13783,12 +13783,12 @@ "c2jName" : "IncludeDeprecated", "c2jShape" : "BooleanType", "deprecated" : false, - "documentation" : "(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
", + "documentation" : "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.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
\n@param includeDeprecated (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**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.
\n@param includeDeprecated 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.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withIncludeDeprecated", - "getterDocumentation" : "/**(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
\n@return (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.*/", + "getterDocumentation" : "/**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.
\n@return 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.*/", "getterMethodName" : "getIncludeDeprecated", "getterModel" : { "returnType" : "Boolean", @@ -13822,7 +13822,7 @@ "marshallingType" : "BOOLEAN", "name" : "IncludeDeprecated", "sensitive" : false, - "setterDocumentation" : "/**(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
\n@param includeDeprecated (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.*/", + "setterDocumentation" : "/**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.
\n@param includeDeprecated 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.*/", "setterMethodName" : "setIncludeDeprecated", "setterModel" : { "timestampFormat" : null, @@ -13837,13 +13837,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
\n@param includeDeprecated (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**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.
\n@param includeDeprecated 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.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "includeDeprecated", "variableType" : "Boolean", - "documentation" : "(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
", + "documentation" : "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.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -13853,12 +13853,12 @@ "c2jName" : "MaxResults", "c2jShape" : "MaxResultsType", "deprecated" : false, - "documentation" : "(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withMaxResults",
- "getterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.*/",
+ "getterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.*/",
"getterMethodName" : "getMaxResults",
"getterModel" : {
"returnType" : "Integer",
@@ -13892,7 +13892,7 @@
"marshallingType" : "INTEGER",
"name" : "MaxResults",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.*/",
+ "setterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.*/",
"setterMethodName" : "setMaxResults",
"setterModel" : {
"timestampFormat" : null,
@@ -13907,13 +13907,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "Integer",
"variableName" : "maxResults",
"variableType" : "Integer",
- "documentation" : "
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withNextToken",
- "getterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.*/",
+ "getterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.*/",
"getterMethodName" : "getNextToken",
"getterModel" : {
"returnType" : "String",
@@ -13962,7 +13962,7 @@
"marshallingType" : "STRING",
"name" : "NextToken",
"sensitive" : false,
- "setterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.*/",
+ "setterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.*/",
"setterMethodName" : "setNextToken",
"setterModel" : {
"timestampFormat" : null,
@@ -13977,13 +13977,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "nextToken",
"variableType" : "String",
- "documentation" : "(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret whose versions you want to list.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret whose versions you want to list.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -14032,7 +14032,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret whose versions you want to list.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -14047,13 +14047,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret whose versions you want to list.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -14103,12 +14103,12 @@ "c2jName" : "Versions", "c2jShape" : "SecretVersionsListType", "deprecated" : false, - "documentation" : "The list of the currently available versions of the specified secret.
", + "documentation" : "A list of the versions of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The list of the currently available versions of the specified secret.
\n@param versions The list of the currently available versions of the specified secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A list of the versions of the secret.
\n@param versions A list of the versions of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersions", - "getterDocumentation" : "/**The list of the currently available versions of the specified secret.
\n@return The list of the currently available versions of the specified secret.*/", + "getterDocumentation" : "/**A list of the versions of the secret.
\n@return A list of the versions of the secret.*/", "getterMethodName" : "getVersions", "getterModel" : { "returnType" : "java.util.ListThe list of the currently available versions of the specified secret.
\n@param versions The list of the currently available versions of the specified secret.*/", + "setterDocumentation" : "/**A list of the versions of the secret.
\n@param versions A list of the versions of the secret.*/", "setterMethodName" : "setVersions", "setterModel" : { "timestampFormat" : null, @@ -14241,13 +14241,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The list of the currently available versions of the specified secret.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setVersions(java.util.Collection)} or {@link #withVersions(java.util.Collection)} if you want to override the existing values.
\n@param versions The list of the currently available versions of the specified secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A list of the versions of the secret.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setVersions(java.util.Collection)} or {@link #withVersions(java.util.Collection)} if you want to override the existing values.
\n@param versions A list of the versions of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.ListThe list of the currently available versions of the specified secret.
", + "documentation" : "A list of the versions of the secret.
", "simpleType" : "ListIf present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withNextToken",
- "getterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).*/",
+ "getterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.*/",
"getterMethodName" : "getNextToken",
"getterModel" : {
"returnType" : "String",
@@ -14295,7 +14295,7 @@
"marshallingType" : "STRING",
"name" : "NextToken",
"sensitive" : false,
- "setterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).*/",
+ "setterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.*/",
"setterMethodName" : "setNextToken",
"setterModel" : {
"timestampFormat" : null,
@@ -14310,13 +14310,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "nextToken",
"variableType" : "String",
- "documentation" : "If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "getterDocumentation" : "/**The ARN of the secret.
\n@return The ARN of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -14364,7 +14364,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "setterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -14379,13 +14379,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -14394,12 +14394,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret.
\n@return The friendly name of the secret.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -14433,7 +14433,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -14448,13 +14448,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -14465,12 +14465,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "getterDocumentation" : "/**The ARN of the secret.
\n@return The ARN of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -14504,7 +14504,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "setterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -14519,13 +14519,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -14535,12 +14535,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret.
\n@return The friendly name of the secret.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -14574,7 +14574,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -14589,13 +14589,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -14605,12 +14605,12 @@ "c2jName" : "NextToken", "c2jShape" : "NextTokenType", "deprecated" : false, - "documentation" : "If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withNextToken",
- "getterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).*/",
+ "getterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.*/",
"getterMethodName" : "getNextToken",
"getterModel" : {
"returnType" : "String",
@@ -14644,7 +14644,7 @@
"marshallingType" : "STRING",
"name" : "NextToken",
"sensitive" : false,
- "setterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).*/",
+ "setterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.*/",
"setterMethodName" : "setNextToken",
"setterModel" : {
"timestampFormat" : null,
@@ -14659,13 +14659,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
ListSecretVersionIds
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "nextToken",
"variableType" : "String",
- "documentation" : "If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
The list of the currently available versions of the specified secret.
", + "documentation" : "A list of the versions of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The list of the currently available versions of the specified secret.
\n@param versions The list of the currently available versions of the specified secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A list of the versions of the secret.
\n@param versions A list of the versions of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersions", - "getterDocumentation" : "/**The list of the currently available versions of the specified secret.
\n@return The list of the currently available versions of the specified secret.*/", + "getterDocumentation" : "/**A list of the versions of the secret.
\n@return A list of the versions of the secret.*/", "getterMethodName" : "getVersions", "getterModel" : { "returnType" : "java.util.ListThe list of the currently available versions of the specified secret.
\n@param versions The list of the currently available versions of the specified secret.*/", + "setterDocumentation" : "/**A list of the versions of the secret.
\n@param versions A list of the versions of the secret.*/", "setterMethodName" : "setVersions", "setterModel" : { "timestampFormat" : null, @@ -14813,13 +14813,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The list of the currently available versions of the specified secret.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setVersions(java.util.Collection)} or {@link #withVersions(java.util.Collection)} if you want to override the existing values.
\n@param versions The list of the currently available versions of the specified secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A list of the versions of the secret.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setVersions(java.util.Collection)} or {@link #withVersions(java.util.Collection)} if you want to override the existing values.
\n@param versions A list of the versions of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.ListThe list of the currently available versions of the specified secret.
", + "documentation" : "A list of the versions of the secret.
", "simpleType" : "List(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withMaxResults",
- "getterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.*/",
+ "getterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.*/",
"getterMethodName" : "getMaxResults",
"getterModel" : {
"returnType" : "Integer",
@@ -14918,7 +14918,7 @@
"marshallingType" : "INTEGER",
"name" : "MaxResults",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.*/",
+ "setterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.*/",
"setterMethodName" : "setMaxResults",
"setterModel" : {
"timestampFormat" : null,
@@ -14933,13 +14933,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "Integer",
"variableName" : "maxResults",
"variableType" : "Integer",
- "documentation" : "
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withNextToken",
- "getterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.*/",
+ "getterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.*/",
"getterMethodName" : "getNextToken",
"getterModel" : {
"returnType" : "String",
@@ -14987,7 +14987,7 @@
"marshallingType" : "STRING",
"name" : "NextToken",
"sensitive" : false,
- "setterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.*/",
+ "setterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.*/",
"setterMethodName" : "setNextToken",
"setterModel" : {
"timestampFormat" : null,
@@ -15002,13 +15002,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "nextToken",
"variableType" : "String",
- "documentation" : "(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
Lists the secret request filters.
", + "documentation" : "The filters to apply to the list of secrets.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Lists the secret request filters.
\n@param filters Lists the secret request filters.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The filters to apply to the list of secrets.
\n@param filters The filters to apply to the list of secrets.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withFilters", - "getterDocumentation" : "/**Lists the secret request filters.
\n@return Lists the secret request filters.*/", + "getterDocumentation" : "/**The filters to apply to the list of secrets.
\n@return The filters to apply to the list of secrets.*/", "getterMethodName" : "getFilters", "getterModel" : { "returnType" : "java.util.ListLists the secret request filters.
\n@param filters Lists the secret request filters.*/", + "setterDocumentation" : "/**The filters to apply to the list of secrets.
\n@param filters The filters to apply to the list of secrets.*/", "setterMethodName" : "setFilters", "setterModel" : { "timestampFormat" : null, @@ -15155,13 +15155,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Lists the secret request filters.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override the existing values.
\n@param filters Lists the secret request filters.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The filters to apply to the list of secrets.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override the existing values.
\n@param filters The filters to apply to the list of secrets.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.ListLists the secret request filters.
", + "documentation" : "The filters to apply to the list of secrets.
", "simpleType" : "ListLists the secret request filters.
", + "documentation" : "The filters to apply to the list of secrets.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Lists the secret request filters.
\n@param filters Lists the secret request filters.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The filters to apply to the list of secrets.
\n@param filters The filters to apply to the list of secrets.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withFilters", - "getterDocumentation" : "/**Lists the secret request filters.
\n@return Lists the secret request filters.*/", + "getterDocumentation" : "/**The filters to apply to the list of secrets.
\n@return The filters to apply to the list of secrets.*/", "getterMethodName" : "getFilters", "getterModel" : { "returnType" : "java.util.ListLists the secret request filters.
\n@param filters Lists the secret request filters.*/", + "setterDocumentation" : "/**The filters to apply to the list of secrets.
\n@param filters The filters to apply to the list of secrets.*/", "setterMethodName" : "setFilters", "setterModel" : { "timestampFormat" : null, @@ -15379,13 +15379,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Lists the secret request filters.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override the existing values.
\n@param filters Lists the secret request filters.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The filters to apply to the list of secrets.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override the existing values.
\n@param filters The filters to apply to the list of secrets.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.ListLists the secret request filters.
", + "documentation" : "The filters to apply to the list of secrets.
", "simpleType" : "List(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withMaxResults",
- "getterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.*/",
+ "getterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.*/",
"getterMethodName" : "getMaxResults",
"getterModel" : {
"returnType" : "Integer",
@@ -15434,7 +15434,7 @@
"marshallingType" : "INTEGER",
"name" : "MaxResults",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.*/",
+ "setterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.*/",
"setterMethodName" : "setMaxResults",
"setterModel" : {
"timestampFormat" : null,
@@ -15449,13 +15449,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "Integer",
"variableName" : "maxResults",
"variableType" : "Integer",
- "documentation" : "
(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withNextToken",
- "getterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.*/",
+ "getterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.*/",
"getterMethodName" : "getNextToken",
"getterModel" : {
"returnType" : "String",
@@ -15504,7 +15504,7 @@
"marshallingType" : "STRING",
"name" : "NextToken",
"sensitive" : false,
- "setterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.*/",
+ "setterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.*/",
"setterMethodName" : "setNextToken",
"setterModel" : {
"timestampFormat" : null,
@@ -15519,13 +15519,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "nextToken",
"variableType" : "String",
- "documentation" : "(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withNextToken",
- "getterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).*/",
+ "getterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.*/",
"getterMethodName" : "getNextToken",
"getterModel" : {
"returnType" : "String",
@@ -15837,7 +15837,7 @@
"marshallingType" : "STRING",
"name" : "NextToken",
"sensitive" : false,
- "setterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).*/",
+ "setterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.*/",
"setterMethodName" : "setNextToken",
"setterModel" : {
"timestampFormat" : null,
@@ -15852,13 +15852,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "nextToken",
"variableType" : "String",
- "documentation" : "If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withNextToken",
- "getterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).*/",
+ "getterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.*/",
"getterMethodName" : "getNextToken",
"getterModel" : {
"returnType" : "String",
@@ -15908,7 +15908,7 @@
"marshallingType" : "STRING",
"name" : "NextToken",
"sensitive" : false,
- "setterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).*/",
+ "setterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.*/",
"setterMethodName" : "setNextToken",
"setterModel" : {
"timestampFormat" : null,
@@ -15923,13 +15923,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
ListSecrets
again with this value.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "nextToken",
"variableType" : "String",
- "documentation" : "If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
You provided a resource-based policy with syntax errors.
", + "documentation" : "The resource policy has syntax errors.
", "endpointDiscoveryMembers" : null, "enums" : null, "errorCode" : "MalformedPolicyDocumentException", @@ -16203,7 +16203,7 @@ "skipGeneratingUnmarshaller" : false }, "deprecated" : false, - "documentation" : "The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.
", + "documentation" : "The BlockPublicPolicy
parameter is set to true, and the resource policy did not prevent broad access to the secret.
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to attach the resource-based policy.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to attach the resource-based policy.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -16305,7 +16305,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to attach the resource-based policy.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -16320,13 +16320,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to attach the resource-based policy.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -16335,12 +16335,12 @@ "c2jName" : "ResourcePolicy", "c2jShape" : "NonEmptyResourcePolicyType", "deprecated" : false, - "documentation" : "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
", + "documentation" : "A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withResourcePolicy", - "getterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
\n@return A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.*/", + "getterDocumentation" : "/**A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
\n@return A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.*/", "getterMethodName" : "getResourcePolicy", "getterModel" : { "returnType" : "String", @@ -16374,7 +16374,7 @@ "marshallingType" : "STRING", "name" : "ResourcePolicy", "sensitive" : false, - "setterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.*/", + "setterDocumentation" : "/**A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.*/", "setterMethodName" : "setResourcePolicy", "setterModel" : { "timestampFormat" : null, @@ -16389,13 +16389,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "resourcePolicy", "variableType" : "String", - "documentation" : "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
", + "documentation" : "A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -16404,12 +16404,12 @@ "c2jName" : "BlockPublicPolicy", "c2jShape" : "BooleanType", "deprecated" : false, - "documentation" : "(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
\n@param blockPublicPolicy Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withBlockPublicPolicy", - "getterDocumentation" : "/**(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.*/",
+ "getterDocumentation" : "/**Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
\n@return Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.*/", "getterMethodName" : "getBlockPublicPolicy", "getterModel" : { "returnType" : "Boolean", @@ -16443,7 +16443,7 @@ "marshallingType" : "BOOLEAN", "name" : "BlockPublicPolicy", "sensitive" : false, - "setterDocumentation" : "/**(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.*/",
+ "setterDocumentation" : "/**Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
\n@param blockPublicPolicy Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.*/", "setterMethodName" : "setBlockPublicPolicy", "setterModel" : { "timestampFormat" : null, @@ -16458,13 +16458,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
\n@param blockPublicPolicy Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "blockPublicPolicy", "variableType" : "Boolean", - "documentation" : "(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -16475,12 +16475,12 @@ "c2jName" : "BlockPublicPolicy", "c2jShape" : "BooleanType", "deprecated" : false, - "documentation" : "(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
\n@param blockPublicPolicy Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withBlockPublicPolicy", - "getterDocumentation" : "/**(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.*/",
+ "getterDocumentation" : "/**Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
\n@return Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.*/", "getterMethodName" : "getBlockPublicPolicy", "getterModel" : { "returnType" : "Boolean", @@ -16514,7 +16514,7 @@ "marshallingType" : "BOOLEAN", "name" : "BlockPublicPolicy", "sensitive" : false, - "setterDocumentation" : "/**(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.*/",
+ "setterDocumentation" : "/**Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
\n@param blockPublicPolicy Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.*/", "setterMethodName" : "setBlockPublicPolicy", "setterModel" : { "timestampFormat" : null, @@ -16529,13 +16529,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
\n@param blockPublicPolicy Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "blockPublicPolicy", "variableType" : "Boolean", - "documentation" : "(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -16545,12 +16545,12 @@ "c2jName" : "ResourcePolicy", "c2jShape" : "NonEmptyResourcePolicyType", "deprecated" : false, - "documentation" : "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
", + "documentation" : "A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withResourcePolicy", - "getterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
\n@return A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.*/", + "getterDocumentation" : "/**A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
\n@return A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.*/", "getterMethodName" : "getResourcePolicy", "getterModel" : { "returnType" : "String", @@ -16584,7 +16584,7 @@ "marshallingType" : "STRING", "name" : "ResourcePolicy", "sensitive" : false, - "setterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.*/", + "setterDocumentation" : "/**A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.*/", "setterMethodName" : "setResourcePolicy", "setterModel" : { "timestampFormat" : null, @@ -16599,13 +16599,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "resourcePolicy", "variableType" : "String", - "documentation" : "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
", + "documentation" : "A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -16615,12 +16615,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to attach the resource-based policy.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to attach the resource-based policy.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -16654,7 +16654,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to attach the resource-based policy.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -16669,13 +16669,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to attach the resource-based policy.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -16725,12 +16725,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "The ARN of the secret retrieved by the resource-based policy.
", + "documentation" : "The ARN of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret retrieved by the resource-based policy.
\n@param aRN The ARN of the secret retrieved by the resource-based policy.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret retrieved by the resource-based policy.
\n@return The ARN of the secret retrieved by the resource-based policy.*/", + "getterDocumentation" : "/**The ARN of the secret.
\n@return The ARN of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -16764,7 +16764,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret retrieved by the resource-based policy.
\n@param aRN The ARN of the secret retrieved by the resource-based policy.*/", + "setterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -16779,13 +16779,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret retrieved by the resource-based policy.
\n@param aRN The ARN of the secret retrieved by the resource-based policy.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret retrieved by the resource-based policy.
", + "documentation" : "The ARN of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -16794,12 +16794,12 @@ "c2jName" : "Name", "c2jShape" : "NameType", "deprecated" : false, - "documentation" : "The friendly name of the secret retrieved by the resource-based policy.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret retrieved by the resource-based policy.
\n@param name The friendly name of the secret retrieved by the resource-based policy.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret retrieved by the resource-based policy.
\n@return The friendly name of the secret retrieved by the resource-based policy.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -16833,7 +16833,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret retrieved by the resource-based policy.
\n@param name The friendly name of the secret retrieved by the resource-based policy.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -16848,13 +16848,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret retrieved by the resource-based policy.
\n@param name The friendly name of the secret retrieved by the resource-based policy.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret retrieved by the resource-based policy.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -16865,12 +16865,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "The ARN of the secret retrieved by the resource-based policy.
", + "documentation" : "The ARN of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret retrieved by the resource-based policy.
\n@param aRN The ARN of the secret retrieved by the resource-based policy.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret retrieved by the resource-based policy.
\n@return The ARN of the secret retrieved by the resource-based policy.*/", + "getterDocumentation" : "/**The ARN of the secret.
\n@return The ARN of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -16904,7 +16904,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret retrieved by the resource-based policy.
\n@param aRN The ARN of the secret retrieved by the resource-based policy.*/", + "setterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -16919,13 +16919,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret retrieved by the resource-based policy.
\n@param aRN The ARN of the secret retrieved by the resource-based policy.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret.
\n@param aRN The ARN of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret retrieved by the resource-based policy.
", + "documentation" : "The ARN of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -16935,12 +16935,12 @@ "c2jName" : "Name", "c2jShape" : "NameType", "deprecated" : false, - "documentation" : "The friendly name of the secret retrieved by the resource-based policy.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret retrieved by the resource-based policy.
\n@param name The friendly name of the secret retrieved by the resource-based policy.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret retrieved by the resource-based policy.
\n@return The friendly name of the secret retrieved by the resource-based policy.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -16974,7 +16974,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret retrieved by the resource-based policy.
\n@param name The friendly name of the secret retrieved by the resource-based policy.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -16989,13 +16989,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret retrieved by the resource-based policy.
\n@param name The friendly name of the secret retrieved by the resource-based policy.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret retrieved by the resource-based policy.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -17055,12 +17055,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withSecretId",
- "getterDocumentation" : "/**
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.*/",
"getterMethodName" : "getSecretId",
"getterModel" : {
"returnType" : "String",
@@ -17094,7 +17094,7 @@
"marshallingType" : "STRING",
"name" : "SecretId",
"sensitive" : false,
- "setterDocumentation" : "/**
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.*/",
"setterMethodName" : "setSecretId",
"setterModel" : {
"timestampFormat" : null,
@@ -17109,13 +17109,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "secretId",
"variableType" : "String",
- "documentation" : "
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withClientRequestToken",
- "getterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.*/",
+ "getterDocumentation" : "/**
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.*/",
"getterMethodName" : "getClientRequestToken",
"getterModel" : {
"returnType" : "String",
@@ -17163,7 +17163,7 @@
"marshallingType" : "STRING",
"name" : "ClientRequestToken",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.*/",
+ "setterDocumentation" : "/**
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.*/",
"setterMethodName" : "setClientRequestToken",
"setterModel" : {
"timestampFormat" : null,
@@ -17178,13 +17178,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "clientRequestToken",
"variableType" : "String",
- "documentation" : "
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretBinary", - "getterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console.
*/", + "getterDocumentation" : "/**The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.*/", "getterMethodName" : "getSecretBinary", "getterModel" : { "returnType" : "java.nio.ByteBuffer", @@ -17232,7 +17232,7 @@ "marshallingType" : "BYTE_BUFFER", "name" : "SecretBinary", "sensitive" : true, - "setterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console.
*/", + "setterDocumentation" : "/**The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.*/", "setterMethodName" : "setSecretBinary", "setterModel" : { "timestampFormat" : null, @@ -17247,13 +17247,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
\n@param secretBinary The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.nio.ByteBuffer", "variableName" : "secretBinary", "variableType" : "java.nio.ByteBuffer", - "documentation" : "
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
", "simpleType" : "ByteBuffer", "variableSetterType" : "java.nio.ByteBuffer" }, @@ -17262,12 +17262,12 @@ "c2jName" : "SecretString", "c2jShape" : "SecretStringType", "deprecated" : false, - "documentation" : "(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. EitherSecretString
or SecretBinary
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
\n@param secretString The text to encrypt and store in the new version of the secret.You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretString", - "getterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. EitherSecretString
or SecretBinary
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
\n@return The text to encrypt and store in the new version of the secret.You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.*/", "getterMethodName" : "getSecretString", "getterModel" : { "returnType" : "String", @@ -17301,7 +17301,7 @@ "marshallingType" : "STRING", "name" : "SecretString", "sensitive" : true, - "setterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. EitherSecretString
or SecretBinary
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
\n@param secretString The text to encrypt and store in the new version of the secret.You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.*/", "setterMethodName" : "setSecretString", "setterModel" : { "timestampFormat" : null, @@ -17316,13 +17316,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. EitherSecretString
or SecretBinary
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
\n@param secretString The text to encrypt and store in the new version of the secret.You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretString", "variableType" : "String", - "documentation" : "
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -17331,12 +17331,12 @@ "c2jName" : "VersionStages", "c2jShape" : "SecretVersionStagesType", "deprecated" : false, - "documentation" : "(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withVersionStages",
- "getterDocumentation" : "/**
(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.*/",
+ "getterDocumentation" : "/**
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value for VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.*/",
"getterMethodName" : "getVersionStages",
"getterModel" : {
"returnType" : "java.util.ListVersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.*/",
+ "setterDocumentation" : "/**
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.*/",
"setterMethodName" : "setVersionStages",
"setterModel" : {
"timestampFormat" : null,
@@ -17469,13 +17469,13 @@
"shouldFullyQualify" : false,
"simple" : false,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
NOTE: This method appends the values to the existing list (if any). Use {@link #setVersionStages(java.util.Collection)} or {@link #withVersionStages(java.util.Collection)} if you want to override the existing values.
\n@param versionStages (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
NOTE: This method appends the values to the existing list (if any). Use {@link #setVersionStages(java.util.Collection)} or {@link #withVersionStages(java.util.Collection)} if you want to override the existing values.
\n@param versionStages A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value for A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process. If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify If you don't include (Optional) Specifies a unique identifier for the new version of the secret. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret. If the If a version with this value already exists and that version's If a version with this value already exists and the version of the This value becomes the A unique identifier for the new version of the secret. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret. If the If a version with this value already exists and that version's If a version with this value already exists and the version of the This value becomes the (Optional) Specifies a unique identifier for the new version of the secret. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret. If the If a version with this value already exists and that version's If a version with this value already exists and the version of the This value becomes the VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.ListVersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.ClientRequestToken
yourself for new versions and include that value in the request.
ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created. SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent). SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.VersionId
of the new version.ClientRequestToken
yourself for new versions and include that value in the request.
ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created. SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent. SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.VersionId
of the new version.ClientRequestToken
yourself for new versions and include that value in the request.
ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created. SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent). SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withClientRequestToken",
- "getterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.*/",
+ "getterDocumentation" : "/**
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.*/",
"getterMethodName" : "getClientRequestToken",
"getterModel" : {
"returnType" : "String",
@@ -17525,7 +17525,7 @@
"marshallingType" : "STRING",
"name" : "ClientRequestToken",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.*/",
+ "setterDocumentation" : "/**
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.*/",
"setterMethodName" : "setClientRequestToken",
"setterModel" : {
"timestampFormat" : null,
@@ -17540,13 +17540,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "clientRequestToken",
"variableType" : "String",
- "documentation" : "
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretBinary", - "getterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console.
*/", + "getterDocumentation" : "/**The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.*/", "getterMethodName" : "getSecretBinary", "getterModel" : { "returnType" : "java.nio.ByteBuffer", @@ -17595,7 +17595,7 @@ "marshallingType" : "BYTE_BUFFER", "name" : "SecretBinary", "sensitive" : true, - "setterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console.
*/", + "setterDocumentation" : "/**The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.*/", "setterMethodName" : "setSecretBinary", "setterModel" : { "timestampFormat" : null, @@ -17610,13 +17610,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\n@param secretBinary (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible if the secret using the Secrets Manager console.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
\n@param secretBinary The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.nio.ByteBuffer", "variableName" : "secretBinary", "variableType" : "java.nio.ByteBuffer", - "documentation" : "
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
", "simpleType" : "ByteBuffer", "variableSetterType" : "java.nio.ByteBuffer" }, @@ -17626,12 +17626,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withSecretId",
- "getterDocumentation" : "/**
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.*/",
"getterMethodName" : "getSecretId",
"getterModel" : {
"returnType" : "String",
@@ -17665,7 +17665,7 @@
"marshallingType" : "STRING",
"name" : "SecretId",
"sensitive" : false,
- "setterDocumentation" : "/**
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.*/",
"setterMethodName" : "setSecretId",
"setterModel" : {
"timestampFormat" : null,
@@ -17680,13 +17680,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "secretId",
"variableType" : "String",
- "documentation" : "
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. EitherSecretString
or SecretBinary
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
\n@param secretString The text to encrypt and store in the new version of the secret.You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretString", - "getterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. EitherSecretString
or SecretBinary
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
\n@return The text to encrypt and store in the new version of the secret.You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.*/", "getterMethodName" : "getSecretString", "getterModel" : { "returnType" : "String", @@ -17735,7 +17735,7 @@ "marshallingType" : "STRING", "name" : "SecretString", "sensitive" : true, - "setterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. EitherSecretString
or SecretBinary
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
\n@param secretString The text to encrypt and store in the new version of the secret.You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.*/", "setterMethodName" : "setSecretString", "setterModel" : { "timestampFormat" : null, @@ -17750,13 +17750,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. EitherSecretString
or SecretBinary
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
\n@param secretString The text to encrypt and store in the new version of the secret.You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretString", "variableType" : "String", - "documentation" : "
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -17766,12 +17766,12 @@ "c2jName" : "VersionStages", "c2jShape" : "SecretVersionStagesType", "deprecated" : false, - "documentation" : "(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withVersionStages",
- "getterDocumentation" : "/**
(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.*/",
+ "getterDocumentation" : "/**
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value for VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.*/",
"getterMethodName" : "getVersionStages",
"getterModel" : {
"returnType" : "java.util.ListVersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.*/",
+ "setterDocumentation" : "/**
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.*/",
"setterMethodName" : "setVersionStages",
"setterModel" : {
"timestampFormat" : null,
@@ -17904,13 +17904,13 @@
"shouldFullyQualify" : false,
"simple" : false,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
NOTE: This method appends the values to the existing list (if any). Use {@link #setVersionStages(java.util.Collection)} or {@link #withVersionStages(java.util.Collection)} if you want to override the existing values.
\n@param versionStages (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
NOTE: This method appends the values to the existing list (if any). Use {@link #setVersionStages(java.util.Collection)} or {@link #withVersionStages(java.util.Collection)} if you want to override the existing values.
\n@param versionStages A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value for A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process. If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify If you don't include The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. NOTE: This method appends the values to the existing list (if any). Use {@link #setVersionStages(java.util.Collection)} or {@link #withVersionStages(java.util.Collection)} if you want to override the existing values. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. NOTE: This method appends the values to the existing list (if any). Use {@link #setVersionStages(java.util.Collection)} or {@link #withVersionStages(java.util.Collection)} if you want to override the existing values. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The Amazon Resource Name (ARN) for the secret for which you just created a version. The ARN of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The friendly name of the secret for which you just created or updated a version. The name of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The unique identifier of the version of the secret you just created or updated. The unique identifier of the version of the secret. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. NOTE: This method appends the values to the existing list (if any). Use {@link #setVersionStages(java.util.Collection)} or {@link #withVersionStages(java.util.Collection)} if you want to override the existing values. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. NOTE: This method appends the values to the existing list (if any). Use {@link #setVersionStages(java.util.Collection)} or {@link #withVersionStages(java.util.Collection)} if you want to override the existing values. The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process. The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. NOTE: This method appends the values to the existing list (if any). Use {@link #setRemoveReplicaRegions(java.util.Collection)} or {@link #withRemoveReplicaRegions(java.util.Collection)} if you want to override the existing values. The Regions of the replicas to remove. NOTE: This method appends the values to the existing list (if any). Use {@link #setRemoveReplicaRegions(java.util.Collection)} or {@link #withRemoveReplicaRegions(java.util.Collection)} if you want to override the existing values. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. The Regions of the replicas to remove. Remove replication from specific Regions. NOTE: This method appends the values to the existing list (if any). Use {@link #setRemoveReplicaRegions(java.util.Collection)} or {@link #withRemoveReplicaRegions(java.util.Collection)} if you want to override the existing values. The Regions of the replicas to remove. NOTE: This method appends the values to the existing list (if any). Use {@link #setRemoveReplicaRegions(java.util.Collection)} or {@link #withRemoveReplicaRegions(java.util.Collection)} if you want to override the existing values. Remove replication from specific Regions. The Regions of the replicas to remove. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. Remove a secret by The ARN or name of the secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. Describes the remaining replication status after you remove regions from the replication list. NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values. The status of replicas for this secret after you remove Regions. NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. The secret The ARN of the primary secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. The secret The ARN of the primary secret. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. Describes the remaining replication status after you remove regions from the replication list. NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values. The status of replicas for this secret after you remove Regions. NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values. Describes the remaining replication status after you remove regions from the replication list. The status of replicas for this secret after you remove Regions. (Optional) Custom type consisting of a A custom type that specifies a Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Can be an The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Describes a single instance of Region objects. A Region code. For a list of Region codes, see Name and code of Regions. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. Add Regions to replicate the secret. NOTE: This method appends the values to the existing list (if any). Use {@link #setAddReplicaRegions(java.util.Collection)} or {@link #withAddReplicaRegions(java.util.Collection)} if you want to override the existing values. A list of Regions in which to replicate the secret. NOTE: This method appends the values to the existing list (if any). Use {@link #setAddReplicaRegions(java.util.Collection)} or {@link #withAddReplicaRegions(java.util.Collection)} if you want to override the existing values. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. Add Regions to replicate the secret. NOTE: This method appends the values to the existing list (if any). Use {@link #setAddReplicaRegions(java.util.Collection)} or {@link #withAddReplicaRegions(java.util.Collection)} if you want to override the existing values. A list of Regions in which to replicate the secret. NOTE: This method appends the values to the existing list (if any). Use {@link #setAddReplicaRegions(java.util.Collection)} or {@link #withAddReplicaRegions(java.util.Collection)} if you want to override the existing values. Add Regions to replicate the secret. A list of Regions in which to replicate the secret. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. Specifies whether to overwrite a secret with the same name in the destination Region. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Use the The ARN or name of the secret to replicate. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Describes the secret replication status as The status of replication. Describes the secret replication status as The status of replication. Describes the secret replication status as The status of replication. Describes the secret replication status as The status of replication. Describes the secret replication status as NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values. The status of replication. NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values. Describes the secret replication status as The status of replication. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Replicate a secret based on the The ARN of the primary secret. Describes the secret replication status as The status of replication. Describes the secret replication status as The status of replication. Describes the secret replication status as The status of replication. Describes the secret replication status as The status of replication. Describes the secret replication status as NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values. The status of replication. NOTE: This method appends the values to the existing list (if any). Use {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if you want to override the existing values. Describes the secret replication status as The status of replication. We can't find the resource that you asked for. Secrets Manager can't find the resource that you asked for. Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. The ARN or name of the secret to restore. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.ListVersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.SecretId
from replica Regions.SecretId
from replica Regions.SecretId
from replica Regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**SecretId
from replica Regions.SecretId
from replica Regions.*/",
+ "getterDocumentation" : "/**SecretId
from replica Regions.SecretId
from replica Regions.*/",
+ "setterDocumentation" : "/**SecretId
from replica Regions.SecretId
from replica Regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**SecretId
from replica Regions.SecretId
from replica Regions.SecretId
from replica Regions.SecretId
from replica Regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**SecretId
from replica Regions.SecretId
from replica Regions.*/",
+ "getterDocumentation" : "/**SecretId
from replica Regions.SecretId
from replica Regions.*/",
+ "setterDocumentation" : "/**SecretId
from replica Regions.SecretId
from replica Regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**SecretId
from replica Regions.ARN
removed from replication regions.ARN
removed from replication regions.ARN
removed from replication regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**ARN
removed from replication regions.ARN
removed from replication regions.*/",
+ "getterDocumentation" : "/**ARN
removed from replication regions.ARN
removed from replication regions.*/",
+ "setterDocumentation" : "/**ARN
removed from replication regions.ARN
removed from replication regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**ARN
removed from replication regions.ARN
removed from replication regions.ARN
removed from replication regions.ARN
removed from replication regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**ARN
removed from replication regions.ARN
removed from replication regions.*/",
+ "getterDocumentation" : "/**ARN
removed from replication regions.ARN
removed from replication regions.*/",
+ "setterDocumentation" : "/**ARN
removed from replication regions.ARN
removed from replication regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**ARN
removed from replication regions.Region
(required) and the KmsKeyId
which can be an ARN
, Key ID
, or Alias
.Region
and the KmsKeyId
for a replica secret.ARN
, Key ID
, or Alias
. aws/secretsmanager
.ARN
, Key ID
, or Alias
. ARN
, Key ID
, or Alias
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**aws/secretsmanager
.aws/secretsmanager
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withKmsKeyId",
- "getterDocumentation" : "/**ARN
, Key ID
, or Alias
. ARN
, Key ID
, or Alias
.*/",
+ "getterDocumentation" : "/**aws/secretsmanager
.aws/secretsmanager
.*/",
"getterMethodName" : "getKmsKeyId",
"getterModel" : {
"returnType" : "String",
@@ -19823,7 +19823,7 @@
"marshallingType" : "STRING",
"name" : "KmsKeyId",
"sensitive" : false,
- "setterDocumentation" : "/**ARN
, Key ID
, or Alias
. ARN
, Key ID
, or Alias
.*/",
+ "setterDocumentation" : "/**aws/secretsmanager
.aws/secretsmanager
.*/",
"setterMethodName" : "setKmsKeyId",
"setterModel" : {
"timestampFormat" : null,
@@ -19838,13 +19838,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**ARN
, Key ID
, or Alias
. ARN
, Key ID
, or Alias
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**aws/secretsmanager
.aws/secretsmanager
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "kmsKeyId",
"variableType" : "String",
- "documentation" : "ARN
, Key ID
, or Alias
. aws/secretsmanager
.ARN
, Key ID
, or Alias
. aws/secretsmanager
.ARN
, Key ID
, or Alias
. ARN
, Key ID
, or Alias
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**aws/secretsmanager
.aws/secretsmanager
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withKmsKeyId",
- "getterDocumentation" : "/**ARN
, Key ID
, or Alias
. ARN
, Key ID
, or Alias
.*/",
+ "getterDocumentation" : "/**aws/secretsmanager
.aws/secretsmanager
.*/",
"getterMethodName" : "getKmsKeyId",
"getterModel" : {
"returnType" : "String",
@@ -19894,7 +19894,7 @@
"marshallingType" : "STRING",
"name" : "KmsKeyId",
"sensitive" : false,
- "setterDocumentation" : "/**ARN
, Key ID
, or Alias
. ARN
, Key ID
, or Alias
.*/",
+ "setterDocumentation" : "/**aws/secretsmanager
.aws/secretsmanager
.*/",
"setterMethodName" : "setKmsKeyId",
"setterModel" : {
"timestampFormat" : null,
@@ -19909,13 +19909,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**ARN
, Key ID
, or Alias
. ARN
, Key ID
, or Alias
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**aws/secretsmanager
.aws/secretsmanager
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "kmsKeyId",
"variableType" : "String",
- "documentation" : "ARN
, Key ID
, or Alias
. aws/secretsmanager
.Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.*/",
+ "getterDocumentation" : "/**Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.*/",
+ "setterDocumentation" : "/**Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.*/",
+ "getterDocumentation" : "/**Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.*/",
+ "setterDocumentation" : "/**Secret Id
to replicate a secret to regions.Secret Id
to replicate a secret to regions.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**Secret Id
to replicate a secret to regions.ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.*/",
+ "getterDocumentation" : "/**ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.*/",
+ "setterDocumentation" : "/**ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.*/",
+ "getterDocumentation" : "/**PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.*/",
+ "setterDocumentation" : "/**PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**PENDING
, SUCCESS
or FAIL
.ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.*/",
+ "getterDocumentation" : "/**ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.*/",
+ "setterDocumentation" : "/**ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.*/",
+ "getterDocumentation" : "/**PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.*/",
+ "setterDocumentation" : "/**PENDING
, SUCCESS
or FAIL
.PENDING
, SUCCESS
or FAIL
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**PENDING
, SUCCESS
or FAIL
.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to restore.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to restore.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -22031,7 +22031,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to restore.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -22046,13 +22046,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to restore.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22063,12 +22063,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to restore.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to restore.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -22102,7 +22102,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to restore.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -22117,13 +22117,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to restore.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22242,12 +22242,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that was restored.
", + "documentation" : "The name of the secret that was restored.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that was restored.
\n@param name The friendly name of the secret that was restored.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that was restored.
\n@param name The name of the secret that was restored.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that was restored.
\n@return The friendly name of the secret that was restored.*/", + "getterDocumentation" : "/**The name of the secret that was restored.
\n@return The name of the secret that was restored.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -22281,7 +22281,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that was restored.
\n@param name The friendly name of the secret that was restored.*/", + "setterDocumentation" : "/**The name of the secret that was restored.
\n@param name The name of the secret that was restored.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -22296,13 +22296,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that was restored.
\n@param name The friendly name of the secret that was restored.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that was restored.
\n@param name The name of the secret that was restored.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that was restored.
", + "documentation" : "The name of the secret that was restored.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22383,12 +22383,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that was restored.
", + "documentation" : "The name of the secret that was restored.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that was restored.
\n@param name The friendly name of the secret that was restored.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that was restored.
\n@param name The name of the secret that was restored.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that was restored.
\n@return The friendly name of the secret that was restored.*/", + "getterDocumentation" : "/**The name of the secret that was restored.
\n@return The name of the secret that was restored.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -22422,7 +22422,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that was restored.
\n@param name The friendly name of the secret that was restored.*/", + "setterDocumentation" : "/**The name of the secret that was restored.
\n@param name The name of the secret that was restored.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -22437,13 +22437,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that was restored.
\n@param name The friendly name of the secret that was restored.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that was restored.
\n@param name The name of the secret that was restored.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that was restored.
", + "documentation" : "The name of the secret that was restored.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22503,12 +22503,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -22542,7 +22542,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -22557,13 +22557,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22572,12 +22572,12 @@ "c2jName" : "ClientRequestToken", "c2jShape" : "ClientRequestTokenType", "deprecated" : false, - "documentation" : "(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
\n@param clientRequestToken A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes theVersionId
of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withClientRequestToken", - "getterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.*/",
+ "getterDocumentation" : "/**
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
\n@return A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes theVersionId
of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.*/", "getterMethodName" : "getClientRequestToken", "getterModel" : { "returnType" : "String", @@ -22611,7 +22611,7 @@ "marshallingType" : "STRING", "name" : "ClientRequestToken", "sensitive" : false, - "setterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.*/",
+ "setterDocumentation" : "/**
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
\n@param clientRequestToken A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes theVersionId
of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.*/", "setterMethodName" : "setClientRequestToken", "setterModel" : { "timestampFormat" : null, @@ -22626,13 +22626,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
\n@param clientRequestToken A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes theVersionId
of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "clientRequestToken", "variableType" : "String", - "documentation" : "
(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22641,12 +22641,12 @@ "c2jName" : "RotationLambdaARN", "c2jShape" : "RotationLambdaARNType", "deprecated" : false, - "documentation" : "(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
", + "documentation" : "The ARN of the Lambda rotation function that can rotate the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
\n@param rotationLambdaARN (Optional) Specifies the ARN of the Lambda function that can rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the Lambda rotation function that can rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda rotation function that can rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRotationLambdaARN", - "getterDocumentation" : "/**(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
\n@return (Optional) Specifies the ARN of the Lambda function that can rotate the secret.*/", + "getterDocumentation" : "/**The ARN of the Lambda rotation function that can rotate the secret.
\n@return The ARN of the Lambda rotation function that can rotate the secret.*/", "getterMethodName" : "getRotationLambdaARN", "getterModel" : { "returnType" : "String", @@ -22680,7 +22680,7 @@ "marshallingType" : "STRING", "name" : "RotationLambdaARN", "sensitive" : false, - "setterDocumentation" : "/**(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
\n@param rotationLambdaARN (Optional) Specifies the ARN of the Lambda function that can rotate the secret.*/", + "setterDocumentation" : "/**The ARN of the Lambda rotation function that can rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda rotation function that can rotate the secret.*/", "setterMethodName" : "setRotationLambdaARN", "setterModel" : { "timestampFormat" : null, @@ -22695,13 +22695,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
\n@param rotationLambdaARN (Optional) Specifies the ARN of the Lambda function that can rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the Lambda rotation function that can rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda rotation function that can rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "rotationLambdaARN", "variableType" : "String", - "documentation" : "(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
", + "documentation" : "The ARN of the Lambda rotation function that can rotate the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22781,12 +22781,12 @@ "c2jName" : "ClientRequestToken", "c2jShape" : "ClientRequestTokenType", "deprecated" : false, - "documentation" : "(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
\n@param clientRequestToken A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes theVersionId
of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withClientRequestToken", - "getterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.*/",
+ "getterDocumentation" : "/**
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
\n@return A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes theVersionId
of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.*/", "getterMethodName" : "getClientRequestToken", "getterModel" : { "returnType" : "String", @@ -22820,7 +22820,7 @@ "marshallingType" : "STRING", "name" : "ClientRequestToken", "sensitive" : false, - "setterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.*/",
+ "setterDocumentation" : "/**
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
\n@param clientRequestToken A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes theVersionId
of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.*/", "setterMethodName" : "setClientRequestToken", "setterModel" : { "timestampFormat" : null, @@ -22835,13 +22835,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
\n@param clientRequestToken A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes theVersionId
of the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "clientRequestToken", "variableType" : "String", - "documentation" : "
(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22851,12 +22851,12 @@ "c2jName" : "RotationLambdaARN", "c2jShape" : "RotationLambdaARNType", "deprecated" : false, - "documentation" : "(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
", + "documentation" : "The ARN of the Lambda rotation function that can rotate the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
\n@param rotationLambdaARN (Optional) Specifies the ARN of the Lambda function that can rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the Lambda rotation function that can rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda rotation function that can rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRotationLambdaARN", - "getterDocumentation" : "/**(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
\n@return (Optional) Specifies the ARN of the Lambda function that can rotate the secret.*/", + "getterDocumentation" : "/**The ARN of the Lambda rotation function that can rotate the secret.
\n@return The ARN of the Lambda rotation function that can rotate the secret.*/", "getterMethodName" : "getRotationLambdaARN", "getterModel" : { "returnType" : "String", @@ -22890,7 +22890,7 @@ "marshallingType" : "STRING", "name" : "RotationLambdaARN", "sensitive" : false, - "setterDocumentation" : "/**(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
\n@param rotationLambdaARN (Optional) Specifies the ARN of the Lambda function that can rotate the secret.*/", + "setterDocumentation" : "/**The ARN of the Lambda rotation function that can rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda rotation function that can rotate the secret.*/", "setterMethodName" : "setRotationLambdaARN", "setterModel" : { "timestampFormat" : null, @@ -22905,13 +22905,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
\n@param rotationLambdaARN (Optional) Specifies the ARN of the Lambda function that can rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the Lambda rotation function that can rotate the secret.
\n@param rotationLambdaARN The ARN of the Lambda rotation function that can rotate the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "rotationLambdaARN", "variableType" : "String", - "documentation" : "(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
", + "documentation" : "The ARN of the Lambda rotation function that can rotate the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -22991,12 +22991,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -23030,7 +23030,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -23045,13 +23045,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret to rotate.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -23170,12 +23170,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret.
\n@return The friendly name of the secret.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -23209,7 +23209,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -23224,13 +23224,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -23239,12 +23239,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "The ID of the new version of the secret created by the rotation started by this request.
", + "documentation" : "The ID of the new version of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ID of the new version of the secret created by the rotation started by this request.
\n@param versionId The ID of the new version of the secret created by the rotation started by this request.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ID of the new version of the secret.
\n@param versionId The ID of the new version of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersionId", - "getterDocumentation" : "/**The ID of the new version of the secret created by the rotation started by this request.
\n@return The ID of the new version of the secret created by the rotation started by this request.*/", + "getterDocumentation" : "/**The ID of the new version of the secret.
\n@return The ID of the new version of the secret.*/", "getterMethodName" : "getVersionId", "getterModel" : { "returnType" : "String", @@ -23278,7 +23278,7 @@ "marshallingType" : "STRING", "name" : "VersionId", "sensitive" : false, - "setterDocumentation" : "/**The ID of the new version of the secret created by the rotation started by this request.
\n@param versionId The ID of the new version of the secret created by the rotation started by this request.*/", + "setterDocumentation" : "/**The ID of the new version of the secret.
\n@param versionId The ID of the new version of the secret.*/", "setterMethodName" : "setVersionId", "setterModel" : { "timestampFormat" : null, @@ -23293,13 +23293,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ID of the new version of the secret created by the rotation started by this request.
\n@param versionId The ID of the new version of the secret created by the rotation started by this request.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ID of the new version of the secret.
\n@param versionId The ID of the new version of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "versionId", "variableType" : "String", - "documentation" : "The ID of the new version of the secret created by the rotation started by this request.
", + "documentation" : "The ID of the new version of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -23380,12 +23380,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret.
", + "documentation" : "The name of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret.
\n@return The friendly name of the secret.*/", + "getterDocumentation" : "/**The name of the secret.
\n@return The name of the secret.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -23419,7 +23419,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.*/", + "setterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -23434,13 +23434,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret.
\n@param name The friendly name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret.
\n@param name The name of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret.
", + "documentation" : "The name of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -23450,12 +23450,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "The ID of the new version of the secret created by the rotation started by this request.
", + "documentation" : "The ID of the new version of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ID of the new version of the secret created by the rotation started by this request.
\n@param versionId The ID of the new version of the secret created by the rotation started by this request.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ID of the new version of the secret.
\n@param versionId The ID of the new version of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withVersionId", - "getterDocumentation" : "/**The ID of the new version of the secret created by the rotation started by this request.
\n@return The ID of the new version of the secret created by the rotation started by this request.*/", + "getterDocumentation" : "/**The ID of the new version of the secret.
\n@return The ID of the new version of the secret.*/", "getterMethodName" : "getVersionId", "getterModel" : { "returnType" : "String", @@ -23489,7 +23489,7 @@ "marshallingType" : "STRING", "name" : "VersionId", "sensitive" : false, - "setterDocumentation" : "/**The ID of the new version of the secret created by the rotation started by this request.
\n@param versionId The ID of the new version of the secret created by the rotation started by this request.*/", + "setterDocumentation" : "/**The ID of the new version of the secret.
\n@param versionId The ID of the new version of the secret.*/", "setterMethodName" : "setVersionId", "setterModel" : { "timestampFormat" : null, @@ -23504,13 +23504,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ID of the new version of the secret created by the rotation started by this request.
\n@param versionId The ID of the new version of the secret created by the rotation started by this request.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ID of the new version of the secret.
\n@param versionId The ID of the new version of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "versionId", "variableType" : "String", - "documentation" : "The ID of the new version of the secret created by the rotation started by this request.
", + "documentation" : "The ID of the new version of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -23747,12 +23747,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
", + "documentation" : "The Amazon Resource Name (ARN) of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
\n@param aRN The Amazon Resource Name (ARN) of the secret.For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The Amazon Resource Name (ARN) of the secret.
\n@param aRN The Amazon Resource Name (ARN) of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
\n@return The Amazon Resource Name (ARN) of the secret.For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.*/", + "getterDocumentation" : "/**
The Amazon Resource Name (ARN) of the secret.
\n@return The Amazon Resource Name (ARN) of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -23786,7 +23786,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
\n@param aRN The Amazon Resource Name (ARN) of the secret.For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.*/", + "setterDocumentation" : "/**
The Amazon Resource Name (ARN) of the secret.
\n@param aRN The Amazon Resource Name (ARN) of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -23801,13 +23801,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
\n@param aRN The Amazon Resource Name (ARN) of the secret.For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The Amazon Resource Name (ARN) of the secret.
\n@param aRN The Amazon Resource Name (ARN) of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
", + "documentation" : "The Amazon Resource Name (ARN) of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -23954,12 +23954,12 @@ "c2jName" : "KmsKeyId", "c2jShape" : "KmsKeyIdType", "deprecated" : false, - "documentation" : "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withKmsKeyId",
- "getterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.*/",
+ "getterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.*/",
"getterMethodName" : "getKmsKeyId",
"getterModel" : {
"returnType" : "String",
@@ -23993,7 +23993,7 @@
"marshallingType" : "STRING",
"name" : "KmsKeyId",
"sensitive" : false,
- "setterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.*/",
+ "setterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.*/",
"setterMethodName" : "setKmsKeyId",
"setterModel" : {
"timestampFormat" : null,
@@ -24008,13 +24008,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "kmsKeyId",
"variableType" : "String",
- "documentation" : "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
", + "documentation" : "The Amazon Resource Name (ARN) of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
\n@param aRN The Amazon Resource Name (ARN) of the secret.For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The Amazon Resource Name (ARN) of the secret.
\n@param aRN The Amazon Resource Name (ARN) of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
\n@return The Amazon Resource Name (ARN) of the secret.For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.*/", + "getterDocumentation" : "/**
The Amazon Resource Name (ARN) of the secret.
\n@return The Amazon Resource Name (ARN) of the secret.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -25144,7 +25144,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
\n@param aRN The Amazon Resource Name (ARN) of the secret.For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.*/", + "setterDocumentation" : "/**
The Amazon Resource Name (ARN) of the secret.
\n@param aRN The Amazon Resource Name (ARN) of the secret.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -25159,13 +25159,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
\n@param aRN The Amazon Resource Name (ARN) of the secret.For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The Amazon Resource Name (ARN) of the secret.
\n@param aRN The Amazon Resource Name (ARN) of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
", + "documentation" : "The Amazon Resource Name (ARN) of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -25385,12 +25385,12 @@ "c2jName" : "KmsKeyId", "c2jShape" : "KmsKeyIdType", "deprecated" : false, - "documentation" : "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withKmsKeyId",
- "getterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.*/",
+ "getterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.*/",
"getterMethodName" : "getKmsKeyId",
"getterModel" : {
"returnType" : "String",
@@ -25424,7 +25424,7 @@
"marshallingType" : "STRING",
"name" : "KmsKeyId",
"sensitive" : false,
- "setterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.*/",
+ "setterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.*/",
"setterMethodName" : "setKmsKeyId",
"setterModel" : {
"timestampFormat" : null,
@@ -25439,13 +25439,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
aws/secretsmanager
, this field is omitted.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "kmsKeyId",
"variableType" : "String",
- "documentation" : "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
Response to StopReplicationToReplica
of a secret, based on the SecretId
.
The ARN of the primary secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Response to StopReplicationToReplica
of a secret, based on the SecretId
.
StopReplicationToReplica
of a secret, based on the SecretId
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the primary secret.
\n@param secretId The ARN of the primary secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**Response to StopReplicationToReplica
of a secret, based on the SecretId
.
StopReplicationToReplica
of a secret, based on the SecretId
.*/",
+ "getterDocumentation" : "/**The ARN of the primary secret.
\n@return The ARN of the primary secret.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -27745,7 +27745,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**Response to StopReplicationToReplica
of a secret, based on the SecretId
.
StopReplicationToReplica
of a secret, based on the SecretId
.*/",
+ "setterDocumentation" : "/**The ARN of the primary secret.
\n@param secretId The ARN of the primary secret.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -27760,13 +27760,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Response to StopReplicationToReplica
of a secret, based on the SecretId
.
StopReplicationToReplica
of a secret, based on the SecretId
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the primary secret.
\n@param secretId The ARN of the primary secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "Response to StopReplicationToReplica
of a secret, based on the SecretId
.
The ARN of the primary secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -27777,12 +27777,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Response to StopReplicationToReplica
of a secret, based on the SecretId
.
The ARN of the primary secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Response to StopReplicationToReplica
of a secret, based on the SecretId
.
StopReplicationToReplica
of a secret, based on the SecretId
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the primary secret.
\n@param secretId The ARN of the primary secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**Response to StopReplicationToReplica
of a secret, based on the SecretId
.
StopReplicationToReplica
of a secret, based on the SecretId
.*/",
+ "getterDocumentation" : "/**The ARN of the primary secret.
\n@return The ARN of the primary secret.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -27816,7 +27816,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**Response to StopReplicationToReplica
of a secret, based on the SecretId
.
StopReplicationToReplica
of a secret, based on the SecretId
.*/",
+ "setterDocumentation" : "/**The ARN of the primary secret.
\n@param secretId The ARN of the primary secret.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -27831,13 +27831,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Response to StopReplicationToReplica
of a secret, based on the SecretId
.
StopReplicationToReplica
of a secret, based on the SecretId
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the primary secret.
\n@param secretId The ARN of the primary secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "Response to StopReplicationToReplica
of a secret, based on the SecretId
.
The ARN of the primary secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -27887,12 +27887,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "Response StopReplicationToReplica
of a secret, based on the ARN,
.
The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Response StopReplicationToReplica
of a secret, based on the ARN,
.
StopReplicationToReplica
of a secret, based on the ARN,
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
\n@param aRN The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**Response StopReplicationToReplica
of a secret, based on the ARN,
.
StopReplicationToReplica
of a secret, based on the ARN,
.*/",
+ "getterDocumentation" : "/**The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
\n@return The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -27926,7 +27926,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**Response StopReplicationToReplica
of a secret, based on the ARN,
.
StopReplicationToReplica
of a secret, based on the ARN,
.*/",
+ "setterDocumentation" : "/**The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
\n@param aRN The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -27941,13 +27941,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Response StopReplicationToReplica
of a secret, based on the ARN,
.
StopReplicationToReplica
of a secret, based on the ARN,
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
\n@param aRN The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "Response StopReplicationToReplica
of a secret, based on the ARN,
.
The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -27958,12 +27958,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "Response StopReplicationToReplica
of a secret, based on the ARN,
.
The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Response StopReplicationToReplica
of a secret, based on the ARN,
.
StopReplicationToReplica
of a secret, based on the ARN,
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
\n@param aRN The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**Response StopReplicationToReplica
of a secret, based on the ARN,
.
StopReplicationToReplica
of a secret, based on the ARN,
.*/",
+ "getterDocumentation" : "/**The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
\n@return The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -27997,7 +27997,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**Response StopReplicationToReplica
of a secret, based on the ARN,
.
StopReplicationToReplica
of a secret, based on the ARN,
.*/",
+ "setterDocumentation" : "/**The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
\n@param aRN The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -28012,13 +28012,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Response StopReplicationToReplica
of a secret, based on the ARN,
.
StopReplicationToReplica
of a secret, based on the ARN,
.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
\n@param aRN The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "Response StopReplicationToReplica
of a secret, based on the ARN,
.
The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -28401,12 +28401,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -28440,7 +28440,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -28455,13 +28455,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -28470,12 +28470,12 @@ "c2jName" : "Tags", "c2jShape" : "TagListType", "deprecated" : false, - "documentation" : "The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tags The tags to attach to the secret. Each element in the list consists of aKey
and a Value
. This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tags The tags to attach to the secret as a JSON text string argument. Each element in the list consists of aKey
and a Value
. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withTags", - "getterDocumentation" : "/**
The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return The tags to attach to the secret. Each element in the list consists of aKey
and a Value
. This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return The tags to attach to the secret as a JSON text string argument. Each element in the list consists of aKey
and a Value
. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/",
"getterMethodName" : "getTags",
"getterModel" : {
"returnType" : "java.util.List The tags to attach to the secret. Each element in the list consists of a This parameter to the API requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.Key
and a Value
.Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tags The tags to attach to the secret as a JSON text string argument. Each element in the list consists of aKey
and a Value
. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", "setterMethodName" : "setTags", "setterModel" : { "timestampFormat" : null, @@ -28608,13 +28608,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags The tags to attach to the secret. Each element in the list consists of aKey
and a Value
. This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags The tags to attach to the secret as a JSON text string argument. Each element in the list consists of aKey
and a Value
. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.List The tags to attach to the secret. Each element in the list consists of a This parameter to the API requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.Key
and a Value
.Key
and a Value
.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -28664,7 +28664,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -28679,13 +28679,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -28695,12 +28695,12 @@ "c2jName" : "Tags", "c2jShape" : "TagListType", "deprecated" : false, - "documentation" : "The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tags The tags to attach to the secret. Each element in the list consists of aKey
and a Value
. This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tags The tags to attach to the secret as a JSON text string argument. Each element in the list consists of aKey
and a Value
. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withTags", - "getterDocumentation" : "/**
The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return The tags to attach to the secret. Each element in the list consists of aKey
and a Value
. This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return The tags to attach to the secret as a JSON text string argument. Each element in the list consists of aKey
and a Value
. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/",
"getterMethodName" : "getTags",
"getterModel" : {
"returnType" : "java.util.List The tags to attach to the secret. Each element in the list consists of a This parameter to the API requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.Key
and a Value
.Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tags The tags to attach to the secret as a JSON text string argument. Each element in the list consists of aKey
and a Value
. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", "setterMethodName" : "setTags", "setterModel" : { "timestampFormat" : null, @@ -28833,13 +28833,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags The tags to attach to the secret. Each element in the list consists of aKey
and a Value
. This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the existing values.
\n@param tags The tags to attach to the secret as a JSON text string argument. Each element in the list consists of aKey
and a Value
. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.List The tags to attach to the secret. Each element in the list consists of a This parameter to the API requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. The ARN or name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.Key
and a Value
.Key
and a Value
.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -28979,7 +28979,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -28994,13 +28994,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -29009,12 +29009,12 @@ "c2jName" : "TagKeys", "c2jShape" : "TagKeyListType", "deprecated" : false, - "documentation" : "A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withTagKeys", - "getterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/",
"getterMethodName" : "getTagKeys",
"getterModel" : {
"returnType" : "java.util.List A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter to the API requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", "setterMethodName" : "setTagKeys", "setterModel" : { "timestampFormat" : null, @@ -29147,13 +29147,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTagKeys(java.util.Collection)} or {@link #withTagKeys(java.util.Collection)} if you want to override the existing values.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTagKeys(java.util.Collection)} or {@link #withTagKeys(java.util.Collection)} if you want to override the existing values.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.List A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter to the API requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. The ARN or name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -29203,7 +29203,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -29218,13 +29218,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -29234,12 +29234,12 @@ "c2jName" : "TagKeys", "c2jShape" : "TagKeyListType", "deprecated" : false, - "documentation" : "A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withTagKeys", - "getterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/",
"getterMethodName" : "getTagKeys",
"getterModel" : {
"returnType" : "java.util.List A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter to the API requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", "setterMethodName" : "setTagKeys", "setterModel" : { "timestampFormat" : null, @@ -29372,13 +29372,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTagKeys(java.util.Collection)} or {@link #withTagKeys(java.util.Collection)} if you want to override the existing values.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setTagKeys(java.util.Collection)} or {@link #withTagKeys(java.util.Collection)} if you want to override the existing values.
\n@param tagKeys A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "java.util.List A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter to the API requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed. This parameter requires a JSON text string argument. For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. The ARN or name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -29518,7 +29518,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -29533,13 +29533,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -29548,12 +29548,12 @@ "c2jName" : "ClientRequestToken", "c2jShape" : "ClientRequestTokenType", "deprecated" : false, - "documentation" : "(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withClientRequestToken",
- "getterDocumentation" : "/**
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.*/",
+ "getterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.*/",
"getterMethodName" : "getClientRequestToken",
"getterModel" : {
"returnType" : "String",
@@ -29587,7 +29587,7 @@
"marshallingType" : "STRING",
"name" : "ClientRequestToken",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.*/",
+ "setterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.*/",
"setterMethodName" : "setClientRequestToken",
"setterModel" : {
"timestampFormat" : null,
@@ -29602,13 +29602,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "clientRequestToken",
"variableType" : "String",
- "documentation" : "
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
(Optional) Specifies an updated user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies an updated user-provided description of the secret.
\n@param description (Optional) Specifies an updated user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withDescription", - "getterDocumentation" : "/**(Optional) Specifies an updated user-provided description of the secret.
\n@return (Optional) Specifies an updated user-provided description of the secret.*/", + "getterDocumentation" : "/**The description of the secret.
\n@return The description of the secret.*/", "getterMethodName" : "getDescription", "getterModel" : { "returnType" : "String", @@ -29656,7 +29656,7 @@ "marshallingType" : "STRING", "name" : "Description", "sensitive" : false, - "setterDocumentation" : "/**(Optional) Specifies an updated user-provided description of the secret.
\n@param description (Optional) Specifies an updated user-provided description of the secret.*/", + "setterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.*/", "setterMethodName" : "setDescription", "setterModel" : { "timestampFormat" : null, @@ -29671,13 +29671,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Specifies an updated user-provided description of the secret.
\n@param description (Optional) Specifies an updated user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "description", "variableType" : "String", - "documentation" : "(Optional) Specifies an updated user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -29686,12 +29686,12 @@ "c2jName" : "KmsKeyId", "c2jShape" : "KmsKeyIdType", "deprecated" : false, - "documentation" : "(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
*/", + "getterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
*/", + "setterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretBinary", - "getterDocumentation" : "/**
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console.*/", + "getterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.*/", "getterMethodName" : "getSecretBinary", "getterModel" : { "returnType" : "java.nio.ByteBuffer", @@ -29794,7 +29794,7 @@ "marshallingType" : "BYTE_BUFFER", "name" : "SecretBinary", "sensitive" : true, - "setterDocumentation" : "/**
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console.*/", + "setterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.*/", "setterMethodName" : "setSecretBinary", "setterModel" : { "timestampFormat" : null, @@ -29809,13 +29809,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
\n@param secretBinary (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.nio.ByteBuffer", "variableName" : "secretBinary", "variableType" : "java.nio.ByteBuffer", - "documentation" : "
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
", "simpleType" : "ByteBuffer", "variableSetterType" : "java.nio.ByteBuffer" }, @@ -29824,12 +29824,12 @@ "c2jName" : "SecretString", "c2jShape" : "SecretStringType", "deprecated" : false, - "documentation" : "(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Either SecretBinary
or SecretString
must have a value, but not both.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withSecretString",
- "getterDocumentation" : "/**
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Either SecretBinary
or SecretString
must have a value, but not both.*/",
"getterMethodName" : "getSecretString",
"getterModel" : {
"returnType" : "String",
@@ -29863,7 +29863,7 @@
"marshallingType" : "STRING",
"name" : "SecretString",
"sensitive" : true,
- "setterDocumentation" : "/**
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Either SecretBinary
or SecretString
must have a value, but not both.*/",
"setterMethodName" : "setSecretString",
"setterModel" : {
"timestampFormat" : null,
@@ -29878,13 +29878,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Either SecretBinary
or SecretString
must have a value, but not both.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "secretString",
"variableType" : "String",
- "documentation" : "
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withClientRequestToken",
- "getterDocumentation" : "/**
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.*/",
+ "getterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.*/",
"getterMethodName" : "getClientRequestToken",
"getterModel" : {
"returnType" : "String",
@@ -29934,7 +29934,7 @@
"marshallingType" : "STRING",
"name" : "ClientRequestToken",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.*/",
+ "setterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.*/",
"setterMethodName" : "setClientRequestToken",
"setterModel" : {
"timestampFormat" : null,
@@ -29949,13 +29949,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version. If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "clientRequestToken",
"variableType" : "String",
- "documentation" : "
(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
(Optional) Specifies an updated user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies an updated user-provided description of the secret.
\n@param description (Optional) Specifies an updated user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withDescription", - "getterDocumentation" : "/**(Optional) Specifies an updated user-provided description of the secret.
\n@return (Optional) Specifies an updated user-provided description of the secret.*/", + "getterDocumentation" : "/**The description of the secret.
\n@return The description of the secret.*/", "getterMethodName" : "getDescription", "getterModel" : { "returnType" : "String", @@ -30004,7 +30004,7 @@ "marshallingType" : "STRING", "name" : "Description", "sensitive" : false, - "setterDocumentation" : "/**(Optional) Specifies an updated user-provided description of the secret.
\n@param description (Optional) Specifies an updated user-provided description of the secret.*/", + "setterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.*/", "setterMethodName" : "setDescription", "setterModel" : { "timestampFormat" : null, @@ -30019,13 +30019,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) Specifies an updated user-provided description of the secret.
\n@param description (Optional) Specifies an updated user-provided description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The description of the secret.
\n@param description The description of the secret.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "description", "variableType" : "String", - "documentation" : "(Optional) Specifies an updated user-provided description of the secret.
", + "documentation" : "The description of the secret.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -30035,12 +30035,12 @@ "c2jName" : "KmsKeyId", "c2jShape" : "KmsKeyIdType", "deprecated" : false, - "documentation" : "(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
*/", + "getterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
*/", + "setterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version. You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretBinary", - "getterDocumentation" : "/**
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console.*/", + "getterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
\n\n{@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent {@code position}, and calling {@code get} methods on this rather than directly on the returned {@code ByteBuffer}. Doing so will ensure that anyone else using the {@code ByteBuffer} will not be affected by changes to the {@code position}.\n
\n@return The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.*/", "getterMethodName" : "getSecretBinary", "getterModel" : { "returnType" : "java.nio.ByteBuffer", @@ -30144,7 +30144,7 @@ "marshallingType" : "BYTE_BUFFER", "name" : "SecretBinary", "sensitive" : true, - "setterDocumentation" : "/**
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console.*/", + "setterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
\nThe AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.\n
\n\nWarning: ByteBuffers returned by the SDK are mutable. Changes to the content or position of the byte buffer will be seen by all objects that have a reference to this object. It is recommended to call ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or reading from the buffer. This behavior will be changed in a future major version of the SDK.\n
\n\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.*/", "setterMethodName" : "setSecretBinary", "setterModel" : { "timestampFormat" : null, @@ -30159,13 +30159,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
\n@param secretBinary (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. This parameter is not accessible using the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
\n@param secretBinary The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.nio.ByteBuffer", "variableName" : "secretBinary", "variableType" : "java.nio.ByteBuffer", - "documentation" : "
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
", + "documentation" : "The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
", "simpleType" : "ByteBuffer", "variableSetterType" : "java.nio.ByteBuffer" }, @@ -30175,12 +30175,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -30214,7 +30214,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -30229,13 +30229,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -30245,12 +30245,12 @@ "c2jName" : "SecretString", "c2jShape" : "SecretStringType", "deprecated" : false, - "documentation" : "(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Either SecretBinary
or SecretString
must have a value, but not both.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withSecretString",
- "getterDocumentation" : "/**
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@return (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "getterDocumentation" : "/**
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Either SecretBinary
or SecretString
must have a value, but not both.*/",
"getterMethodName" : "getSecretString",
"getterModel" : {
"returnType" : "String",
@@ -30284,7 +30284,7 @@
"marshallingType" : "STRING",
"name" : "SecretString",
"sensitive" : true,
- "setterDocumentation" : "/**
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.*/", + "setterDocumentation" : "/**
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Either SecretBinary
or SecretString
must have a value, but not both.*/",
"setterMethodName" : "setSecretString",
"setterModel" : {
"timestampFormat" : null,
@@ -30299,13 +30299,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
\n@param secretString (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. EitherSecretBinary
or SecretString
must have a value, but not both. They cannot both be empty. If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Either SecretBinary
or SecretString
must have a value, but not both.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "secretString",
"variableType" : "String",
- "documentation" : "
(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
", + "documentation" : "The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret that was updated.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "getterDocumentation" : "/**The ARN of the secret that was updated.
\n@return The ARN of the secret that was updated.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -30394,7 +30394,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "setterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -30409,13 +30409,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret that was updated.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -30424,12 +30424,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that was updated.
", + "documentation" : "The name of the secret that was updated.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that was updated.
\n@param name The friendly name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that was updated.
\n@return The friendly name of the secret that was updated.*/", + "getterDocumentation" : "/**The name of the secret that was updated.
\n@return The name of the secret that was updated.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -30463,7 +30463,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that was updated.
\n@param name The friendly name of the secret that was updated.*/", + "setterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -30478,13 +30478,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that was updated.
\n@param name The friendly name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that was updated.
", + "documentation" : "The name of the secret that was updated.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -30493,12 +30493,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withVersionId",
- "getterDocumentation" : "/**If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.*/",
+ "getterDocumentation" : "/**If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.*/",
"getterMethodName" : "getVersionId",
"getterModel" : {
"returnType" : "String",
@@ -30532,7 +30532,7 @@
"marshallingType" : "STRING",
"name" : "VersionId",
"sensitive" : false,
- "setterDocumentation" : "/**If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.*/",
+ "setterDocumentation" : "/**If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.*/",
"setterMethodName" : "setVersionId",
"setterModel" : {
"timestampFormat" : null,
@@ -30547,13 +30547,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "versionId",
"variableType" : "String",
- "documentation" : "If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret that was updated.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "getterDocumentation" : "/**The ARN of the secret that was updated.
\n@return The ARN of the secret that was updated.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -30603,7 +30603,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
*/", + "setterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -30618,13 +30618,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret that was updated.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -30634,12 +30634,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret that was updated.
", + "documentation" : "The name of the secret that was updated.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret that was updated.
\n@param name The friendly name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret that was updated.
\n@return The friendly name of the secret that was updated.*/", + "getterDocumentation" : "/**The name of the secret that was updated.
\n@return The name of the secret that was updated.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -30673,7 +30673,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret that was updated.
\n@param name The friendly name of the secret that was updated.*/", + "setterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -30688,13 +30688,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret that was updated.
\n@param name The friendly name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret that was updated.
", + "documentation" : "The name of the secret that was updated.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -30704,12 +30704,12 @@ "c2jName" : "VersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withVersionId",
- "getterDocumentation" : "/**If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.*/",
+ "getterDocumentation" : "/**If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.*/",
"getterMethodName" : "getVersionId",
"getterModel" : {
"returnType" : "String",
@@ -30743,7 +30743,7 @@
"marshallingType" : "STRING",
"name" : "VersionId",
"sensitive" : false,
- "setterDocumentation" : "/**If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.*/",
+ "setterDocumentation" : "/**If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.*/",
"setterMethodName" : "setVersionId",
"setterModel" : {
"timestampFormat" : null,
@@ -30758,13 +30758,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
VersionId
contains the unique identifier of the new version.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "versionId",
"variableType" : "String",
- "documentation" : "If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or the name of the secret with the version and staging labelsto modify.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or the name of the secret with the version and staging labelsto modify.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -30863,7 +30863,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or the name of the secret with the version and staging labelsto modify.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -30878,13 +30878,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or the name of the secret with the version and staging labelsto modify.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -30962,12 +30962,12 @@ "c2jName" : "RemoveFromVersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", + "documentation" : "The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRemoveFromVersionId", - "getterDocumentation" : "/**Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@return Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.*/", + "getterDocumentation" : "/**The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@return The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.*/", "getterMethodName" : "getRemoveFromVersionId", "getterModel" : { "returnType" : "String", @@ -31001,7 +31001,7 @@ "marshallingType" : "STRING", "name" : "RemoveFromVersionId", "sensitive" : false, - "setterDocumentation" : "/**Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.*/", + "setterDocumentation" : "/**The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.*/", "setterMethodName" : "setRemoveFromVersionId", "setterModel" : { "timestampFormat" : null, @@ -31016,13 +31016,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "removeFromVersionId", "variableType" : "String", - "documentation" : "Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", + "documentation" : "The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31031,12 +31031,12 @@ "c2jName" : "MoveToVersionId", "c2jShape" : "SecretVersionIdType", "deprecated" : false, - "documentation" : "(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withMoveToVersionId",
- "getterDocumentation" : "/**
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.*/",
+ "getterDocumentation" : "/**
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.*/",
"getterMethodName" : "getMoveToVersionId",
"getterModel" : {
"returnType" : "String",
@@ -31070,7 +31070,7 @@
"marshallingType" : "STRING",
"name" : "MoveToVersionId",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.*/",
+ "setterDocumentation" : "/**
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.*/",
"setterMethodName" : "setMoveToVersionId",
"setterModel" : {
"timestampFormat" : null,
@@ -31085,13 +31085,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "moveToVersionId",
"variableType" : "String",
- "documentation" : "
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "fluentSetterDocumentation" : "/**
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"fluentSetterMethodName" : "withMoveToVersionId",
- "getterDocumentation" : "/**
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.*/",
+ "getterDocumentation" : "/**
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.*/",
"getterMethodName" : "getMoveToVersionId",
"getterModel" : {
"returnType" : "String",
@@ -31141,7 +31141,7 @@
"marshallingType" : "STRING",
"name" : "MoveToVersionId",
"sensitive" : false,
- "setterDocumentation" : "/**
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.*/",
+ "setterDocumentation" : "/**
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.*/",
"setterMethodName" : "setMoveToVersionId",
"setterModel" : {
"timestampFormat" : null,
@@ -31156,13 +31156,13 @@
"shouldFullyQualify" : false,
"simple" : true,
"unmarshallingType" : null,
- "varargSetterDocumentation" : "/**
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
+ "varargSetterDocumentation" : "/**
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.\n@return Returns a reference to this object so that method calls can be chained together.*/",
"variable" : {
"timestampFormat" : null,
"variableDeclarationType" : "String",
"variableName" : "moveToVersionId",
"variableType" : "String",
- "documentation" : "
(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", + "documentation" : "The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withRemoveFromVersionId", - "getterDocumentation" : "/**Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@return Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.*/", + "getterDocumentation" : "/**The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@return The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.*/", "getterMethodName" : "getRemoveFromVersionId", "getterModel" : { "returnType" : "String", @@ -31211,7 +31211,7 @@ "marshallingType" : "STRING", "name" : "RemoveFromVersionId", "sensitive" : false, - "setterDocumentation" : "/**Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.*/", + "setterDocumentation" : "/**The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.*/", "setterMethodName" : "setRemoveFromVersionId", "setterModel" : { "timestampFormat" : null, @@ -31226,13 +31226,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
\n@param removeFromVersionId The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "removeFromVersionId", "variableType" : "String", - "documentation" : "Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", + "documentation" : "The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31242,12 +31242,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or the name of the secret with the version and staging labelsto modify.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return The ARN or the name of the secret with the version and staging labelsto modify.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -31281,7 +31281,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or the name of the secret with the version and staging labelsto modify.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -31296,13 +31296,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId The ARN or the name of the secret with the version and staging labelsto modify.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31422,12 +31422,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "The ARN of the secret with the modified staging label.
", + "documentation" : "The ARN of the secret that was updated.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret with the modified staging label.
\n@param aRN The ARN of the secret with the modified staging label.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret with the modified staging label.
\n@return The ARN of the secret with the modified staging label.*/", + "getterDocumentation" : "/**The ARN of the secret that was updated.
\n@return The ARN of the secret that was updated.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -31461,7 +31461,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret with the modified staging label.
\n@param aRN The ARN of the secret with the modified staging label.*/", + "setterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -31476,13 +31476,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret with the modified staging label.
\n@param aRN The ARN of the secret with the modified staging label.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret with the modified staging label.
", + "documentation" : "The ARN of the secret that was updated.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31491,12 +31491,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret with the modified staging label.
", + "documentation" : "The name of the secret that was updated.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret with the modified staging label.
\n@param name The friendly name of the secret with the modified staging label.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret with the modified staging label.
\n@return The friendly name of the secret with the modified staging label.*/", + "getterDocumentation" : "/**The name of the secret that was updated.
\n@return The name of the secret that was updated.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -31530,7 +31530,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret with the modified staging label.
\n@param name The friendly name of the secret with the modified staging label.*/", + "setterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -31545,13 +31545,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret with the modified staging label.
\n@param name The friendly name of the secret with the modified staging label.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret with the modified staging label.
", + "documentation" : "The name of the secret that was updated.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31562,12 +31562,12 @@ "c2jName" : "ARN", "c2jShape" : "SecretARNType", "deprecated" : false, - "documentation" : "The ARN of the secret with the modified staging label.
", + "documentation" : "The ARN of the secret that was updated.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The ARN of the secret with the modified staging label.
\n@param aRN The ARN of the secret with the modified staging label.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withARN", - "getterDocumentation" : "/**The ARN of the secret with the modified staging label.
\n@return The ARN of the secret with the modified staging label.*/", + "getterDocumentation" : "/**The ARN of the secret that was updated.
\n@return The ARN of the secret that was updated.*/", "getterMethodName" : "getARN", "getterModel" : { "returnType" : "String", @@ -31601,7 +31601,7 @@ "marshallingType" : "STRING", "name" : "ARN", "sensitive" : false, - "setterDocumentation" : "/**The ARN of the secret with the modified staging label.
\n@param aRN The ARN of the secret with the modified staging label.*/", + "setterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.*/", "setterMethodName" : "setARN", "setterModel" : { "timestampFormat" : null, @@ -31616,13 +31616,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The ARN of the secret with the modified staging label.
\n@param aRN The ARN of the secret with the modified staging label.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The ARN of the secret that was updated.
\n@param aRN The ARN of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "aRN", "variableType" : "String", - "documentation" : "The ARN of the secret with the modified staging label.
", + "documentation" : "The ARN of the secret that was updated.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31632,12 +31632,12 @@ "c2jName" : "Name", "c2jShape" : "SecretNameType", "deprecated" : false, - "documentation" : "The friendly name of the secret with the modified staging label.
", + "documentation" : "The name of the secret that was updated.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**The friendly name of the secret with the modified staging label.
\n@param name The friendly name of the secret with the modified staging label.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withName", - "getterDocumentation" : "/**The friendly name of the secret with the modified staging label.
\n@return The friendly name of the secret with the modified staging label.*/", + "getterDocumentation" : "/**The name of the secret that was updated.
\n@return The name of the secret that was updated.*/", "getterMethodName" : "getName", "getterModel" : { "returnType" : "String", @@ -31671,7 +31671,7 @@ "marshallingType" : "STRING", "name" : "Name", "sensitive" : false, - "setterDocumentation" : "/**The friendly name of the secret with the modified staging label.
\n@param name The friendly name of the secret with the modified staging label.*/", + "setterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.*/", "setterMethodName" : "setName", "setterModel" : { "timestampFormat" : null, @@ -31686,13 +31686,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**The friendly name of the secret with the modified staging label.
\n@param name The friendly name of the secret with the modified staging label.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**The name of the secret that was updated.
\n@param name The name of the secret that was updated.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "name", "variableType" : "String", - "documentation" : "The friendly name of the secret with the modified staging label.
", + "documentation" : "The name of the secret that was updated.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31752,12 +31752,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "This field is reserved for internal use.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
This field is reserved for internal use.
\n@param secretId This field is reserved for internal use.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
This field is reserved for internal use.
\n@return This field is reserved for internal use.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -31791,7 +31791,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
This field is reserved for internal use.
\n@param secretId This field is reserved for internal use.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -31806,13 +31806,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
This field is reserved for internal use.
\n@param secretId This field is reserved for internal use.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "This field is reserved for internal use.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31821,12 +31821,12 @@ "c2jName" : "ResourcePolicy", "c2jShape" : "NonEmptyResourcePolicyType", "deprecated" : false, - "documentation" : "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
", + "documentation" : "A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withResourcePolicy", - "getterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
\n@return A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi*/", + "getterDocumentation" : "/**A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
\n@return A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.*/", "getterMethodName" : "getResourcePolicy", "getterModel" : { "returnType" : "String", @@ -31860,7 +31860,7 @@ "marshallingType" : "STRING", "name" : "ResourcePolicy", "sensitive" : false, - "setterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi*/", + "setterDocumentation" : "/**A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.*/", "setterMethodName" : "setResourcePolicy", "setterModel" : { "timestampFormat" : null, @@ -31875,13 +31875,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "resourcePolicy", "variableType" : "String", - "documentation" : "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
", + "documentation" : "A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31892,12 +31892,12 @@ "c2jName" : "ResourcePolicy", "c2jShape" : "NonEmptyResourcePolicyType", "deprecated" : false, - "documentation" : "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
", + "documentation" : "A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withResourcePolicy", - "getterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
\n@return A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi*/", + "getterDocumentation" : "/**A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
\n@return A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.*/", "getterMethodName" : "getResourcePolicy", "getterModel" : { "returnType" : "String", @@ -31931,7 +31931,7 @@ "marshallingType" : "STRING", "name" : "ResourcePolicy", "sensitive" : false, - "setterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi*/", + "setterDocumentation" : "/**A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.*/", "setterMethodName" : "setResourcePolicy", "setterModel" : { "timestampFormat" : null, @@ -31946,13 +31946,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
\n@param resourcePolicy A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
\n@param resourcePolicy A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "resourcePolicy", "variableType" : "String", - "documentation" : "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
", + "documentation" : "A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -31962,12 +31962,12 @@ "c2jName" : "SecretId", "c2jShape" : "SecretIdType", "deprecated" : false, - "documentation" : "(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "This field is reserved for internal use.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**
This field is reserved for internal use.
\n@param secretId This field is reserved for internal use.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withSecretId", - "getterDocumentation" : "/**(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@return (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "getterDocumentation" : "/**
This field is reserved for internal use.
\n@return This field is reserved for internal use.*/", "getterMethodName" : "getSecretId", "getterModel" : { "returnType" : "String", @@ -32001,7 +32001,7 @@ "marshallingType" : "STRING", "name" : "SecretId", "sensitive" : false, - "setterDocumentation" : "/**(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.*/", + "setterDocumentation" : "/**
This field is reserved for internal use.
\n@param secretId This field is reserved for internal use.*/", "setterMethodName" : "setSecretId", "setterModel" : { "timestampFormat" : null, @@ -32016,13 +32016,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
\n@param secretId (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**
This field is reserved for internal use.
\n@param secretId This field is reserved for internal use.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "String", "variableName" : "secretId", "variableType" : "String", - "documentation" : "(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
", + "documentation" : "This field is reserved for internal use.
", "simpleType" : "String", "variableSetterType" : "String" }, @@ -32072,12 +32072,12 @@ "c2jName" : "PolicyValidationPassed", "c2jShape" : "BooleanType", "deprecated" : false, - "documentation" : "Returns a message stating that your Reource Policy passed validation.
", + "documentation" : "True if your policy passes validation, otherwise false.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Returns a message stating that your Reource Policy passed validation.
\n@param policyValidationPassed Returns a message stating that your Reource Policy passed validation.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**True if your policy passes validation, otherwise false.
\n@param policyValidationPassed True if your policy passes validation, otherwise false.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withPolicyValidationPassed", - "getterDocumentation" : "/**Returns a message stating that your Reource Policy passed validation.
\n@return Returns a message stating that your Reource Policy passed validation.*/", + "getterDocumentation" : "/**True if your policy passes validation, otherwise false.
\n@return True if your policy passes validation, otherwise false.*/", "getterMethodName" : "getPolicyValidationPassed", "getterModel" : { "returnType" : "Boolean", @@ -32111,7 +32111,7 @@ "marshallingType" : "BOOLEAN", "name" : "PolicyValidationPassed", "sensitive" : false, - "setterDocumentation" : "/**Returns a message stating that your Reource Policy passed validation.
\n@param policyValidationPassed Returns a message stating that your Reource Policy passed validation.*/", + "setterDocumentation" : "/**True if your policy passes validation, otherwise false.
\n@param policyValidationPassed True if your policy passes validation, otherwise false.*/", "setterMethodName" : "setPolicyValidationPassed", "setterModel" : { "timestampFormat" : null, @@ -32126,13 +32126,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Returns a message stating that your Reource Policy passed validation.
\n@param policyValidationPassed Returns a message stating that your Reource Policy passed validation.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**True if your policy passes validation, otherwise false.
\n@param policyValidationPassed True if your policy passes validation, otherwise false.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "policyValidationPassed", "variableType" : "Boolean", - "documentation" : "Returns a message stating that your Reource Policy passed validation.
", + "documentation" : "True if your policy passes validation, otherwise false.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -32141,12 +32141,12 @@ "c2jName" : "ValidationErrors", "c2jShape" : "ValidationErrorsType", "deprecated" : false, - "documentation" : "Returns an error message if your policy doesn't pass validatation.
", + "documentation" : "Validation errors if your policy didn't pass validation.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Returns an error message if your policy doesn't pass validatation.
\n@param validationErrors Returns an error message if your policy doesn't pass validatation.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Validation errors if your policy didn't pass validation.
\n@param validationErrors Validation errors if your policy didn't pass validation.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withValidationErrors", - "getterDocumentation" : "/**Returns an error message if your policy doesn't pass validatation.
\n@return Returns an error message if your policy doesn't pass validatation.*/", + "getterDocumentation" : "/**Validation errors if your policy didn't pass validation.
\n@return Validation errors if your policy didn't pass validation.*/", "getterMethodName" : "getValidationErrors", "getterModel" : { "returnType" : "java.util.ListReturns an error message if your policy doesn't pass validatation.
\n@param validationErrors Returns an error message if your policy doesn't pass validatation.*/", + "setterDocumentation" : "/**Validation errors if your policy didn't pass validation.
\n@param validationErrors Validation errors if your policy didn't pass validation.*/", "setterMethodName" : "setValidationErrors", "setterModel" : { "timestampFormat" : null, @@ -32279,13 +32279,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Returns an error message if your policy doesn't pass validatation.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setValidationErrors(java.util.Collection)} or {@link #withValidationErrors(java.util.Collection)} if you want to override the existing values.
\n@param validationErrors Returns an error message if your policy doesn't pass validatation.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Validation errors if your policy didn't pass validation.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setValidationErrors(java.util.Collection)} or {@link #withValidationErrors(java.util.Collection)} if you want to override the existing values.
\n@param validationErrors Validation errors if your policy didn't pass validation.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.ListReturns an error message if your policy doesn't pass validatation.
", + "documentation" : "Validation errors if your policy didn't pass validation.
", "simpleType" : "ListReturns a message stating that your Reource Policy passed validation.
", + "documentation" : "True if your policy passes validation, otherwise false.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Returns a message stating that your Reource Policy passed validation.
\n@param policyValidationPassed Returns a message stating that your Reource Policy passed validation.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**True if your policy passes validation, otherwise false.
\n@param policyValidationPassed True if your policy passes validation, otherwise false.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withPolicyValidationPassed", - "getterDocumentation" : "/**Returns a message stating that your Reource Policy passed validation.
\n@return Returns a message stating that your Reource Policy passed validation.*/", + "getterDocumentation" : "/**True if your policy passes validation, otherwise false.
\n@return True if your policy passes validation, otherwise false.*/", "getterMethodName" : "getPolicyValidationPassed", "getterModel" : { "returnType" : "Boolean", @@ -32335,7 +32335,7 @@ "marshallingType" : "BOOLEAN", "name" : "PolicyValidationPassed", "sensitive" : false, - "setterDocumentation" : "/**Returns a message stating that your Reource Policy passed validation.
\n@param policyValidationPassed Returns a message stating that your Reource Policy passed validation.*/", + "setterDocumentation" : "/**True if your policy passes validation, otherwise false.
\n@param policyValidationPassed True if your policy passes validation, otherwise false.*/", "setterMethodName" : "setPolicyValidationPassed", "setterModel" : { "timestampFormat" : null, @@ -32350,13 +32350,13 @@ "shouldFullyQualify" : false, "simple" : true, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Returns a message stating that your Reource Policy passed validation.
\n@param policyValidationPassed Returns a message stating that your Reource Policy passed validation.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**True if your policy passes validation, otherwise false.
\n@param policyValidationPassed True if your policy passes validation, otherwise false.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "Boolean", "variableName" : "policyValidationPassed", "variableType" : "Boolean", - "documentation" : "Returns a message stating that your Reource Policy passed validation.
", + "documentation" : "True if your policy passes validation, otherwise false.
", "simpleType" : "Boolean", "variableSetterType" : "Boolean" }, @@ -32366,12 +32366,12 @@ "c2jName" : "ValidationErrors", "c2jShape" : "ValidationErrorsType", "deprecated" : false, - "documentation" : "Returns an error message if your policy doesn't pass validatation.
", + "documentation" : "Validation errors if your policy didn't pass validation.
", "endpointDiscoveryId" : false, "enumType" : null, - "fluentSetterDocumentation" : "/**Returns an error message if your policy doesn't pass validatation.
\n@param validationErrors Returns an error message if your policy doesn't pass validatation.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "fluentSetterDocumentation" : "/**Validation errors if your policy didn't pass validation.
\n@param validationErrors Validation errors if your policy didn't pass validation.\n@return Returns a reference to this object so that method calls can be chained together.*/", "fluentSetterMethodName" : "withValidationErrors", - "getterDocumentation" : "/**Returns an error message if your policy doesn't pass validatation.
\n@return Returns an error message if your policy doesn't pass validatation.*/", + "getterDocumentation" : "/**Validation errors if your policy didn't pass validation.
\n@return Validation errors if your policy didn't pass validation.*/", "getterMethodName" : "getValidationErrors", "getterModel" : { "returnType" : "java.util.ListReturns an error message if your policy doesn't pass validatation.
\n@param validationErrors Returns an error message if your policy doesn't pass validatation.*/", + "setterDocumentation" : "/**Validation errors if your policy didn't pass validation.
\n@param validationErrors Validation errors if your policy didn't pass validation.*/", "setterMethodName" : "setValidationErrors", "setterModel" : { "timestampFormat" : null, @@ -32504,13 +32504,13 @@ "shouldFullyQualify" : false, "simple" : false, "unmarshallingType" : null, - "varargSetterDocumentation" : "/**Returns an error message if your policy doesn't pass validatation.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setValidationErrors(java.util.Collection)} or {@link #withValidationErrors(java.util.Collection)} if you want to override the existing values.
\n@param validationErrors Returns an error message if your policy doesn't pass validatation.\n@return Returns a reference to this object so that method calls can be chained together.*/", + "varargSetterDocumentation" : "/**Validation errors if your policy didn't pass validation.
\nNOTE: This method appends the values to the existing list (if any). Use {@link #setValidationErrors(java.util.Collection)} or {@link #withValidationErrors(java.util.Collection)} if you want to override the existing values.
\n@param validationErrors Validation errors if your policy didn't pass validation.\n@return Returns a reference to this object so that method calls can be chained together.*/", "variable" : { "timestampFormat" : null, "variableDeclarationType" : "java.util.ListReturns an error message if your policy doesn't pass validatation.
", + "documentation" : "Validation errors if your policy didn't pass validation.
", "simpleType" : "ListDisables automatic scheduled rotation and cancels the rotation of a secret if currently in progress.
To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. This immediately rotates your secret and then enables the automatic schedule.
If you cancel a rotation while in progress, it can leave the VersionStage
labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING
from the partially created version, specified by the VersionId
response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version VersionStage
field.
To successfully start a rotation, the staging label AWSPENDING
must be in one of the following states:
Not attached to any version at all
Attached to the same version as the staging label AWSCURRENT
If the staging label AWSPENDING
attached to a different version than the version with AWSCURRENT
then the attempt to rotate fails.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CancelRotateSecret
Related operations
To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.
To get the rotation configuration details for a secret, use DescribeSecret.
To list all of the currently available secrets, use ListSecrets.
To list all of the versions currently associated with a secret, use ListSecretVersionIds.
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
To turn on automatic rotation again, call RotateSecret.
If you cancel a rotation in progress, it can leave the VersionStage
labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING
from the partially created version, specified by the VersionId
response value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can delete a version by removing all staging labels from it.
Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
Secrets Manager stores the encrypted secret data in one of a collection of \"versions\" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more \"staging labels\" that identify where the version is in the rotation cycle. The SecretVersionsToStages
field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and not included in the list.
You provide the secret data to be encrypted by putting text in either the SecretString
parameter or binary data in the SecretBinary
parameter, but not both. If you include SecretString
or SecretBinary
then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT
to the new version.
If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same Amazon Web Services account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId
. If you call an API that must encrypt or decrypt SecretString
or SecretBinary
using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CreateSecret
kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account default Amazon Web Services managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account default Amazon Web Services managed CMK for Secrets Manager.
secretsmanager:TagResource - needed only if you include the Tags
parameter.
Related operations
To delete a secret, use DeleteSecret.
To modify an existing secret, use UpdateSecret.
To create a new version of a secret, use PutSecretValue.
To retrieve the encrypted secure string and secure binary values, use GetSecretValue.
To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.
To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages
response value.
Creates a new secret. A secret is a set of credentials, such as a user name and password, that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
For information about creating a secret in the console, see Create a secret.
To create a secret, you can provide the secret value to be encrypted in either the SecretString
parameter or the SecretBinary
parameter, but not both. If you include SecretString
or SecretBinary
then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT
to it.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
Deletes the resource-based permission policy attached to the secret.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DeleteResourcePolicy
Related operations
To attach a resource policy to a secret, use PutResourcePolicy.
To retrieve the current resource-based policy attached to a secret, use GetResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
" }, "DeleteSecret":{ "name":"DeleteSecret", @@ -80,7 +80,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceError"} ], - "documentation":"Deletes an entire secret and all of the versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate
stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
and cancel the deletion of the secret.
You cannot access the encrypted secret information in any secret scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.
There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the VersionStage
field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions without any staging labels do not show up in ListSecretVersionIds unless you specify IncludeDeprecated
.
The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DeleteSecret
Related operations
To create a secret, use CreateSecret.
To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret.
Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate
stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
and cancel the deletion of the secret.
In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.
" }, "DescribeSecret":{ "name":"DescribeSecret", @@ -95,7 +95,7 @@ {"shape":"InternalServiceError"}, {"shape":"InvalidParameterException"} ], - "documentation":"Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields populated with a value in the response.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DescribeSecret
Related operations
To create a secret, use CreateSecret.
To modify a secret, use UpdateSecret.
To retrieve the encrypted secret information in a version of the secret, use GetSecretValue.
To list all of the secrets in the Amazon Web Services account, use ListSecrets.
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
" }, "GetRandomPassword":{ "name":"GetRandomPassword", @@ -110,7 +110,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceError"} ], - "documentation":"Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetRandomPassword
Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
" }, "GetResourcePolicy":{ "name":"GetResourcePolicy", @@ -126,7 +126,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InvalidParameterException"} ], - "documentation":"Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetResourcePolicy
Related operations
To attach a resource policy to a secret, use PutResourcePolicy.
To delete the resource-based policy attached to a secret, use DeleteResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.
" }, "GetSecretValue":{ "name":"GetSecretValue", @@ -143,7 +143,7 @@ {"shape":"DecryptionFailure"}, {"shape":"InternalServiceError"} ], - "documentation":"Retrieves the contents of the encrypted fields SecretString
or SecretBinary
from the specified version of a secret, whichever contains content.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetSecretValue
kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager.
Related operations
To create a new version of the secret with different encrypted information, use PutSecretValue.
To retrieve the non-encrypted details for the secret, use DescribeSecret.
Retrieves the contents of the encrypted fields SecretString
or SecretBinary
from the specified version of a secret, whichever contains content.
For information about retrieving the secret value in the console, see Retrieve secrets.
To run this command, you must have secretsmanager:GetSecretValue
permissions. If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager
, then you also need kms:Decrypt
permissions for that key.
Lists all of the versions attached to the specified secret. The output does not include the SecretString
or SecretBinary
fields. By default, the list includes only versions that have at least one staging label in VersionStage
attached.
Always check the NextToken
response parameter when calling any of the List*
operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the NextToken
response parameter contains a value to pass to the next call to the same API to request the next part of the list.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:ListSecretVersionIds
Related operations
To list the secrets in an account, use ListSecrets.
Lists the versions for a secret.
To list the secrets in the account, use ListSecrets.
To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
Minimum permissions
To run this command, you must have secretsmanager:ListSecretVersionIds
permissions.
Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString
and SecretBinary
are not included in the output. To get that information, call the GetSecretValue operation.
Always check the NextToken
response parameter when calling any of the List*
operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the NextToken
response parameter contains a value to pass to the next call to the same API to request the next part of the list.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:ListSecrets
Related operations
To list the versions attached to a secret, use ListSecretVersionIds.
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account.
To list the versions of a secret, use ListSecretVersionIds.
To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
For information about finding secrets in the console, see Enhanced search capabilities for secrets in Secrets Manager.
Minimum permissions
To run this command, you must have secretsmanager:ListSecrets
permissions.
Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources
element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for Amazon Web Services Secrets Manager. For the complete description of the Amazon Web Services policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:PutResourcePolicy
Related operations
To retrieve the resource policy attached to a secret, use GetResourcePolicy.
To delete the resource-based policy attached to a secret, use DeleteResourcePolicy.
To list all of the currently available secrets, use ListSecrets.
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
" }, "PutSecretValue":{ "name":"PutSecretValue", @@ -211,7 +211,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceError"} ], - "documentation":"Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString
value or a new SecretBinary
value. You can also specify the staging labels that are initially attached to the new version.
We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT
to the new version.
If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
If this operation moves the staging label AWSCURRENT
from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
This operation is idempotent. If a version with a VersionId
with the same value as the ClientRequestToken
parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.
If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same Amazon Web Services account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId
. If you call an API that must encrypt or decrypt SecretString
or SecretBinary
using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:PutSecretValue
kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager.
Related operations
To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
To create a secret, use CreateSecret.
To get the details for a secret, use DescribeSecret.
To list the versions attached to a secret, use ListSecretVersionIds.
Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a new SecretString
value or a new SecretBinary
value.
We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages
. If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT
to it .
If this operation moves the staging label AWSCURRENT
from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
This operation is idempotent. If a version with a VersionId
with the same value as the ClientRequestToken
parameter already exists, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones.
Remove regions from replication.
" + "documentation":"For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
" }, "ReplicateSecretToRegions":{ "name":"ReplicateSecretToRegions", @@ -243,7 +243,7 @@ {"shape":"InvalidParameterException"}, {"shape":"InternalServiceError"} ], - "documentation":"Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions.
" + "documentation":"Replicates the secret to a new Regions. See Multi-Region secrets.
" }, "RestoreSecret":{ "name":"RestoreSecret", @@ -259,7 +259,7 @@ {"shape":"InvalidRequestException"}, {"shape":"InternalServiceError"} ], - "documentation":"Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. This makes the secret accessible to query once again.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:RestoreSecret
Related operations
To delete a secret, use DeleteSecret.
Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. You can access a secret again after it has been restored.
Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.
This required configuration information includes the ARN of an Amazon Web Services Lambda function and optionally, the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT
so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.
The rotation function must end with the versions of the secret in one of two states:
The AWSPENDING
and AWSCURRENT
staging labels are attached to the same version of the secret, or
The AWSPENDING
staging label is not attached to any version of the secret.
If the AWSPENDING
staging label is present but not attached to the same version as AWSCURRENT
then any later invocation of RotateSecret
assumes that a previous rotation request is still in progress and returns an error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:RotateSecret
lambda:InvokeFunction (on the function specified in the secret's metadata)
Related operations
To list the secrets in your account, use ListSecrets.
To get the details for a version of a secret, use DescribeSecret.
To create a new version of a secret, use CreateSecret.
To attach staging labels to or remove staging labels from a version of a secret, use UpdateSecretVersionStage.
Configures and starts the asynchronous process of rotating the secret.
If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret. For more information about rotation, see Rotate secrets.
To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule for the rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the database or service to match. After testing the new credentials, the function marks the new secret version with the staging label AWSCURRENT
. Then anyone who retrieves the secret gets the new version. For more information, see How rotation works.
When rotation is successful, the AWSPENDING
staging label might be attached to the same version as the AWSCURRENT
version, or it might not be attached to any version.
If the AWSPENDING
staging label is present but not attached to the same version as AWSCURRENT
, then any later invocation of RotateSecret
assumes that a previous rotation request is still in progress and returns an error.
To run this command, you must have secretsmanager:RotateSecret
permissions and lambda:InvokeFunction
permissions on the function specified in the secret's metadata.
Removes the secret from replication and promotes the secret to a regional secret in the replica Region.
" + "documentation":"Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
You must call this operation from the Region in which you want to promote the replica to a primary secret.
" }, "TagResource":{ "name":"TagResource", @@ -306,7 +306,7 @@ {"shape":"InvalidParameterException"}, {"shape":"InternalServiceError"} ], - "documentation":"Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:TagResource
Related operations
To remove one or more tags from the collection attached to a secret, use UntagResource.
To view the list of tags attached to a secret, use DescribeSecret.
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Removes one or more tags from the specified secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UntagResource
Related operations
To add one or more tags to the collection attached to a secret, use TagResource.
To view the list of tags attached to a secret, use DescribeSecret.
Removes specific tags from a secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Modifies many of the details of the specified secret.
To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
We recommend you avoid calling UpdateSecret
at a sustained rate of more than once every 10 minutes. When you call UpdateSecret
to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
The Secrets Manager console uses only the SecretString
parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
If a version with a VersionId
with the same value as the ClientRequestToken
parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.
If you include SecretString
or SecretBinary
to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT
to the new version.
If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same Amazon Web Services account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId
. If you call an API that must encrypt or decrypt SecretString
or SecretBinary
using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecret
kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager.
kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager.
Related operations
To create a new secret, use CreateSecret.
To add only a new version to an existing secret, use PutSecretValue.
To get the details for a secret, use DescribeSecret.
To list the versions contained in a secret, use ListSecretVersionIds.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
We recommend you avoid calling UpdateSecret
at a sustained rate of more than once every 10 minutes. When you call UpdateSecret
to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If you include SecretString
or SecretBinary
to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT
to the new version.
If you call this operation with a VersionId
that matches an existing version's ClientRequestToken
, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed key.
To run this command, you must have secretsmanager:UpdateSecret
permissions. If you use a customer managed key, you must also have kms:GenerateDataKey
and kms:Decrypt
permissions .
Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
The staging labels that you specify in the VersionStage
parameter are added to the existing list of staging labels--they don't replace it.
You can move the AWSCURRENT
staging label to this version by including it in this call.
Whenever you move AWSCURRENT
, Secrets Manager automatically moves the label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecretVersionStage
Related operations
To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret
and examine the SecretVersionsToStages
response value.
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage
parameter are added to the existing list of staging labels for the version.
You can move the AWSCURRENT
staging label to this version by including it in this call.
Whenever you move AWSCURRENT
, Secrets Manager automatically moves the label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
" }, "ValidateResourcePolicy":{ "name":"ValidateResourcePolicy", @@ -376,7 +376,7 @@ {"shape":"InternalServiceError"}, {"shape":"InvalidRequestException"} ], - "documentation":"Validates that the resource policy does not grant a wide range of IAM principals access to your secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string. A resource-based policy is optional for secrets.
The API performs three checks when validating the secret:
Sends a call to Zelkova, an automated reasoning engine, to ensure your Resource Policy does not allow broad access to your secret.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.
Minimum Permissions
You must have the permissions required to access the following APIs:
secretsmanager:PutResourcePolicy
secretsmanager:ValidateResourcePolicy
Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.
The API performs three checks when validating the policy:
Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.
Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" } } }, @@ -406,15 +406,15 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"The ARN of the secret for which rotation was canceled.
" + "documentation":"The ARN of the secret.
" }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret for which rotation was canceled.
" + "documentation":"The name of the secret.
" }, "VersionId":{ "shape":"SecretVersionIdType", - "documentation":"The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. We recommend that you remove the VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
Specifies the friendly name of the new secret.
The secret name must be ASCII letters, digits, or the following characters : /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.
The name of the new secret.
The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
" }, "ClientRequestToken":{ "shape":"ClientRequestTokenType", - "documentation":"(Optional) If you include SecretString
or SecretBinary
, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString
and SecretBinary
values are the same as those in the request, then the request is ignored.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the VersionId
of the new version.
(Optional) Specifies a user-provided description of the secret.
" + "documentation":"The description of the secret.
" }, "KmsKeyId":{ "shape":"KmsKeyIdType", - "documentation":"(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be used to encrypt the SecretString
or SecretBinary
values in the versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString
or SecretBinary
fields.
You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
To use a KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS key.
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
" + "documentation":"The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretString
or SecretBinary
must have a value, but not both.
This parameter is not available in the Secrets Manager console.
" }, "SecretString":{ "shape":"SecretStringType", - "documentation":"(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
" + "documentation":"The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretString
or SecretBinary
must have a value, but not both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide. For example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example:
[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
Maximum number of tags per secret: 50
Maximum key length: 127 Unicode characters in UTF-8
Maximum value length: 255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws:
prefix in your tag names or values because Amazon Web Services reserves it for Amazon Web Services use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.
" + "documentation":"A list of Regions and KMS keys to replicate secrets.
" }, "ForceOverwriteReplicaSecret":{ "shape":"BooleanType", - "documentation":"(Optional) If set, the replication overwrites a secret with the same name in the destination region.
" + "documentation":"Specifies whether to overwrite a secret with the same name in the destination Region.
" } } }, @@ -471,19 +471,19 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"The Amazon Resource Name (ARN) of the secret that you just created.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.
" }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret that you just created.
" + "documentation":"The name of the new secret.
" }, "VersionId":{ "shape":"SecretVersionIdType", - "documentation":"The unique identifier associated with the version of the secret you just created.
" + "documentation":"The unique identifier associated with the version of the new secret.
" }, "ReplicationStatus":{ "shape":"ReplicationStatusListType", - "documentation":"Describes a list of replication status objects as InProgress
, Failed
or InSync
.
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret to delete the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" } } }, @@ -515,7 +515,7 @@ }, "Name":{ "shape":"NameType", - "documentation":"The friendly name of the secret that the resource-based policy was deleted for.
" + "documentation":"The name of the secret that the resource-based policy was deleted for.
" } } }, @@ -525,16 +525,16 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret to delete.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "RecoveryWindowInDays":{ "shape":"RecoveryWindowInDaysType", - "documentation":"(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
", + "documentation":"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.
(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays
parameter in the same API call.
An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.
Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error ResourceNotFoundException
in order to correctly handle retries.
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.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with the same name, use appropriate back off and retry logic.
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
parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You lose the secret permanently.
The ARN of the secret that is now scheduled for deletion.
" + "documentation":"The ARN of the secret.
" }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret currently scheduled for deletion.
" + "documentation":"The name of the secret.
" }, "DeletionDate":{ "shape":"DeletionDateType", - "documentation":"The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays
.
The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no longer be restored. This value is the date and time of the delete request plus the number of days in RecoveryWindowInDays
.
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" } } }, @@ -578,32 +578,32 @@ }, "Name":{ "shape":"SecretNameType", - "documentation":"The user-provided friendly name of the secret.
" + "documentation":"The name of the secret.
" }, "Description":{ "shape":"DescriptionType", - "documentation":"The user-provided description of the secret.
" + "documentation":"The description of the secret.
" }, "KmsKeyId":{ "shape":"KmsKeyIdType", - "documentation":"The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the SecretString
or SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK (the one named awssecretsmanager
) for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater than 0. To disable rotation, use CancelRotateSecret.
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
", "box":true }, "RotationLambdaARN":{ "shape":"RotationLambdaARNType", - "documentation":"The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret
.
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
" }, "RotationRules":{ "shape":"RotationRulesType", - "documentation":"A structure with the rotation configuration for this secret. This field is only populated if rotation is configured.
" + "documentation":"The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had rotation turned on, this field is omitted.
" }, "LastRotatedDate":{ "shape":"LastRotatedDateType", - "documentation":"The last date and time that the rotation process for this secret was invoked.
The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.
", + "documentation":"The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
", "box":true }, "LastChangedDate":{ @@ -613,38 +613,38 @@ }, "LastAccessedDate":{ "shape":"LastAccessedDateType", - "documentation":"The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
", + "documentation":"The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
", "box":true }, "DeletedDate":{ "shape":"DeletedDateType", - "documentation":"This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
", + "documentation":"The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
", "box":true }, "Tags":{ "shape":"TagListType", - "documentation":"The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
" + "documentation":"The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
" }, "VersionIdsToStages":{ "shape":"SecretVersionsToStagesMapType", - "documentation":"A list of all of the currently assigned VersionStage
staging labels and the VersionId
that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.
A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels are considered deprecated and Secrets Manager can delete them.
Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging labels for rotation are:
AWSCURRENT
, which indicates the current version of the secret.
AWSPENDING
, which indicates the version of the secret that contains new secret information that will become the next current version when rotation finishes.
During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret version. To check if a secret version exists, call GetSecretValue.
AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
" }, "OwningService":{ "shape":"OwningServiceType", - "documentation":"Returns the name of the service that created this secret.
" + "documentation":"The name of the service that created this secret.
" }, "CreatedDate":{ "shape":"TimestampType", - "documentation":"The date you created the secret.
", + "documentation":"The date the secret was created.
", "box":true }, "PrimaryRegion":{ "shape":"RegionType", - "documentation":"Specifies the primary region for secret replication.
" + "documentation":"The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus
.
Describes a list of replication status objects as InProgress
, Failed
or InSync
.P
A list of the replicas of this secret and their status:
Failed
, which indicates that the replica was not created.
InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
InSync
, which indicates that the replica was created.
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
", + "documentation":"Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key.
", "exception":true }, "ErrorMessage":{"type":"string"}, @@ -675,14 +675,14 @@ "members":{ "Key":{ "shape":"FilterNameStringType", - "documentation":"Filters your list of secrets by a specific key.
" + "documentation":"The following are keys you can use:
description: Prefix match, not case-sensitive.
name: Prefix match, case-sensitive.
tag-key: Prefix match, case-sensitive.
tag-value: Prefix match, case-sensitive.
primary-region: Prefix match, case-sensitive.
all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
Filters your list of secrets by a specific value.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
The keyword to filter for.
You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
Allows you to add filters when you use the search function in Secrets Manager.
" + "documentation":"Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.
" }, "FilterNameStringType":{ "type":"string", @@ -716,41 +716,41 @@ "members":{ "PasswordLength":{ "shape":"PasswordLengthType", - "documentation":"The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
", + "documentation":"The length of the password. If you don't include this parameter, the default length is 32 characters.
", "box":true }, "ExcludeCharacters":{ "shape":"ExcludeCharactersType", - "documentation":"A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
" + "documentation":"A string of the characters that you don't want in the password.
" }, "ExcludeNumbers":{ "shape":"ExcludeNumbersType", - "documentation":"Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
", + "documentation":"Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
", "box":true }, "ExcludePunctuation":{ "shape":"ExcludePunctuationType", - "documentation":"Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
Specifies whether to exclude the following punctuation characters from the password: ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~
. If you don't include this switch, the password can contain punctuation.
Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
", + "documentation":"Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
", "box":true }, "ExcludeLowercase":{ "shape":"ExcludeLowercaseType", - "documentation":"Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
", + "documentation":"Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
", "box":true }, "IncludeSpace":{ "shape":"IncludeSpaceType", - "documentation":"Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
", + "documentation":"Specifies whether to include the space character. If you include this switch, the password can contain space characters.
", "box":true }, "RequireEachIncludedType":{ "shape":"RequireEachIncludedTypeType", - "documentation":"A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True
and the operation requires at least one of every character type.
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type.
", "box":true } } @@ -760,7 +760,7 @@ "members":{ "RandomPassword":{ "shape":"RandomPasswordType", - "documentation":"A string with the generated password.
" + "documentation":"A string with the password.
" } } }, @@ -770,7 +770,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret to retrieve the attached resource-based policy for.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" } } }, @@ -783,11 +783,11 @@ }, "Name":{ "shape":"NameType", - "documentation":"The friendly name of the secret that the resource-based policy was retrieved for.
" + "documentation":"The name of the secret that the resource-based policy was retrieved for.
" }, "ResourcePolicy":{ "shape":"NonEmptyResourcePolicyType", - "documentation":"A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
" + "documentation":"A JSON-formatted string that contains the permissions policy attached to the secret. For more information about permissions policies, see Authentication and access control for Secrets Manager.
" } } }, @@ -797,15 +797,15 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret to retrieve.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "VersionId":{ "shape":"SecretVersionIdType", - "documentation":"Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
This value is typically a UUID-type value with 32 hexadecimal digits.
" + "documentation":"The unique identifier of the version of the secret to retrieve. If you include both this parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
version.
This value is typically a UUID-type value with 32 hexadecimal digits.
" }, "VersionStage":{ "shape":"SecretVersionStageType", - "documentation":"Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and VersionId
, the two parameters must refer to the same secret version . If you don't specify either a VersionStage
or VersionId
, then the default is to perform the operation on the version with the VersionStage
value of AWSCURRENT
.
The staging label of the version of the secret to retrieve.
Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you include both this parameter and VersionId
, the two parameters must refer to the same secret version. If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the AWSCURRENT
version.
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
The decrypted secret value, if the secret value was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as a string, then this field is omitted. The secret value appears in SecretString
instead.
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString
parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
" + "documentation":"The decrypted secret value, if the secret value was originally provided as a string or through the Secrets Manager console.
If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure of key/value pairs.
" }, "VersionStages":{ "shape":"SecretVersionStagesType", @@ -838,7 +838,7 @@ }, "CreatedDate":{ "shape":"CreatedDateType", - "documentation":"The date and time that this version of the secret was created.
", + "documentation":"The date and time that this version of the secret was created. If you don't specify which version in VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
version.
You provided an invalid NextToken
value.
The NextToken
value is invalid.
You provided an invalid value for a parameter.
", + "documentation":"The parameter name is invalid value.
", "exception":true }, "InvalidRequestException":{ @@ -874,7 +874,7 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
You tried to perform the operation on a secret that's currently marked deleted.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
A parameter value is not valid for the current state of the resource.
Possible causes:
The secret is scheduled for deletion.
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
The request failed because it would exceed one of the Secrets Manager internal limits.
", + "documentation":"The request failed because it would exceed one of the Secrets Manager quotas.
", "exception":true }, "ListSecretVersionIdsRequest":{ @@ -903,20 +903,20 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret whose versions you want to list.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "MaxResults":{ "shape":"MaxResultsType", - "documentation":"(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecretVersionIds
again with the value from NextToken
.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecretVersionIds
again with this value.
(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
", + "documentation":"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.
", "box":true } } @@ -926,19 +926,19 @@ "members":{ "Versions":{ "shape":"SecretVersionsListType", - "documentation":"The list of the currently available versions of the specified secret.
" + "documentation":"A list of the versions of the secret.
" }, "NextToken":{ "shape":"NextTokenType", - "documentation":"If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
The Amazon Resource Name (ARN) for the secret.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret.
" }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret.
" + "documentation":"The name of the secret.
" } } }, @@ -947,16 +947,16 @@ "members":{ "MaxResults":{ "shape":"MaxResultsType", - "documentation":"(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (isn't null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
The number of results to include in the response.
If there are more results available, in the response, Secrets Manager includes NextToken
. To get the next results, call ListSecrets
again with the value from NextToken
.
(Optional) Use this parameter in a request if you receive a NextToken
response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken
response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call ListSecrets
again with this value.
Lists the secret request filters.
" + "documentation":"The filters to apply to the list of secrets.
" }, "SortOrder":{ "shape":"SortOrderType", @@ -973,7 +973,7 @@ }, "NextToken":{ "shape":"NextTokenType", - "documentation":"If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken
response element comes back empty (as null
).
Secrets Manager includes this value if there's more output available than what is included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a long list. To get the next results, call ListSecrets
again with this value.
You provided a resource-based policy with syntax errors.
", + "documentation":"The resource policy has syntax errors.
", "exception":true }, "MaxResultsType":{ @@ -1028,7 +1028,7 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.
", + "documentation":"The BlockPublicPolicy
parameter is set to true, and the resource policy did not prevent broad access to the secret.
Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret to attach the resource-based policy.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "ResourcePolicy":{ "shape":"NonEmptyResourcePolicyType", - "documentation":"A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.
" + "documentation":"A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
" }, "BlockPublicPolicy":{ "shape":"BooleanType", - "documentation":"(Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based policies that allow broad access to the secret.
Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
", "box":true } } @@ -1058,11 +1058,11 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"The ARN of the secret retrieved by the resource-based policy.
" + "documentation":"The ARN of the secret.
" }, "Name":{ "shape":"NameType", - "documentation":"The friendly name of the secret retrieved by the resource-based policy.
" + "documentation":"The name of the secret.
" } } }, @@ -1072,24 +1072,24 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret to add a new version to.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If the secret doesn't already exist, use CreateSecret
instead.
(Optional) Specifies a unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
or SecretBinary
values are the same as those in the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the SecretString
and SecretBinary
values are different from those in the request, then the request fails because you can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
" + "documentation":"The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
" }, "SecretString":{ "shape":"SecretStringType", - "documentation":"(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString
or SecretBinary
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
" + "documentation":"The text to encrypt and store in the new version of the secret.
You must include SecretBinary
or SecretString
, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
" }, "VersionStages":{ "shape":"SecretVersionStagesType", - "documentation":"(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging label AWSCURRENT
to this new version.
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then Secrets Manager removes the label from the other version and attaches it to this version. If you specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label AWSCURRENT
to this version.
The Amazon Resource Name (ARN) for the secret for which you just created a version.
" + "documentation":"The ARN of the secret.
" }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret for which you just created or updated a version.
" + "documentation":"The name of the secret.
" }, "VersionId":{ "shape":"SecretVersionIdType", - "documentation":"The unique identifier of the version of the secret you just created or updated.
" + "documentation":"The unique identifier of the version of the secret.
" }, "VersionStages":{ "shape":"SecretVersionStagesType", - "documentation":"The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process.
" + "documentation":"The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process.
" } } }, @@ -1136,11 +1136,11 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"Remove a secret by SecretId
from replica Regions.
The ARN or name of the secret.
" }, "RemoveReplicaRegions":{ "shape":"RemoveReplicaRegionListType", - "documentation":"Remove replication from specific Regions.
" + "documentation":"The Regions of the replicas to remove.
" } } }, @@ -1149,11 +1149,11 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"The secret ARN
removed from replication regions.
The ARN of the primary secret.
" }, "ReplicationStatus":{ "shape":"ReplicationStatusListType", - "documentation":"Describes the remaining replication status after you remove regions from the replication list.
" + "documentation":"The status of replicas for this secret after you remove Regions.
" } } }, @@ -1167,14 +1167,14 @@ "members":{ "Region":{ "shape":"RegionType", - "documentation":"Describes a single instance of Region objects.
" + "documentation":"A Region code. For a list of Region codes, see Name and code of Regions.
" }, "KmsKeyId":{ "shape":"KmsKeyIdType", - "documentation":"Can be an ARN
, Key ID
, or Alias
.
The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager
.
(Optional) Custom type consisting of a Region
(required) and the KmsKeyId
which can be an ARN
, Key ID
, or Alias
.
A custom type that specifies a Region
and the KmsKeyId
for a replica secret.
Use the Secret Id
to replicate a secret to regions.
The ARN or name of the secret to replicate.
" }, "AddReplicaRegions":{ "shape":"AddReplicaRegionListType", - "documentation":"Add Regions to replicate the secret.
" + "documentation":"A list of Regions in which to replicate the secret.
" }, "ForceOverwriteReplicaSecret":{ "shape":"BooleanType", - "documentation":"(Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region.
" + "documentation":"Specifies whether to overwrite a secret with the same name in the destination Region.
" } } }, @@ -1202,11 +1202,11 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"Replicate a secret based on the ReplicaRegionType
> consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
The ARN of the primary secret.
" }, "ReplicationStatus":{ "shape":"ReplicationStatusListType", - "documentation":"Describes the secret replication status as PENDING
, SUCCESS
or FAIL
.
The status of replication.
" } } }, @@ -1254,7 +1254,7 @@ "members":{ "Message":{"shape":"ErrorMessage"} }, - "documentation":"We can't find the resource that you asked for.
", + "documentation":"Secrets Manager can't find the resource that you asked for.
", "exception":true }, "RestoreSecretRequest":{ @@ -1263,7 +1263,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret to restore.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" } } }, @@ -1276,7 +1276,7 @@ }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret that was restored.
" + "documentation":"The name of the secret that was restored.
" } } }, @@ -1286,16 +1286,16 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret to rotate.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "ClientRequestToken":{ "shape":"ClientRequestTokenType", - "documentation":"(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId
of the new version.
A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation. This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You only need to specify this value if you implement your own retry logic and you want to ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
", "idempotencyToken":true }, "RotationLambdaARN":{ "shape":"RotationLambdaARNType", - "documentation":"(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
" + "documentation":"The ARN of the Lambda rotation function that can rotate the secret.
" }, "RotationRules":{ "shape":"RotationRulesType", @@ -1312,11 +1312,11 @@ }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret.
" + "documentation":"The name of the secret.
" }, "VersionId":{ "shape":"SecretVersionIdType", - "documentation":"The ID of the new version of the secret created by the rotation started by this request.
", + "documentation":"The ID of the new version of the secret.
", "box":true } } @@ -1359,7 +1359,7 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide.
" + "documentation":"The Amazon Resource Name (ARN) of the secret.
" }, "Name":{ "shape":"SecretNameType", @@ -1371,7 +1371,7 @@ }, "KmsKeyId":{ "shape":"KmsKeyIdType", - "documentation":"The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the SecretString
and SecretBinary
fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager
, for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
Response to StopReplicationToReplica
of a secret, based on the SecretId
.
The ARN of the primary secret.
" } } }, @@ -1532,7 +1532,7 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"Response StopReplicationToReplica
of a secret, based on the ARN,
.
The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
" } } }, @@ -1572,11 +1572,11 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "Tags":{ "shape":"TagListType", - "documentation":"The tags to attach to the secret. Each element in the list consists of a Key
and a Value
.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
" + "documentation":"The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key
and a Value
.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
" } } }, @@ -1595,11 +1595,11 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "TagKeys":{ "shape":"TagKeyListType", - "documentation":"A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
" + "documentation":"A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter requires a JSON text string argument.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
" } } }, @@ -1609,28 +1609,28 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "ClientRequestToken":{ "shape":"ClientRequestTokenType", - "documentation":"(Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.
Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.
If the ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created.
If a version with this value already exists and that version's SecretString
and SecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString
and SecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
(Optional) Specifies an updated user-provided description of the secret.
" + "documentation":"The description of the secret.
" }, "KmsKeyId":{ "shape":"KmsKeyIdType", - "documentation":"(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging Labels in the Amazon Web Services Secrets Manager User Guide.
You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
(Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
" + "documentation":"The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
" }, "SecretString":{ "shape":"SecretStringType", - "documentation":"(Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary
or SecretString
must have a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
" + "documentation":"The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
The ARN of the secret that was updated.
Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
The ARN of the secret that was updated.
" }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret that was updated.
" + "documentation":"The name of the secret that was updated.
" }, "VersionId":{ "shape":"SecretVersionIdType", - "documentation":"If a new version of the secret was created by this operation, then VersionId
contains the unique identifier of the new version.
If Secrets Manager created a new version of the secret during this operation, then VersionId
contains the unique identifier of the new version.
Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"The ARN or the name of the secret with the version and staging labelsto modify.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" }, "VersionStage":{ "shape":"SecretVersionStageType", @@ -1668,12 +1668,12 @@ }, "RemoveFromVersionId":{ "shape":"SecretVersionIdType", - "documentation":"Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", + "documentation":"The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.
", "box":true }, "MoveToVersionId":{ "shape":"SecretVersionIdType", - "documentation":"(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.
If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId
parameter.
The ARN of the secret with the modified staging label.
" + "documentation":"The ARN of the secret that was updated.
" }, "Name":{ "shape":"SecretNameType", - "documentation":"The friendly name of the secret with the modified staging label.
" + "documentation":"The name of the secret that was updated.
" } } }, @@ -1697,11 +1697,11 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"(Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
" + "documentation":"This field is reserved for internal use.
" }, "ResourcePolicy":{ "shape":"NonEmptyResourcePolicyType", - "documentation":"A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the CLI User Guide.publi
" + "documentation":"A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For example policies, see Permissions policy examples.
" } } }, @@ -1710,11 +1710,11 @@ "members":{ "PolicyValidationPassed":{ "shape":"BooleanType", - "documentation":"Returns a message stating that your Reource Policy passed validation.
" + "documentation":"True if your policy passes validation, otherwise false.
" }, "ValidationErrors":{ "shape":"ValidationErrorsType", - "documentation":"Returns an error message if your policy doesn't pass validatation.
" + "documentation":"Validation errors if your policy didn't pass validation.
" } } }, @@ -1737,5 +1737,5 @@ "member":{"shape":"ValidationErrorsEntry"} } }, - "documentation":"Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including downloading and installing them, see Tools for Amazon Web Services.
We recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the Amazon Web Services Secrets Manager User Guide.
Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
How examples are presented
The JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a response to HTTP query requests contain single, long strings without line breaks or white space formatting. The JSON shown in the examples displays the code formatted with both line breaks and white space to improve readability. When example input parameters can also cause long strings extending beyond the screen, you can insert line breaks to enhance readability. You should always submit the input as a single JSON text string.
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
" + "documentation":"Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.
API Version
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
As an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including downloading and installing them, see Tools for Amazon Web Services.
We recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the Amazon Web Services Secrets Manager User Guide.
Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.
Support and Feedback for Amazon Web Services Secrets Manager
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
How examples are presented
The JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a response to HTTP query requests contain single, long strings without line breaks or white space formatting. The JSON shown in the examples displays the code formatted with both line breaks and white space to improve readability. When example input parameters can also cause long strings extending beyond the screen, you can insert line breaks to enhance readability. You should always submit the input as a single JSON text string.
Logging API Requests
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
" } diff --git a/aws-java-sdk-models/src/main/resources/models/securityhub-2018-10-26-intermediate.json b/aws-java-sdk-models/src/main/resources/models/securityhub-2018-10-26-intermediate.json index 704f64668111..20a5909356d1 100644 --- a/aws-java-sdk-models/src/main/resources/models/securityhub-2018-10-26-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/securityhub-2018-10-26-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "EnumSetterOverload", "ClientMutationMethods", "ClientConstructors" ], + "deprecatedSuppressions" : [ "ClientConstructors", "ClientMutationMethods", "EnumSetterOverload" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/serverlessrepo-2017-09-08-intermediate.json b/aws-java-sdk-models/src/main/resources/models/serverlessrepo-2017-09-08-intermediate.json index f7931c8c4043..43703955a002 100644 --- a/aws-java-sdk-models/src/main/resources/models/serverlessrepo-2017-09-08-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/serverlessrepo-2017-09-08-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], + "deprecatedSuppressions" : [ "ClientConstructors", "ClientMutationMethods", "EnumSetterOverload" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/service-quotas-2019-06-24-intermediate.json b/aws-java-sdk-models/src/main/resources/models/service-quotas-2019-06-24-intermediate.json index 374ed40853f0..d4e7ddf1fe90 100644 --- a/aws-java-sdk-models/src/main/resources/models/service-quotas-2019-06-24-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/service-quotas-2019-06-24-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientConstructors", "ClientMutationMethods", "EnumSetterOverload" ], + "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/sesv2-2019-09-27-intermediate.json b/aws-java-sdk-models/src/main/resources/models/sesv2-2019-09-27-intermediate.json index faae747d29f0..ce6d9e101ef2 100644 --- a/aws-java-sdk-models/src/main/resources/models/sesv2-2019-09-27-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/sesv2-2019-09-27-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientConstructors", "ClientMutationMethods", "EnumSetterOverload" ], + "deprecatedSuppressions" : [ "EnumSetterOverload", "ClientMutationMethods", "ClientConstructors" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/ssm-incidents-2018-05-10-intermediate.json b/aws-java-sdk-models/src/main/resources/models/ssm-incidents-2018-05-10-intermediate.json index 93ddfabc386d..80d7af0a8b65 100644 --- a/aws-java-sdk-models/src/main/resources/models/ssm-incidents-2018-05-10-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/ssm-incidents-2018-05-10-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], + "deprecatedSuppressions" : [ "EnumSetterOverload", "ClientConstructors", "ClientMutationMethods" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/sso-oidc-2019-06-10-intermediate.json b/aws-java-sdk-models/src/main/resources/models/sso-oidc-2019-06-10-intermediate.json index 4b08b83c36a0..911da725adbb 100644 --- a/aws-java-sdk-models/src/main/resources/models/sso-oidc-2019-06-10-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/sso-oidc-2019-06-10-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "EnumSetterOverload", "ClientMutationMethods", "ClientConstructors" ], + "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/textract-2018-06-27-intermediate.json b/aws-java-sdk-models/src/main/resources/models/textract-2018-06-27-intermediate.json index d47495f151f5..6981a707a41f 100644 --- a/aws-java-sdk-models/src/main/resources/models/textract-2018-06-27-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/textract-2018-06-27-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], + "deprecatedSuppressions" : [ "ClientMutationMethods", "ClientConstructors", "EnumSetterOverload" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/timestream-query-2018-11-01-intermediate.json b/aws-java-sdk-models/src/main/resources/models/timestream-query-2018-11-01-intermediate.json index a63b575ac01e..edf9dd0bf49a 100644 --- a/aws-java-sdk-models/src/main/resources/models/timestream-query-2018-11-01-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/timestream-query-2018-11-01-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], + "deprecatedSuppressions" : [ "ClientMutationMethods", "ClientConstructors", "EnumSetterOverload" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/timestream-write-2018-11-01-intermediate.json b/aws-java-sdk-models/src/main/resources/models/timestream-write-2018-11-01-intermediate.json index f9b9f7631b7b..68eb1cae688d 100644 --- a/aws-java-sdk-models/src/main/resources/models/timestream-write-2018-11-01-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/timestream-write-2018-11-01-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "EnumSetterOverload", "ClientMutationMethods", "ClientConstructors" ], + "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/translate-2017-07-01-intermediate.json b/aws-java-sdk-models/src/main/resources/models/translate-2017-07-01-intermediate.json index e0403a539596..c6316d23197f 100644 --- a/aws-java-sdk-models/src/main/resources/models/translate-2017-07-01-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/translate-2017-07-01-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientConstructors", "ClientMutationMethods", "EnumSetterOverload" ], + "deprecatedSuppressions" : [ "ClientConstructors", "EnumSetterOverload", "ClientMutationMethods" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/wellarchitected-2020-03-31-intermediate.json b/aws-java-sdk-models/src/main/resources/models/wellarchitected-2020-03-31-intermediate.json index 7b9e55b916cc..562ea43be7d9 100644 --- a/aws-java-sdk-models/src/main/resources/models/wellarchitected-2020-03-31-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/wellarchitected-2020-03-31-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], + "deprecatedSuppressions" : [ "EnumSetterOverload", "ClientConstructors", "ClientMutationMethods" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-models/src/main/resources/models/wisdom-2020-10-19-intermediate.json b/aws-java-sdk-models/src/main/resources/models/wisdom-2020-10-19-intermediate.json index 49ccee91ed55..451e2ed3553c 100644 --- a/aws-java-sdk-models/src/main/resources/models/wisdom-2020-10-19-intermediate.json +++ b/aws-java-sdk-models/src/main/resources/models/wisdom-2020-10-19-intermediate.json @@ -20,7 +20,7 @@ "customServiceMetadata" : null, "customServiceNameForRequest" : null, "customSignerProvider" : null, - "deprecatedSuppressions" : [ "ClientConstructors", "EnumSetterOverload", "ClientMutationMethods" ], + "deprecatedSuppressions" : [ "ClientMutationMethods", "EnumSetterOverload", "ClientConstructors" ], "emitLegacyEnumSetterFor" : null, "operationModifiers" : null, "operationsWithResponseStreamContentLengthValidation" : null, diff --git a/aws-java-sdk-mq/pom.xml b/aws-java-sdk-mq/pom.xml index b8bbea1fce5d..044907f15299 100644 --- a/aws-java-sdk-mq/pom.xml +++ b/aws-java-sdk-mq/pom.xml @@ -5,7 +5,7 @@- * Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress. + * Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation. *
*
- * To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays
set to a
- * value greater than 0. This immediately rotates your secret and then enables the automatic schedule.
+ * To turn on automatic rotation again, call RotateSecret.
*
- * If you cancel a rotation while in progress, it can leave the VersionStage
labels in an unexpected
- * state. Depending on the step of the rotation in progress, you might need to remove the staging label
+ * If you cancel a rotation in progress, it can leave the VersionStage
labels in an unexpected state.
+ * Depending on the step of the rotation in progress, you might need to remove the staging label
* AWSPENDING
from the partially created version, specified by the VersionId
response
- * value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can
- * do by removing all staging labels from the new version VersionStage
field.
+ * value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can
+ * delete a version by removing all staging labels from it.
*
- * To successfully start a rotation, the staging label AWSPENDING
must be in one of the following
- * states:
- *
- * Not attached to any version at all - *
- *
- * Attached to the same version as the staging label AWSCURRENT
- *
- * If the staging label AWSPENDING
attached to a different version than the version with
- * AWSCURRENT
then the attempt to rotate fails.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:CancelRotateSecret - *
- *- * Related operations - *
- *- * To configure rotation for a secret or to manually trigger a rotation, use RotateSecret. - *
- *- * To get the rotation configuration details for a secret, use DescribeSecret. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *- * To list all of the versions currently associated with a secret, use ListSecretVersionIds. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important - * information needed to manage the secret. + * Creates a new secret. A secret is a set of credentials, such as a user name and password, that you store + * in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database + * or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the + * protected secret data and the important information needed to manage the secret. *
*
- * Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret.
- * Each version contains a copy of the encrypted secret data. Each version is associated with one or more
- * "staging labels" that identify where the version is in the rotation cycle. The
- * SecretVersionsToStages
field of the secret contains the mapping of staging labels to the active
- * versions of the secret. Versions without a staging label are considered deprecated and not included in the list.
+ * For information about creating a secret in the console, see Create a
+ * secret.
*
- * You provide the secret data to be encrypted by putting text in either the SecretString
parameter or
- * binary data in the SecretBinary
parameter, but not both. If you include SecretString
or
- * SecretBinary
then Secrets Manager also creates an initial secret version and automatically attaches
- * the staging label AWSCURRENT
to the new version.
+ * To create a secret, you can provide the secret value to be encrypted in either the SecretString
+ * parameter or the SecretBinary
parameter, but not both. If you include SecretString
or
+ * SecretBinary
then Secrets Manager creates an initial secret version and automatically attaches the
+ * staging label AWSCURRENT
to it.
*
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:CreateSecret - *
- *- * kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the - * secret. You do not need this permission to use the account default Amazon Web Services managed CMK for Secrets - * Manager. - *
- *- * kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do - * not need this permission to use the account default Amazon Web Services managed CMK for Secrets Manager. - *
- *
- * secretsmanager:TagResource - needed only if you include the Tags
parameter.
- *
- * Related operations - *
- *- * To delete a secret, use DeleteSecret. - *
- *- * To modify an existing secret, use UpdateSecret. - *
- *- * To create a new version of a secret, use PutSecretValue. - *
- *- * To retrieve the encrypted secure string and secure binary values, use GetSecretValue. - *
- *
- * To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure
- * string and secure binary values.
+ * If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates
+ * it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use
+ * aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant
+ * delay in returning the result.
*
- * To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine
- * the SecretVersionsToStages
response value.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS
+ * key.
*
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Deletes the resource-based permission policy attached to the secret. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DeleteResourcePolicy - *
- *- * Related operations - *
- *- * To attach a resource policy to a secret, use PutResourcePolicy. - *
- *- * To retrieve the current resource-based policy attached to a secret, use GetResourcePolicy. + * Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use + * PutResourcePolicy. *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*
- * Deletes an entire secret and all of the versions. You can optionally include a recovery window during which you
- * can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets
- * Manager attaches a DeletionDate
stamp to the secret that specifies the end of the recovery window.
- * At the end of the recovery window, Secrets Manager deletes the secret permanently.
+ * Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the
+ * secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a
+ * DeletionDate
stamp to the secret that specifies the end of the recovery window. At the end of the
+ * recovery window, Secrets Manager deletes the secret permanently.
*
- * At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
- * and cancel the deletion of the secret.
- *
- * You cannot access the encrypted secret information in any secret scheduled for deletion. If you need to access - * that information, you must cancel the deletion with RestoreSecret and then retrieve the information. + * For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html. *
- *
- * There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the
- * VersionStage
field of a version. That marks the version as deprecated and allows Secrets Manager to
- * delete it as needed. Versions without any staging labels do not show up in ListSecretVersionIds unless you
- * specify IncludeDeprecated
.
- *
- * The permanent secret deletion at the end of the waiting period is performed as a background task with low - * priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to + * Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with + * low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to * occur. *
- *- * Minimum permissions - *
*- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DeleteSecret - *
- *
- * Related operations
+ * At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
+ * and cancel the deletion of the secret.
*
- * To create a secret, use CreateSecret. + * In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, + * first cancel the deletion with RestoreSecret and then retrieve the information. *
- *- * To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields - * populated with a value in the response. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DescribeSecret + * Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns + * fields that have a value in the response. *
- *- * Related operations - *
- *- * To create a secret, use CreateSecret. - *
- *- * To modify a secret, use UpdateSecret. - *
- *- * To retrieve the encrypted secret information in a version of the secret, use GetSecretValue. - *
- *- * To list all of the secrets in the Amazon Web Services account, use ListSecrets. - *
- *- * Generates a random password of the specified complexity. This operation is intended for use in the Lambda - * rotation function. Per best practice, we recommend that you specify the maximum length and include every - * character type that the system you are generating a password for can support. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: + * Generates a random password. We recommend that you specify the maximum length and include every character type + * that the system you are generating a password for can support. *
- *- * secretsmanager:GetRandomPassword - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request - * string input and response output displays formatted code with white space and line breaks for better readability. - * Submit your input as a single line JSON string. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: + * Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about + * permissions policies attached to a secret, see Permissions policies attached to a secret. *
- *- * secretsmanager:GetResourcePolicy - *
- *- * Related operations - *
- *- * To attach a resource policy to a secret, use PutResourcePolicy. - *
- *- * To delete the resource-based policy attached to a secret, use DeleteResourcePolicy. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Minimum permissions + * For information about retrieving the secret value in the console, see Retrieve secrets. *
*
- * To run this command, you must have the following permissions:
+ * To run this command, you must have secretsmanager:GetSecretValue
permissions. If the secret is
+ * encrypted using a customer-managed key instead of the Amazon Web Services managed key
+ * aws/secretsmanager
, then you also need kms:Decrypt
permissions for that key.
*
- * secretsmanager:GetSecretValue - *
- *- * kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You - * do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager. - *
- *- * Related operations - *
- *- * To create a new version of the secret with different encrypted information, use PutSecretValue. - *
- *- * To retrieve the non-encrypted details for the secret, use DescribeSecret. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*
- * Lists all of the versions attached to the specified secret. The output does not include the
- * SecretString
or SecretBinary
fields. By default, the list includes only versions that
- * have at least one staging label in VersionStage
attached.
+ * Lists the versions for a secret.
*
- * Always check the NextToken
response parameter when calling any of the List*
operations.
- * These operations can occasionally return an empty or shorter than expected list of results even when there more
- * results become available. When this happens, the NextToken
response parameter contains a value to
- * pass to the next call to the same API to request the next part of the list.
+ * To list the secrets in the account, use ListSecrets.
*
- * Minimum permissions
+ * To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
*
- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:ListSecretVersionIds - *
- *- * Related operations + * Minimum permissions *
- *
- * To list the secrets in an account, use ListSecrets.
+ * To run this command, you must have secretsmanager:ListSecretVersionIds
permissions.
*
NextToken
value.
+ * The NextToken
value is invalid.
* @throws ResourceNotFoundException
- * We can't find the resource that you asked for.
+ * Secrets Manager can't find the resource that you asked for.
* @throws InternalServiceErrorException
* An error occurred on the server side.
* @throws InvalidParameterException
- * You provided an invalid value for a parameter.
+ * The parameter name is invalid value.
* @sample AWSSecretsManager.ListSecretVersionIds
* @see AWS API Documentation
@@ -848,49 +504,32 @@ public interface AWSSecretsManager {
/**
*
- * Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the
- * versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields
- * SecretString
and SecretBinary
are not included in the output. To get that information,
- * call the GetSecretValue operation.
- *
- * Always check the NextToken
response parameter when calling any of the List*
operations.
- * These operations can occasionally return an empty or shorter than expected list of results even when there more
- * results become available. When this happens, the NextToken
response parameter contains a value to
- * pass to the next call to the same API to request the next part of the list.
+ * Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account.
*
- * Minimum permissions + * To list the versions of a secret, use ListSecretVersionIds. *
*
- * To run this command, you must have the following permissions:
+ * To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
*
- * secretsmanager:ListSecrets + * For information about finding secrets in the console, see Enhanced search + * capabilities for secrets in Secrets Manager. *
- *- * Related operations + * Minimum permissions *
- *
- * To list the versions attached to a secret, use ListSecretVersionIds.
+ * To run this command, you must have secretsmanager:ListSecrets
permissions.
*
NextToken
value.
+ * The NextToken
value is invalid.
* @throws InternalServiceErrorException
* An error occurred on the server side.
* @sample AWSSecretsManager.ListSecrets
@@ -901,217 +540,96 @@ public interface AWSSecretsManager {
/**
*
- * Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is
- * optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name
- * (ARN) in the policy statement's Resources
element. You can also use a combination of both
- * identity-based and resource-based policies. The affected users and roles receive the permissions that are
- * permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for Amazon Web Services Secrets Manager. For the complete description of the
- * Amazon Web Services policy syntax and grammar, see IAM JSON Policy Reference in
- * the IAM User Guide.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:PutResourcePolicy - *
- *- * Related operations - *
- *- * To retrieve the resource policy attached to a secret, use GetResourcePolicy. - *
- *- * To delete the resource-based policy attached to a secret, use DeleteResourcePolicy. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *- * Possible causes: - *
- *- * You tried to perform the operation on a secret that's currently marked deleted. - *
- *- * You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and - * you didn't include such an ARN as a parameter in this call. - *
- *
- * Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and
- * attaches it to the secret. The version can contain a new SecretString
value or a new
- * SecretBinary
value. You can also specify the staging labels that are initially attached to the new
- * version.
- *
- * We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10
- * minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager
- * removes outdated versions when there are more than 100, but it does not remove versions created less than 24
- * hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than
- * Secrets Manager removes, and you will reach the quota for secret versions.
- *
- * If this operation creates the first version for the secret then Secrets Manager automatically attaches the
- * staging label AWSCURRENT
to the new version.
- *
- * If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label
- * AWSCURRENT
to this new version.
- *
- * If this operation moves the staging label AWSCURRENT
from another version to this version, then
- * Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that
- * AWSCURRENT
was removed from.
- *
- * This operation is idempotent. If a version with a VersionId
with the same value as the
- * ClientRequestToken
parameter already exists and you specify the same secret data, the operation
- * succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot
- * modify an existing version; you can only create new ones.
- *
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:PutSecretValue - *
- *- * kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the - * secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets - * Manager. + * For information about attaching a policy in the console, see Attach a permissions policy to a secret. *
- *+ * Possible causes: + *
+ *+ * The secret is scheduled for deletion. + *
+ *+ * You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and + * you didn't include such an ARN as a parameter in this call. + *
+ *BlockPublicPolicy
parameter is set to true, and the resource policy did not prevent
+ * broad access to the secret.
+ * @sample AWSSecretsManager.PutResourcePolicy
+ * @see AWS API Documentation
+ */
+ PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest);
+
+ /**
*
- * Related operations
+ * Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a
+ * new SecretString
value or a new SecretBinary
value.
*
- * To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
+ * We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10
+ * minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager
+ * removes outdated versions when there are more than 100, but it does not remove versions created less than 24
+ * hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than
+ * Secrets Manager removes, and you will reach the quota for secret versions.
*
- * To create a secret, use CreateSecret.
+ * You can specify the staging labels to attach to the new version in VersionStages
. If you don't
+ * include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version. If this operation creates the first version for the secret, then Secrets
+ * Manager automatically attaches the staging label AWSCURRENT
to it .
*
- * To get the details for a secret, use DescribeSecret.
+ * If this operation moves the staging label AWSCURRENT
from another version to this version, then
+ * Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that
+ * AWSCURRENT
was removed from.
*
- * To list the versions attached to a secret, use ListSecretVersionIds.
+ * This operation is idempotent. If a version with a VersionId
with the same value as the
+ * ClientRequestToken
parameter already exists, and you specify the same secret data, the operation
+ * succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't
+ * modify an existing version; you can only create new ones.
*
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Remove regions from replication. + * For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify. *
* * @param removeRegionsFromReplicationRequest * @return Result of the RemoveRegionsFromReplication operation returned by the service. * @throws ResourceNotFoundException - * We can't find the resource that you asked for. + * Secrets Manager can't find the resource that you asked for. * @throws InvalidRequestException - * You provided a parameter value that is not valid for the current state of the resource. + * A parameter value is not valid for the current state of the resource. ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions. + * Replicates the secret to a new Regions. See Multi-Region secrets. *
* * @param replicateSecretToRegionsRequest * @return Result of the ReplicateSecretToRegions operation returned by the service. * @throws ResourceNotFoundException - * We can't find the resource that you asked for. + * Secrets Manager can't find the resource that you asked for. * @throws InvalidRequestException - * You provided a parameter value that is not valid for the current state of the resource. + * A parameter value is not valid for the current state of the resource. ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*
- * Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. This makes the
- * secret accessible to query once again.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:RestoreSecret - *
- *- * Related operations - *
- *
- * To delete a secret, use DeleteSecret.
+ * Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. You can access a
+ * secret again after it has been restored.
*
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Configures and starts the asynchronous process of rotating this secret. If you include the configuration - * parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not - * include the configuration parameters, the operation starts a rotation with the values already stored in the - * secret. After the rotation completes, the protected service and its clients all use the new version of the - * secret. - *
- *
- * This required configuration information includes the ARN of an Amazon Web Services Lambda function and
- * optionally, the time between scheduled rotations. The Lambda rotation function creates a new version of the
- * secret and creates or updates the credentials on the protected service to match. After testing the new
- * credentials, the function marks the new secret with the staging label AWSCURRENT
so that your
- * clients all immediately begin to use the new version. For more information about rotating secrets and how to
- * configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in
- * Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
- *
- * Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date - * by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the - * hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards - * the top of the hour and influenced by a variety of factors that help distribute load. + * Configures and starts the asynchronous process of rotating the secret. *
*- * The rotation function must end with the versions of the secret in one of two states: + * If you include the configuration parameters, the operation sets the values for the secret and then immediately + * starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the + * values already stored in the secret. For more information about rotation, see Rotate secrets. *
- *
- * The AWSPENDING
and AWSCURRENT
staging labels are attached to the same version of the
- * secret, or
+ * To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule for the
+ * rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials
+ * on the database or service to match. After testing the new credentials, the function marks the new secret version
+ * with the staging label AWSCURRENT
. Then anyone who retrieves the secret gets the new version. For
+ * more information, see How rotation
+ * works.
*
- * The AWSPENDING
staging label is not attached to any version of the secret.
+ * When rotation is successful, the AWSPENDING
staging label might be attached to the same version as
+ * the AWSCURRENT
version, or it might not be attached to any version.
*
* If the AWSPENDING
staging label is present but not attached to the same version as
- * AWSCURRENT
then any later invocation of RotateSecret
assumes that a previous rotation
+ * AWSCURRENT
, then any later invocation of RotateSecret
assumes that a previous rotation
* request is still in progress and returns an error.
*
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:RotateSecret - *
- *- * lambda:InvokeFunction (on the function specified in the secret's metadata) - *
- *- * Related operations - *
- *- * To list the secrets in your account, use ListSecrets. - *
- *- * To get the details for a version of a secret, use DescribeSecret. - *
- *- * To create a new version of a secret, use CreateSecret. - *
- *
- * To attach staging labels to or remove staging labels from a version of a secret, use
- * UpdateSecretVersionStage.
+ * To run this command, you must have secretsmanager:RotateSecret
permissions and
+ * lambda:InvokeFunction
permissions on the function specified in the secret's metadata.
*
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Removes the secret from replication and promotes the secret to a regional secret in the replica Region. + * Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret + * in the replica Region. + *
+ *+ * You must call this operation from the Region in which you want to promote the replica to a primary secret. *
* * @param stopReplicationToReplicaRequest * @return Result of the StopReplicationToReplica operation returned by the service. * @throws ResourceNotFoundException - * We can't find the resource that you asked for. + * Secrets Manager can't find the resource that you asked for. * @throws InvalidRequestException - * You provided a parameter value that is not valid for the current state of the resource. + * A parameter value is not valid for the current state of the resource. ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of - * the secret's overall metadata, and are not associated with any specific version of the secret. This operation - * only appends tags to the existing list of tags. To remove tags, you must use UntagResource. + * Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They + * are not associated with specific versions of the secret. This operation appends tags to the existing list of + * tags. *
*- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
*- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:TagResource - *
- *- * Related operations - *
- *- * To remove one or more tags from the collection attached to a secret, use UntagResource. - *
- *- * To view the list of tags attached to a secret, use DescribeSecret. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Removes one or more tags from the specified secret. + * Removes specific tags from a secret. *
** This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the @@ -1555,48 +971,20 @@ public interface AWSSecretsManager { * blocked and returns an Access Denied error. *
*- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UntagResource - *
- *- * Related operations - *
- *- * To add one or more tags to the collection attached to a secret, use TagResource. - *
- *- * To view the list of tags attached to a secret, use DescribeSecret. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Modifies many of the details of the specified secret. - *
- *- * To change the secret value, you can also use PutSecretValue. + * Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can + * also use PutSecretValue. *
** To change the rotation configuration of a secret, use RotateSecret instead. @@ -1632,120 +1018,45 @@ public interface AWSSecretsManager { * created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more * versions than Secrets Manager removes, and you will reach the quota for secret versions. *
- *
- * The Secrets Manager console uses only the SecretString
parameter and therefore limits you to
- * encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret,
- * you must use either the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
- *
- * If a version with a VersionId
with the same value as the ClientRequestToken
parameter
- * already exists, the operation results in an error. You cannot modify an existing version, you can only create a
- * new version.
- *
* If you include SecretString
or SecretBinary
to create a new secret version, Secrets
* Manager automatically attaches the staging label AWSCURRENT
to the new version.
*
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UpdateSecret - *
- *- * kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do - * not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager. - *
- *- * kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need - * this permission to use the account's Amazon Web Services managed CMK for Secrets Manager. - *
- *- * Related operations - *
- *
- * To create a new secret, use CreateSecret.
+ * If you call this operation with a VersionId
that matches an existing version's
+ * ClientRequestToken
, the operation results in an error. You can't modify an existing version, you can
+ * only create a new version. To remove a version, remove all staging labels from it. See
+ * UpdateSecretVersionStage.
*
- * To add only a new version to an existing secret, use PutSecretValue.
+ * If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates
+ * it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use
+ * aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant
+ * delay in returning the result.
*
- * To get the details for a secret, use DescribeSecret.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed key.
*
- * To list the versions contained in a secret, use ListSecretVersionIds.
+ * To run this command, you must have secretsmanager:UpdateSecret
permissions. If you use a customer
+ * managed key, you must also have kms:GenerateDataKey
and kms:Decrypt
permissions .
*
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it - * progresses through the secret rotation process. You can attach a staging label to only one version of a secret at - * a time. If a staging label to be added is already attached to another version, then it is moved--removed from the - * other version first and then attached to this one. For more information about staging labels, see Staging - * Labels in the Amazon Web Services Secrets Manager User Guide. + * Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a + * version as it progresses through the secret rotation process. Each staging label can be attached to only one + * version at a time. To add a staging label to a version when it is already attached to another version, Secrets + * Manager first removes it from the other version first and then attaches it to this one. For more information + * about versions and staging labels, see Concepts: + * Version. *
*
* The staging labels that you specify in the VersionStage
parameter are added to the existing list of
- * staging labels--they don't replace it.
+ * staging labels for the version.
*
* You can move the AWSCURRENT
staging label to this version by including it in this call.
@@ -1803,46 +1115,22 @@ public interface AWSSecretsManager {
* If this action results in the last label being removed from a version, then the version is considered to be
* 'deprecated' and can be deleted by Secrets Manager.
*
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UpdateSecretVersionStage - *
- *- * Related operations - *
- *
- * To get the list of staging labels that are currently associated with a version of a secret, use
- * DescribeSecret
and examine the SecretVersionsToStages
response value.
- *
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Validates that the resource policy does not grant a wide range of IAM principals access to your secret. The JSON - * request string input and response output displays formatted code with white space and line breaks for better - * readability. Submit your input as a single line JSON string. A resource-based policy is optional for secrets. + * Validates that a resource policy does not grant a wide range of principals access to your secret. A + * resource-based policy is optional for secrets. *
*- * The API performs three checks when validating the secret: + * The API performs three checks when validating the policy: *
** Sends a call to Zelkova, an automated reasoning engine, to ensure your Resource Policy does not allow broad access to your - * secret. + * >Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your + * secret, for example policies that use a wildcard for the principal. *
*- * Minimum Permissions - *
- *- * You must have the permissions required to access the following APIs: - *
- *
- * secretsmanager:PutResourcePolicy
- *
- * secretsmanager:ValidateResourcePolicy
- *
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress. + * Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation. *
*
- * To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays
set to a
- * value greater than 0. This immediately rotates your secret and then enables the automatic schedule.
+ * To turn on automatic rotation again, call RotateSecret.
*
- * If you cancel a rotation while in progress, it can leave the VersionStage
labels in an unexpected
- * state. Depending on the step of the rotation in progress, you might need to remove the staging label
+ * If you cancel a rotation in progress, it can leave the VersionStage
labels in an unexpected state.
+ * Depending on the step of the rotation in progress, you might need to remove the staging label
* AWSPENDING
from the partially created version, specified by the VersionId
response
- * value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can
- * do by removing all staging labels from the new version VersionStage
field.
+ * value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can
+ * delete a version by removing all staging labels from it.
*
- * To successfully start a rotation, the staging label AWSPENDING
must be in one of the following
- * states:
- *
- * Not attached to any version at all - *
- *
- * Attached to the same version as the staging label AWSCURRENT
- *
- * If the staging label AWSPENDING
attached to a different version than the version with
- * AWSCURRENT
then the attempt to rotate fails.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:CancelRotateSecret - *
- *- * Related operations - *
- *- * To configure rotation for a secret or to manually trigger a rotation, use RotateSecret. - *
- *- * To get the rotation configuration details for a secret, use DescribeSecret. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *- * To list all of the versions currently associated with a secret, use ListSecretVersionIds. - *
- *- * Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress. + * Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation. *
*
- * To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays
set to a
- * value greater than 0. This immediately rotates your secret and then enables the automatic schedule.
+ * To turn on automatic rotation again, call RotateSecret.
*
- * If you cancel a rotation while in progress, it can leave the VersionStage
labels in an unexpected
- * state. Depending on the step of the rotation in progress, you might need to remove the staging label
+ * If you cancel a rotation in progress, it can leave the VersionStage
labels in an unexpected state.
+ * Depending on the step of the rotation in progress, you might need to remove the staging label
* AWSPENDING
from the partially created version, specified by the VersionId
response
- * value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can
- * do by removing all staging labels from the new version VersionStage
field.
+ * value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can
+ * delete a version by removing all staging labels from it.
*
- * To successfully start a rotation, the staging label AWSPENDING
must be in one of the following
- * states:
- *
- * Not attached to any version at all - *
- *
- * Attached to the same version as the staging label AWSCURRENT
- *
- * If the staging label AWSPENDING
attached to a different version than the version with
- * AWSCURRENT
then the attempt to rotate fails.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:CancelRotateSecret - *
- *- * Related operations - *
- *- * To configure rotation for a secret or to manually trigger a rotation, use RotateSecret. - *
- *- * To get the rotation configuration details for a secret, use DescribeSecret. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *- * To list all of the versions currently associated with a secret, use ListSecretVersionIds. - *
- *- * Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important - * information needed to manage the secret. - *
- *
- * Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret.
- * Each version contains a copy of the encrypted secret data. Each version is associated with one or more
- * "staging labels" that identify where the version is in the rotation cycle. The
- * SecretVersionsToStages
field of the secret contains the mapping of staging labels to the active
- * versions of the secret. Versions without a staging label are considered deprecated and not included in the list.
- *
- * You provide the secret data to be encrypted by putting text in either the SecretString
parameter or
- * binary data in the SecretBinary
parameter, but not both. If you include SecretString
or
- * SecretBinary
then Secrets Manager also creates an initial secret version and automatically attaches
- * the staging label AWSCURRENT
to the new version.
- *
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:CreateSecret - *
- *- * kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the - * secret. You do not need this permission to use the account default Amazon Web Services managed CMK for Secrets - * Manager. - *
- *- * kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do - * not need this permission to use the account default Amazon Web Services managed CMK for Secrets Manager. - *
- *
- * secretsmanager:TagResource - needed only if you include the Tags
parameter.
+ * Creates a new secret. A secret is a set of credentials, such as a user name and password, that you store
+ * in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database
+ * or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the
+ * protected secret data and the important information needed to manage the secret.
*
- * Related operations + * For information about creating a secret in the console, see Create a + * secret. *
- *
- * To delete a secret, use DeleteSecret.
+ * To create a secret, you can provide the secret value to be encrypted in either the SecretString
+ * parameter or the SecretBinary
parameter, but not both. If you include SecretString
or
+ * SecretBinary
then Secrets Manager creates an initial secret version and automatically attaches the
+ * staging label AWSCURRENT
to it.
*
- * To modify an existing secret, use UpdateSecret.
+ * If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates
+ * it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use
+ * aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant
+ * delay in returning the result.
*
- * To create a new version of a secret, use PutSecretValue.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS
+ * key.
*
- * To retrieve the encrypted secure string and secure binary values, use GetSecretValue. - *
- *- * To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure - * string and secure binary values. - *
- *
- * To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine
- * the SecretVersionsToStages
response value.
- *
- * Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important - * information needed to manage the secret. - *
- *
- * Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret.
- * Each version contains a copy of the encrypted secret data. Each version is associated with one or more
- * "staging labels" that identify where the version is in the rotation cycle. The
- * SecretVersionsToStages
field of the secret contains the mapping of staging labels to the active
- * versions of the secret. Versions without a staging label are considered deprecated and not included in the list.
- *
- * You provide the secret data to be encrypted by putting text in either the SecretString
parameter or
- * binary data in the SecretBinary
parameter, but not both. If you include SecretString
or
- * SecretBinary
then Secrets Manager also creates an initial secret version and automatically attaches
- * the staging label AWSCURRENT
to the new version.
- *
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
+ * Creates a new secret. A secret is a set of credentials, such as a user name and password, that you store
+ * in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database
+ * or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the
+ * protected secret data and the important information needed to manage the secret.
*
+ * For information about creating a secret in the console, see Create a + * secret. *
*
- * Minimum permissions
+ * To create a secret, you can provide the secret value to be encrypted in either the SecretString
+ * parameter or the SecretBinary
parameter, but not both. If you include SecretString
or
+ * SecretBinary
then Secrets Manager creates an initial secret version and automatically attaches the
+ * staging label AWSCURRENT
to it.
*
- * To run this command, you must have the following permissions:
+ * If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates
+ * it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use
+ * aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant
+ * delay in returning the result.
*
- * secretsmanager:CreateSecret
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS
+ * key.
*
- * kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the - * secret. You do not need this permission to use the account default Amazon Web Services managed CMK for Secrets - * Manager. - *
- *- * kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do - * not need this permission to use the account default Amazon Web Services managed CMK for Secrets Manager. - *
- *
- * secretsmanager:TagResource - needed only if you include the Tags
parameter.
- *
- * Related operations - *
- *- * To delete a secret, use DeleteSecret. - *
- *- * To modify an existing secret, use UpdateSecret. - *
- *- * To create a new version of a secret, use PutSecretValue. - *
- *- * To retrieve the encrypted secure string and secure binary values, use GetSecretValue. - *
- *- * To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure - * string and secure binary values. - *
- *
- * To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine
- * the SecretVersionsToStages
response value.
- *
- * Deletes the resource-based permission policy attached to the secret. + * Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use + * PutResourcePolicy. *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DeleteResourcePolicy - *
- *- * Related operations - *
- *- * To attach a resource policy to a secret, use PutResourcePolicy. - *
- *- * To retrieve the current resource-based policy attached to a secret, use GetResourcePolicy. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *- * Deletes the resource-based permission policy attached to the secret. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DeleteResourcePolicy - *
- *- * Related operations - *
- *- * To attach a resource policy to a secret, use PutResourcePolicy. - *
- *- * To retrieve the current resource-based policy attached to a secret, use GetResourcePolicy. + * Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use + * PutResourcePolicy. *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *
- * Deletes an entire secret and all of the versions. You can optionally include a recovery window during which you
- * can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets
- * Manager attaches a DeletionDate
stamp to the secret that specifies the end of the recovery window.
- * At the end of the recovery window, Secrets Manager deletes the secret permanently.
- *
- * At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
- * and cancel the deletion of the secret.
+ * Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the
+ * secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a
+ * DeletionDate
stamp to the secret that specifies the end of the recovery window. At the end of the
+ * recovery window, Secrets Manager deletes the secret permanently.
*
- * You cannot access the encrypted secret information in any secret scheduled for deletion. If you need to access - * that information, you must cancel the deletion with RestoreSecret and then retrieve the information. + * For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html. *
- *
- * There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the
- * VersionStage
field of a version. That marks the version as deprecated and allows Secrets Manager to
- * delete it as needed. Versions without any staging labels do not show up in ListSecretVersionIds unless you
- * specify IncludeDeprecated
.
- *
- * The permanent secret deletion at the end of the waiting period is performed as a background task with low - * priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to + * Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with + * low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to * occur. *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DeleteSecret - *
- *- * Related operations - *
- *
- * To create a secret, use CreateSecret.
+ * At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
+ * and cancel the deletion of the secret.
*
- * To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret. + * In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, + * first cancel the deletion with RestoreSecret and then retrieve the information. *
- *
- * Deletes an entire secret and all of the versions. You can optionally include a recovery window during which you
- * can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets
- * Manager attaches a DeletionDate
stamp to the secret that specifies the end of the recovery window.
- * At the end of the recovery window, Secrets Manager deletes the secret permanently.
+ * Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the
+ * secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a
+ * DeletionDate
stamp to the secret that specifies the end of the recovery window. At the end of the
+ * recovery window, Secrets Manager deletes the secret permanently.
*
- * At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
- * and cancel the deletion of the secret.
- *
- * You cannot access the encrypted secret information in any secret scheduled for deletion. If you need to access - * that information, you must cancel the deletion with RestoreSecret and then retrieve the information. + * For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html. *
- *
- * There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the
- * VersionStage
field of a version. That marks the version as deprecated and allows Secrets Manager to
- * delete it as needed. Versions without any staging labels do not show up in ListSecretVersionIds unless you
- * specify IncludeDeprecated
.
- *
- * The permanent secret deletion at the end of the waiting period is performed as a background task with low - * priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to + * Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with + * low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to * occur. *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DeleteSecret - *
- *
- * Related operations
+ * At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
+ * and cancel the deletion of the secret.
*
- * To create a secret, use CreateSecret. + * In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, + * first cancel the deletion with RestoreSecret and then retrieve the information. *
- *- * To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret. - *
- *- * Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields - * populated with a value in the response. - *
- *- * Minimum permissions + * Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns + * fields that have a value in the response. *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DescribeSecret - *
- *- * Related operations - *
- *- * To create a secret, use CreateSecret. - *
- *- * To modify a secret, use UpdateSecret. - *
- *- * To retrieve the encrypted secret information in a version of the secret, use GetSecretValue. - *
- *- * To list all of the secrets in the Amazon Web Services account, use ListSecrets. - *
- *- * Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields - * populated with a value in the response. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DescribeSecret - *
- *- * Related operations - *
- *- * To create a secret, use CreateSecret. + * Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns + * fields that have a value in the response. *
- *- * To modify a secret, use UpdateSecret. - *
- *- * To retrieve the encrypted secret information in a version of the secret, use GetSecretValue. - *
- *- * To list all of the secrets in the Amazon Web Services account, use ListSecrets. - *
- *- * Generates a random password of the specified complexity. This operation is intended for use in the Lambda - * rotation function. Per best practice, we recommend that you specify the maximum length and include every - * character type that the system you are generating a password for can support. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:GetRandomPassword + * Generates a random password. We recommend that you specify the maximum length and include every character type + * that the system you are generating a password for can support. *
- *- * Generates a random password of the specified complexity. This operation is intended for use in the Lambda - * rotation function. Per best practice, we recommend that you specify the maximum length and include every - * character type that the system you are generating a password for can support. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: + * Generates a random password. We recommend that you specify the maximum length and include every character type + * that the system you are generating a password for can support. *
- *- * secretsmanager:GetRandomPassword - *
- *- * Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request - * string input and response output displays formatted code with white space and line breaks for better readability. - * Submit your input as a single line JSON string. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:GetResourcePolicy - *
- *- * Related operations - *
- *- * To attach a resource policy to a secret, use PutResourcePolicy. - *
- *- * To delete the resource-based policy attached to a secret, use DeleteResourcePolicy. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *- * Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request - * string input and response output displays formatted code with white space and line breaks for better readability. - * Submit your input as a single line JSON string. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:GetResourcePolicy - *
- *- * Related operations - *
- *- * To attach a resource policy to a secret, use PutResourcePolicy. - *
- *- * To delete the resource-based policy attached to a secret, use DeleteResourcePolicy. + * Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about + * permissions policies attached to a secret, see Permissions policies attached to a secret. *
- *- * To list all of the currently available secrets, use ListSecrets. + * Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about + * permissions policies attached to a secret, see Permissions policies attached to a secret. *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:GetSecretValue - *
- *- * kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You - * do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager. - *
- *- * Related operations - *
- *- * To create a new version of the secret with different encrypted information, use PutSecretValue. + * For information about retrieving the secret value in the console, see Retrieve secrets. *
- *
- * To retrieve the non-encrypted details for the secret, use DescribeSecret.
+ * To run this command, you must have secretsmanager:GetSecretValue
permissions. If the secret is
+ * encrypted using a customer-managed key instead of the Amazon Web Services managed key
+ * aws/secretsmanager
, then you also need kms:Decrypt
permissions for that key.
*
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:GetSecretValue - *
- *- * kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You - * do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager. - *
- *- * Related operations - *
- *- * To create a new version of the secret with different encrypted information, use PutSecretValue. + * For information about retrieving the secret value in the console, see Retrieve secrets. *
- *
- * To retrieve the non-encrypted details for the secret, use DescribeSecret.
+ * To run this command, you must have secretsmanager:GetSecretValue
permissions. If the secret is
+ * encrypted using a customer-managed key instead of the Amazon Web Services managed key
+ * aws/secretsmanager
, then you also need kms:Decrypt
permissions for that key.
*
- * Lists all of the versions attached to the specified secret. The output does not include the
- * SecretString
or SecretBinary
fields. By default, the list includes only versions that
- * have at least one staging label in VersionStage
attached.
+ * Lists the versions for a secret.
*
- * Always check the NextToken
response parameter when calling any of the List*
operations.
- * These operations can occasionally return an empty or shorter than expected list of results even when there more
- * results become available. When this happens, the NextToken
response parameter contains a value to
- * pass to the next call to the same API to request the next part of the list.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: + * To list the secrets in the account, use ListSecrets. *
- *
- * secretsmanager:ListSecretVersionIds
+ * To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
*
- * Related operations + * Minimum permissions *
- *
- * To list the secrets in an account, use ListSecrets.
+ * To run this command, you must have secretsmanager:ListSecretVersionIds
permissions.
*
- * Lists all of the versions attached to the specified secret. The output does not include the
- * SecretString
or SecretBinary
fields. By default, the list includes only versions that
- * have at least one staging label in VersionStage
attached.
+ * Lists the versions for a secret.
*
- * Always check the NextToken
response parameter when calling any of the List*
operations.
- * These operations can occasionally return an empty or shorter than expected list of results even when there more
- * results become available. When this happens, the NextToken
response parameter contains a value to
- * pass to the next call to the same API to request the next part of the list.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: + * To list the secrets in the account, use ListSecrets. *
- *
- * secretsmanager:ListSecretVersionIds
+ * To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
*
- * Related operations + * Minimum permissions *
- *
- * To list the secrets in an account, use ListSecrets.
+ * To run this command, you must have secretsmanager:ListSecretVersionIds
permissions.
*
- * Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the
- * versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields
- * SecretString
and SecretBinary
are not included in the output. To get that information,
- * call the GetSecretValue operation.
+ * Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account.
*
- * Always check the NextToken
response parameter when calling any of the List*
operations.
- * These operations can occasionally return an empty or shorter than expected list of results even when there more
- * results become available. When this happens, the NextToken
response parameter contains a value to
- * pass to the next call to the same API to request the next part of the list.
- *
- * Minimum permissions + * To list the versions of a secret, use ListSecretVersionIds. *
*
- * To run this command, you must have the following permissions:
+ * To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
*
- * secretsmanager:ListSecrets + * For information about finding secrets in the console, see Enhanced search + * capabilities for secrets in Secrets Manager. *
- *- * Related operations + * Minimum permissions *
- *
- * To list the versions attached to a secret, use ListSecretVersionIds.
+ * To run this command, you must have secretsmanager:ListSecrets
permissions.
*
- * Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the
- * versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields
- * SecretString
and SecretBinary
are not included in the output. To get that information,
- * call the GetSecretValue operation.
- *
- * Always check the NextToken
response parameter when calling any of the List*
operations.
- * These operations can occasionally return an empty or shorter than expected list of results even when there more
- * results become available. When this happens, the NextToken
response parameter contains a value to
- * pass to the next call to the same API to request the next part of the list.
+ * Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account.
*
- * Minimum permissions + * To list the versions of a secret, use ListSecretVersionIds. *
*
- * To run this command, you must have the following permissions:
+ * To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
*
- * secretsmanager:ListSecrets + * For information about finding secrets in the console, see Enhanced search + * capabilities for secrets in Secrets Manager. *
- *- * Related operations + * Minimum permissions *
- *
- * To list the versions attached to a secret, use ListSecretVersionIds.
+ * To run this command, you must have secretsmanager:ListSecrets
permissions.
*
- * Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is
- * optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name
- * (ARN) in the policy statement's Resources
element. You can also use a combination of both
- * identity-based and resource-based policies. The affected users and roles receive the permissions that are
- * permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for Amazon Web Services Secrets Manager. For the complete description of the
- * Amazon Web Services policy syntax and grammar, see IAM JSON Policy Reference in
- * the IAM User Guide.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:PutResourcePolicy - *
- *- * Related operations - *
- *- * To retrieve the resource policy attached to a secret, use GetResourcePolicy. - *
- *- * To delete the resource-based policy attached to a secret, use DeleteResourcePolicy. + * Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more + * information, see Authentication and access + * control for Secrets Manager *
- *- * To list all of the currently available secrets, use ListSecrets. + * For information about attaching a policy in the console, see Attach a permissions policy to a secret. *
- *
- * Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is
- * optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name
- * (ARN) in the policy statement's Resources
element. You can also use a combination of both
- * identity-based and resource-based policies. The affected users and roles receive the permissions that are
- * permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for Amazon Web Services Secrets Manager. For the complete description of the
- * Amazon Web Services policy syntax and grammar, see IAM JSON Policy Reference in
- * the IAM User Guide.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:PutResourcePolicy - *
- *- * Related operations - *
- *- * To retrieve the resource policy attached to a secret, use GetResourcePolicy. - *
- *- * To delete the resource-based policy attached to a secret, use DeleteResourcePolicy. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *
- * Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and
- * attaches it to the secret. The version can contain a new SecretString
value or a new
- * SecretBinary
value. You can also specify the staging labels that are initially attached to the new
- * version.
- *
- * We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10
- * minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager
- * removes outdated versions when there are more than 100, but it does not remove versions created less than 24
- * hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than
- * Secrets Manager removes, and you will reach the quota for secret versions.
- *
- * If this operation creates the first version for the secret then Secrets Manager automatically attaches the
- * staging label AWSCURRENT
to the new version.
- *
- * If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label
- * AWSCURRENT
to this new version.
- *
- * If this operation moves the staging label AWSCURRENT
from another version to this version, then
- * Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that
- * AWSCURRENT
was removed from.
- *
- * This operation is idempotent. If a version with a VersionId
with the same value as the
- * ClientRequestToken
parameter already exists and you specify the same secret data, the operation
- * succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot
- * modify an existing version; you can only create new ones.
- *
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:PutSecretValue + * Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more + * information, see Authentication and access + * control for Secrets Manager *
- *- * kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the - * secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets - * Manager. + * For information about attaching a policy in the console, see Attach a permissions policy to a secret. *
- *
- * Related operations
+ * Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a
+ * new SecretString
value or a new SecretBinary
value.
*
- * To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
+ * We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10
+ * minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager
+ * removes outdated versions when there are more than 100, but it does not remove versions created less than 24
+ * hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than
+ * Secrets Manager removes, and you will reach the quota for secret versions.
*
- * To create a secret, use CreateSecret.
+ * You can specify the staging labels to attach to the new version in VersionStages
. If you don't
+ * include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version. If this operation creates the first version for the secret, then Secrets
+ * Manager automatically attaches the staging label AWSCURRENT
to it .
*
- * To get the details for a secret, use DescribeSecret.
+ * If this operation moves the staging label AWSCURRENT
from another version to this version, then
+ * Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that
+ * AWSCURRENT
was removed from.
*
- * To list the versions attached to a secret, use ListSecretVersionIds.
+ * This operation is idempotent. If a version with a VersionId
with the same value as the
+ * ClientRequestToken
parameter already exists, and you specify the same secret data, the operation
+ * succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't
+ * modify an existing version; you can only create new ones.
*
- * Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and
- * attaches it to the secret. The version can contain a new SecretString
value or a new
- * SecretBinary
value. You can also specify the staging labels that are initially attached to the new
- * version.
+ * Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a
+ * new SecretString
value or a new SecretBinary
value.
*
* We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10
@@ -1595,108 +716,23 @@ java.util.concurrent.FuturePutSecretValue
more than once every 10 minutes, you create more versions than
* Secrets Manager removes, and you will reach the quota for secret versions.
*
- * If this operation creates the first version for the secret then Secrets Manager automatically attaches the
- * staging label AWSCURRENT
to the new version.
- *
- * If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label
- * AWSCURRENT
to this new version.
+ * You can specify the staging labels to attach to the new version in VersionStages
. If you don't
+ * include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version. If this operation creates the first version for the secret, then Secrets
+ * Manager automatically attaches the staging label AWSCURRENT
to it .
*
* If this operation moves the staging label AWSCURRENT
from another version to this version, then
* Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that
* AWSCURRENT
was removed from.
*
* This operation is idempotent. If a version with a VersionId
with the same value as the
- * ClientRequestToken
parameter already exists and you specify the same secret data, the operation
- * succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot
+ * ClientRequestToken
parameter already exists, and you specify the same secret data, the operation
+ * succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't
* modify an existing version; you can only create new ones.
*
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:PutSecretValue - *
- *- * kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the - * secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets - * Manager. - *
- *- * Related operations - *
- *- * To retrieve the encrypted value you store in the version of a secret, use GetSecretValue. - *
- *- * To create a secret, use CreateSecret. - *
- *- * To get the details for a secret, use DescribeSecret. - *
- *- * To list the versions attached to a secret, use ListSecretVersionIds. - *
- *- * Remove regions from replication. + * For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify. *
* * @param removeRegionsFromReplicationRequest @@ -1728,7 +764,7 @@ java.util.concurrent.Future- * Remove regions from replication. + * For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify. *
* * @param removeRegionsFromReplicationRequest @@ -1748,7 +784,9 @@ java.util.concurrent.Future- * Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions. + * Replicates the secret to a new Regions. See Multi-Region secrets. *
* * @param replicateSecretToRegionsRequest @@ -1761,7 +799,9 @@ java.util.concurrent.Future- * Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions. + * Replicates the secret to a new Regions. See Multi-Region secrets. *
* * @param replicateSecretToRegionsRequest @@ -1779,32 +819,9 @@ java.util.concurrent.Future
- * Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. This makes the
- * secret accessible to query once again.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:RestoreSecret - *
- *- * Related operations - *
- *
- * To delete a secret, use DeleteSecret.
+ * Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. You can access a
+ * secret again after it has been restored.
*
- * Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. This makes the
- * secret accessible to query once again.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:RestoreSecret - *
- *- * Related operations - *
- *
- * To delete a secret, use DeleteSecret.
+ * Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. You can access a
+ * secret again after it has been restored.
*
- * Configures and starts the asynchronous process of rotating this secret. If you include the configuration - * parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not - * include the configuration parameters, the operation starts a rotation with the values already stored in the - * secret. After the rotation completes, the protected service and its clients all use the new version of the - * secret. - *
- *
- * This required configuration information includes the ARN of an Amazon Web Services Lambda function and
- * optionally, the time between scheduled rotations. The Lambda rotation function creates a new version of the
- * secret and creates or updates the credentials on the protected service to match. After testing the new
- * credentials, the function marks the new secret with the staging label AWSCURRENT
so that your
- * clients all immediately begin to use the new version. For more information about rotating secrets and how to
- * configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in
- * Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
- *
- * Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date - * by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the - * hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards - * the top of the hour and influenced by a variety of factors that help distribute load. + * Configures and starts the asynchronous process of rotating the secret. *
*- * The rotation function must end with the versions of the secret in one of two states: + * If you include the configuration parameters, the operation sets the values for the secret and then immediately + * starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the + * values already stored in the secret. For more information about rotation, see Rotate secrets. *
- *
- * The AWSPENDING
and AWSCURRENT
staging labels are attached to the same version of the
- * secret, or
+ * To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule for the
+ * rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials
+ * on the database or service to match. After testing the new credentials, the function marks the new secret version
+ * with the staging label AWSCURRENT
. Then anyone who retrieves the secret gets the new version. For
+ * more information, see How rotation
+ * works.
*
- * The AWSPENDING
staging label is not attached to any version of the secret.
+ * When rotation is successful, the AWSPENDING
staging label might be attached to the same version as
+ * the AWSCURRENT
version, or it might not be attached to any version.
*
* If the AWSPENDING
staging label is present but not attached to the same version as
- * AWSCURRENT
then any later invocation of RotateSecret
assumes that a previous rotation
+ * AWSCURRENT
, then any later invocation of RotateSecret
assumes that a previous rotation
* request is still in progress and returns an error.
*
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:RotateSecret - *
- *- * lambda:InvokeFunction (on the function specified in the secret's metadata) - *
- *- * Related operations - *
- *- * To list the secrets in your account, use ListSecrets. - *
- *- * To get the details for a version of a secret, use DescribeSecret. - *
- *- * To create a new version of a secret, use CreateSecret. - *
- *
- * To attach staging labels to or remove staging labels from a version of a secret, use
- * UpdateSecretVersionStage.
+ * To run this command, you must have secretsmanager:RotateSecret
permissions and
+ * lambda:InvokeFunction
permissions on the function specified in the secret's metadata.
*
- * Configures and starts the asynchronous process of rotating this secret. If you include the configuration - * parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not - * include the configuration parameters, the operation starts a rotation with the values already stored in the - * secret. After the rotation completes, the protected service and its clients all use the new version of the - * secret. + * Configures and starts the asynchronous process of rotating the secret. *
*
- * This required configuration information includes the ARN of an Amazon Web Services Lambda function and
- * optionally, the time between scheduled rotations. The Lambda rotation function creates a new version of the
- * secret and creates or updates the credentials on the protected service to match. After testing the new
- * credentials, the function marks the new secret with the staging label AWSCURRENT
so that your
- * clients all immediately begin to use the new version. For more information about rotating secrets and how to
- * configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in
- * Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
+ * If you include the configuration parameters, the operation sets the values for the secret and then immediately
+ * starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the
+ * values already stored in the secret. For more information about rotation, see Rotate secrets.
*
- * Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date
- * by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the
- * hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards
- * the top of the hour and influenced by a variety of factors that help distribute load.
+ * To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule for the
+ * rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials
+ * on the database or service to match. After testing the new credentials, the function marks the new secret version
+ * with the staging label AWSCURRENT
. Then anyone who retrieves the secret gets the new version. For
+ * more information, see How rotation
+ * works.
*
- * The rotation function must end with the versions of the secret in one of two states: - *
- *
- * The AWSPENDING
and AWSCURRENT
staging labels are attached to the same version of the
- * secret, or
- *
- * The AWSPENDING
staging label is not attached to any version of the secret.
+ * When rotation is successful, the AWSPENDING
staging label might be attached to the same version as
+ * the AWSCURRENT
version, or it might not be attached to any version.
*
* If the AWSPENDING
staging label is present but not attached to the same version as
- * AWSCURRENT
then any later invocation of RotateSecret
assumes that a previous rotation
+ * AWSCURRENT
, then any later invocation of RotateSecret
assumes that a previous rotation
* request is still in progress and returns an error.
*
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:RotateSecret - *
- *- * lambda:InvokeFunction (on the function specified in the secret's metadata) - *
- *- * Related operations - *
- *- * To list the secrets in your account, use ListSecrets. - *
- *- * To get the details for a version of a secret, use DescribeSecret. - *
- *- * To create a new version of a secret, use CreateSecret. - *
- *
- * To attach staging labels to or remove staging labels from a version of a secret, use
- * UpdateSecretVersionStage.
+ * To run this command, you must have secretsmanager:RotateSecret
permissions and
+ * lambda:InvokeFunction
permissions on the function specified in the secret's metadata.
*
- * Removes the secret from replication and promotes the secret to a regional secret in the replica Region. + * Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret + * in the replica Region. + *
+ *+ * You must call this operation from the Region in which you want to promote the replica to a primary secret. *
* * @param stopReplicationToReplicaRequest @@ -2072,7 +956,11 @@ java.util.concurrent.Future- * Removes the secret from replication and promotes the secret to a regional secret in the replica Region. + * Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret + * in the replica Region. + *
+ *+ * You must call this operation from the Region in which you want to promote the replica to a primary secret. *
* * @param stopReplicationToReplicaRequest @@ -2090,27 +978,27 @@ java.util.concurrent.Future- * Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of - * the secret's overall metadata, and are not associated with any specific version of the secret. This operation - * only appends tags to the existing list of tags. To remove tags, you must use UntagResource. + * Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They + * are not associated with specific versions of the secret. This operation appends tags to the existing list of + * tags. *
*- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
** If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If - * successfully completing this operation would result in you losing your permissions for this secret, then the - * operation is blocked and returns an Access Denied error. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:TagResource - *
- *- * Related operations - *
- *- * To remove one or more tags from the collection attached to a secret, use UntagResource. - *
- *- * To view the list of tags attached to a secret, use DescribeSecret. + * successfully completing this operation would result in you losing your permissions for this secret, then the + * operation is blocked and returns an Access Denied error. *
- *- * Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of - * the secret's overall metadata, and are not associated with any specific version of the secret. This operation - * only appends tags to the existing list of tags. To remove tags, you must use UntagResource. + * Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They + * are not associated with specific versions of the secret. This operation appends tags to the existing list of + * tags. *
*- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
*- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:TagResource - *
- *- * Related operations - *
- *- * To remove one or more tags from the collection attached to a secret, use UntagResource. - *
- *- * To view the list of tags attached to a secret, use DescribeSecret. - *
- *- * Removes one or more tags from the specified secret. + * Removes specific tags from a secret. *
*
* This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the
@@ -2286,34 +1118,6 @@ java.util.concurrent.Future
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UntagResource - *
- *- * Related operations - *
- *- * To add one or more tags to the collection attached to a secret, use TagResource. - *
- *- * To view the list of tags attached to a secret, use DescribeSecret. - *
- *- * Removes one or more tags from the specified secret. + * Removes specific tags from a secret. *
*
* This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the
@@ -2338,34 +1142,6 @@ java.util.concurrent.Future
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UntagResource - *
- *- * Related operations - *
- *- * To add one or more tags to the collection attached to a secret, use TagResource. - *
- *- * To view the list of tags attached to a secret, use DescribeSecret. - *
- *- * Modifies many of the details of the specified secret. - *
- *- * To change the secret value, you can also use PutSecretValue. + * Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can + * also use PutSecretValue. *
*
* To change the rotation configuration of a secret, use RotateSecret instead.
@@ -2397,106 +1171,31 @@ java.util.concurrent.Future
- * The Secrets Manager console uses only the SecretString
parameter and therefore limits you to
- * encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret,
- * you must use either the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
- *
- * If a version with a VersionId
with the same value as the ClientRequestToken
parameter
- * already exists, the operation results in an error. You cannot modify an existing version, you can only create a
- * new version.
- *
* If you include SecretString
or SecretBinary
to create a new secret version, Secrets
* Manager automatically attaches the staging label AWSCURRENT
to the new version.
*
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UpdateSecret - *
- *- * kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do - * not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager. - *
- *- * kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need - * this permission to use the account's Amazon Web Services managed CMK for Secrets Manager. - *
- *- * Related operations - *
- *
- * To create a new secret, use CreateSecret.
+ * If you call this operation with a VersionId
that matches an existing version's
+ * ClientRequestToken
, the operation results in an error. You can't modify an existing version, you can
+ * only create a new version. To remove a version, remove all staging labels from it. See
+ * UpdateSecretVersionStage.
*
- * To add only a new version to an existing secret, use PutSecretValue.
+ * If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates
+ * it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use
+ * aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant
+ * delay in returning the result.
*
- * To get the details for a secret, use DescribeSecret.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed key.
*
- * To list the versions contained in a secret, use ListSecretVersionIds.
+ * To run this command, you must have secretsmanager:UpdateSecret
permissions. If you use a customer
+ * managed key, you must also have kms:GenerateDataKey
and kms:Decrypt
permissions .
*
- * Modifies many of the details of the specified secret. - *
- *- * To change the secret value, you can also use PutSecretValue. + * Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can + * also use PutSecretValue. *
*
* To change the rotation configuration of a secret, use RotateSecret instead.
@@ -2523,106 +1220,31 @@ java.util.concurrent.Future
- * The Secrets Manager console uses only the SecretString
parameter and therefore limits you to
- * encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret,
- * you must use either the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
- *
- * If a version with a VersionId
with the same value as the ClientRequestToken
parameter
- * already exists, the operation results in an error. You cannot modify an existing version, you can only create a
- * new version.
- *
* If you include SecretString
or SecretBinary
to create a new secret version, Secrets
* Manager automatically attaches the staging label AWSCURRENT
to the new version.
*
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UpdateSecret - *
- *- * kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do - * not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager. - *
- *- * kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need - * this permission to use the account's Amazon Web Services managed CMK for Secrets Manager. - *
- *- * Related operations - *
- *
- * To create a new secret, use CreateSecret.
+ * If you call this operation with a VersionId
that matches an existing version's
+ * ClientRequestToken
, the operation results in an error. You can't modify an existing version, you can
+ * only create a new version. To remove a version, remove all staging labels from it. See
+ * UpdateSecretVersionStage.
*
- * To add only a new version to an existing secret, use PutSecretValue.
+ * If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates
+ * it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use
+ * aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant
+ * delay in returning the result.
*
- * To get the details for a secret, use DescribeSecret.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed key.
*
- * To list the versions contained in a secret, use ListSecretVersionIds.
+ * To run this command, you must have secretsmanager:UpdateSecret
permissions. If you use a customer
+ * managed key, you must also have kms:GenerateDataKey
and kms:Decrypt
permissions .
*
- * Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it - * progresses through the secret rotation process. You can attach a staging label to only one version of a secret at - * a time. If a staging label to be added is already attached to another version, then it is moved--removed from the - * other version first and then attached to this one. For more information about staging labels, see Staging - * Labels in the Amazon Web Services Secrets Manager User Guide. + * Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a + * version as it progresses through the secret rotation process. Each staging label can be attached to only one + * version at a time. To add a staging label to a version when it is already attached to another version, Secrets + * Manager first removes it from the other version first and then attaches it to this one. For more information + * about versions and staging labels, see Concepts: + * Version. *
*
* The staging labels that you specify in the VersionStage
parameter are added to the existing list of
- * staging labels--they don't replace it.
+ * staging labels for the version.
*
* You can move the AWSCURRENT
staging label to this version by including it in this call.
@@ -2663,30 +1286,6 @@ java.util.concurrent.Future
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UpdateSecretVersionStage - *
- *- * Related operations - *
- *
- * To get the list of staging labels that are currently associated with a version of a secret, use
- * DescribeSecret
and examine the SecretVersionsToStages
response value.
- *
- * Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it - * progresses through the secret rotation process. You can attach a staging label to only one version of a secret at - * a time. If a staging label to be added is already attached to another version, then it is moved--removed from the - * other version first and then attached to this one. For more information about staging labels, see Staging - * Labels in the Amazon Web Services Secrets Manager User Guide. + * Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a + * version as it progresses through the secret rotation process. Each staging label can be attached to only one + * version at a time. To add a staging label to a version when it is already attached to another version, Secrets + * Manager first removes it from the other version first and then attaches it to this one. For more information + * about versions and staging labels, see Concepts: + * Version. *
*
* The staging labels that you specify in the VersionStage
parameter are added to the existing list of
- * staging labels--they don't replace it.
+ * staging labels for the version.
*
* You can move the AWSCURRENT
staging label to this version by including it in this call.
@@ -2722,30 +1322,6 @@ java.util.concurrent.Future
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UpdateSecretVersionStage - *
- *- * Related operations - *
- *
- * To get the list of staging labels that are currently associated with a version of a secret, use
- * DescribeSecret
and examine the SecretVersionsToStages
response value.
- *
- * Validates that the resource policy does not grant a wide range of IAM principals access to your secret. The JSON - * request string input and response output displays formatted code with white space and line breaks for better - * readability. Submit your input as a single line JSON string. A resource-based policy is optional for secrets. + * Validates that a resource policy does not grant a wide range of principals access to your secret. A + * resource-based policy is optional for secrets. *
*- * The API performs three checks when validating the secret: + * The API performs three checks when validating the policy: *
** Sends a call to Zelkova, an automated reasoning engine, to ensure your Resource Policy does not allow broad access to your - * secret. + * >Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your + * secret, for example policies that use a wildcard for the principal. *
*- * Minimum Permissions - *
- *- * You must have the permissions required to access the following APIs: - *
- *
- * secretsmanager:PutResourcePolicy
- *
- * secretsmanager:ValidateResourcePolicy
- *
- * Validates that the resource policy does not grant a wide range of IAM principals access to your secret. The JSON - * request string input and response output displays formatted code with white space and line breaks for better - * readability. Submit your input as a single line JSON string. A resource-based policy is optional for secrets. + * Validates that a resource policy does not grant a wide range of principals access to your secret. A + * resource-based policy is optional for secrets. *
*- * The API performs three checks when validating the secret: + * The API performs three checks when validating the policy: *
** Sends a call to Zelkova, an automated reasoning engine, to ensure your Resource Policy does not allow broad access to your - * secret. + * >Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your + * secret, for example policies that use a wildcard for the principal. *
*- * Minimum Permissions - *
- *- * You must have the permissions required to access the following APIs: - *
- *
- * secretsmanager:PutResourcePolicy
- *
- * secretsmanager:ValidateResourcePolicy
- *
- * Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress. + * Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation. *
*
- * To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays
set to a
- * value greater than 0. This immediately rotates your secret and then enables the automatic schedule.
+ * To turn on automatic rotation again, call RotateSecret.
*
- * If you cancel a rotation while in progress, it can leave the VersionStage
labels in an unexpected
- * state. Depending on the step of the rotation in progress, you might need to remove the staging label
+ * If you cancel a rotation in progress, it can leave the VersionStage
labels in an unexpected state.
+ * Depending on the step of the rotation in progress, you might need to remove the staging label
* AWSPENDING
from the partially created version, specified by the VersionId
response
- * value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can
- * do by removing all staging labels from the new version VersionStage
field.
+ * value. We recommend you also evaluate the partially rotated new version to see if it should be deleted. You can
+ * delete a version by removing all staging labels from it.
*
- * To successfully start a rotation, the staging label AWSPENDING
must be in one of the following
- * states:
- *
- * Not attached to any version at all - *
- *
- * Attached to the same version as the staging label AWSCURRENT
- *
- * If the staging label AWSPENDING
attached to a different version than the version with
- * AWSCURRENT
then the attempt to rotate fails.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:CancelRotateSecret - *
- *- * Related operations - *
- *- * To configure rotation for a secret or to manually trigger a rotation, use RotateSecret. - *
- *- * To get the rotation configuration details for a secret, use DescribeSecret. - *
- *- * To list all of the currently available secrets, use ListSecrets. - *
- *- * To list all of the versions currently associated with a secret, use ListSecretVersionIds. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important - * information needed to manage the secret. - *
- *
- * Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret.
- * Each version contains a copy of the encrypted secret data. Each version is associated with one or more
- * "staging labels" that identify where the version is in the rotation cycle. The
- * SecretVersionsToStages
field of the secret contains the mapping of staging labels to the active
- * versions of the secret. Versions without a staging label are considered deprecated and not included in the list.
- *
- * You provide the secret data to be encrypted by putting text in either the SecretString
parameter or
- * binary data in the SecretBinary
parameter, but not both. If you include SecretString
or
- * SecretBinary
then Secrets Manager also creates an initial secret version and automatically attaches
- * the staging label AWSCURRENT
to the new version.
- *
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:CreateSecret + * Creates a new secret. A secret is a set of credentials, such as a user name and password, that you store + * in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database + * or other service, which Secrets Manager doesn't encrypt. A secret in Secrets Manager consists of both the + * protected secret data and the important information needed to manage the secret. *
- *- * kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the - * secret. You do not need this permission to use the account default Amazon Web Services managed CMK for Secrets - * Manager. + * For information about creating a secret in the console, see Create a + * secret. *
- *
- * kms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You do
- * not need this permission to use the account default Amazon Web Services managed CMK for Secrets Manager.
+ * To create a secret, you can provide the secret value to be encrypted in either the SecretString
+ * parameter or the SecretBinary
parameter, but not both. If you include SecretString
or
+ * SecretBinary
then Secrets Manager creates an initial secret version and automatically attaches the
+ * staging label AWSCURRENT
to it.
*
- * secretsmanager:TagResource - needed only if you include the Tags
parameter.
+ * If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates
+ * it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use
+ * aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant
+ * delay in returning the result.
*
- * Related operations
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS
+ * key.
*
- * To delete a secret, use DeleteSecret. - *
- *- * To modify an existing secret, use UpdateSecret. - *
- *- * To create a new version of a secret, use PutSecretValue. - *
- *- * To retrieve the encrypted secure string and secure binary values, use GetSecretValue. - *
- *- * To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure - * string and secure binary values. - *
- *
- * To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine
- * the SecretVersionsToStages
response value.
- *
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Deletes the resource-based permission policy attached to the secret. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DeleteResourcePolicy - *
- *- * Related operations - *
- *- * To attach a resource policy to a secret, use PutResourcePolicy. - *
- *- * To retrieve the current resource-based policy attached to a secret, use GetResourcePolicy. - *
- *- * To list all of the currently available secrets, use ListSecrets. + * Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use + * PutResourcePolicy. *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*
- * Deletes an entire secret and all of the versions. You can optionally include a recovery window during which you
- * can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets
- * Manager attaches a DeletionDate
stamp to the secret that specifies the end of the recovery window.
- * At the end of the recovery window, Secrets Manager deletes the secret permanently.
- *
- * At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
- * and cancel the deletion of the secret.
- *
- * You cannot access the encrypted secret information in any secret scheduled for deletion. If you need to access
- * that information, you must cancel the deletion with RestoreSecret and then retrieve the information.
+ * Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the
+ * secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a
+ * DeletionDate
stamp to the secret that specifies the end of the recovery window. At the end of the
+ * recovery window, Secrets Manager deletes the secret permanently.
*
- * There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the
- * VersionStage
field of a version. That marks the version as deprecated and allows Secrets Manager to
- * delete it as needed. Versions without any staging labels do not show up in ListSecretVersionIds unless you
- * specify IncludeDeprecated
.
+ * For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.
*
- * The permanent secret deletion at the end of the waiting period is performed as a background task with low - * priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to + * Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with + * low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to * occur. *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DeleteSecret - *
- *- * Related operations - *
- *
- * To create a secret, use CreateSecret.
+ * At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate
+ * and cancel the deletion of the secret.
*
- * To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret. + * In a secret scheduled for deletion, you cannot access the encrypted secret value. To access that information, + * first cancel the deletion with RestoreSecret and then retrieve the information. *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields - * populated with a value in the response. + * Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns + * fields that have a value in the response. *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:DescribeSecret - *
- *- * Related operations - *
- *- * To create a secret, use CreateSecret. - *
- *- * To modify a secret, use UpdateSecret. - *
- *- * To retrieve the encrypted secret information in a version of the secret, use GetSecretValue. - *
- *- * To list all of the secrets in the Amazon Web Services account, use ListSecrets. - *
- *- * Generates a random password of the specified complexity. This operation is intended for use in the Lambda - * rotation function. Per best practice, we recommend that you specify the maximum length and include every - * character type that the system you are generating a password for can support. - *
- *- * Minimum permissions + * Generates a random password. We recommend that you specify the maximum length and include every character type + * that the system you are generating a password for can support. *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:GetRandomPassword - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request - * string input and response output displays formatted code with white space and line breaks for better readability. - * Submit your input as a single line JSON string. - *
- *- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:GetResourcePolicy - *
- *- * Related operations - *
- *- * To attach a resource policy to a secret, use PutResourcePolicy. - *
- *- * To delete the resource-based policy attached to a secret, use DeleteResourcePolicy. - *
- *- * To list all of the currently available secrets, use ListSecrets. + * Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about + * permissions policies attached to a secret, see Permissions policies attached to a secret. *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: + * For information about retrieving the secret value in the console, see Retrieve secrets. *
- *
- * secretsmanager:GetSecretValue
+ * To run this command, you must have secretsmanager:GetSecretValue
permissions. If the secret is
+ * encrypted using a customer-managed key instead of the Amazon Web Services managed key
+ * aws/secretsmanager
, then you also need kms:Decrypt
permissions for that key.
*
- * kms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the secret. You - * do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets Manager. - *
- *- * Related operations - *
- *- * To create a new version of the secret with different encrypted information, use PutSecretValue. - *
- *- * To retrieve the non-encrypted details for the secret, use DescribeSecret. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*
- * Lists all of the versions attached to the specified secret. The output does not include the
- * SecretString
or SecretBinary
fields. By default, the list includes only versions that
- * have at least one staging label in VersionStage
attached.
- *
- * Always check the NextToken
response parameter when calling any of the List*
operations.
- * These operations can occasionally return an empty or shorter than expected list of results even when there more
- * results become available. When this happens, the NextToken
response parameter contains a value to
- * pass to the next call to the same API to request the next part of the list.
- *
- * Minimum permissions + * Lists the versions for a secret. *
*- * To run this command, you must have the following permissions: + * To list the secrets in the account, use ListSecrets. *
- *
- * secretsmanager:ListSecretVersionIds
+ * To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
*
- * Related operations + * Minimum permissions *
- *
- * To list the secrets in an account, use ListSecrets.
+ * To run this command, you must have secretsmanager:ListSecretVersionIds
permissions.
*
NextToken
value.
+ * The NextToken
value is invalid.
* @throws ResourceNotFoundException
- * We can't find the resource that you asked for.
+ * Secrets Manager can't find the resource that you asked for.
* @throws InternalServiceErrorException
* An error occurred on the server side.
* @throws InvalidParameterException
- * You provided an invalid value for a parameter.
+ * The parameter name is invalid value.
* @sample AWSSecretsManager.ListSecretVersionIds
* @see AWS API Documentation
@@ -1345,49 +1001,32 @@ final ListSecretVersionIdsResult executeListSecretVersionIds(ListSecretVersionId
/**
*
- * Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the
- * versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields
- * SecretString
and SecretBinary
are not included in the output. To get that information,
- * call the GetSecretValue operation.
- *
- * Always check the NextToken
response parameter when calling any of the List*
operations.
- * These operations can occasionally return an empty or shorter than expected list of results even when there more
- * results become available. When this happens, the NextToken
response parameter contains a value to
- * pass to the next call to the same API to request the next part of the list.
+ * Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account.
*
- * Minimum permissions + * To list the versions of a secret, use ListSecretVersionIds. *
*
- * To run this command, you must have the following permissions:
+ * To get the secret value from SecretString
or SecretBinary
, call GetSecretValue.
*
- * secretsmanager:ListSecrets + * For information about finding secrets in the console, see Enhanced search + * capabilities for secrets in Secrets Manager. *
- *- * Related operations + * Minimum permissions *
- *
- * To list the versions attached to a secret, use ListSecretVersionIds.
+ * To run this command, you must have secretsmanager:ListSecrets
permissions.
*
NextToken
value.
+ * The NextToken
value is invalid.
* @throws InternalServiceErrorException
* An error occurred on the server side.
* @sample AWSSecretsManager.ListSecrets
@@ -1440,70 +1079,36 @@ final ListSecretsResult executeListSecrets(ListSecretsRequest listSecretsRequest
/**
*
- * Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is
- * optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name
- * (ARN) in the policy statement's Resources
element. You can also use a combination of both
- * identity-based and resource-based policies. The affected users and roles receive the permissions that are
- * permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for Amazon Web Services Secrets Manager. For the complete description of the
- * Amazon Web Services policy syntax and grammar, see IAM JSON Policy Reference in
- * the IAM User Guide.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:PutResourcePolicy - *
- *- * Related operations - *
- *- * To retrieve the resource policy attached to a secret, use GetResourcePolicy. + * Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more + * information, see Authentication and access + * control for Secrets Manager *
- *- * To delete the resource-based policy attached to a secret, use DeleteResourcePolicy. - *
- *- * To list all of the currently available secrets, use ListSecrets. + * For information about attaching a policy in the console, see Attach a permissions policy to a secret. *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*BlockPublicPolicy
parameter is set to true, and the resource policy did not prevent
+ * broad access to the secret.
* @sample AWSSecretsManager.PutResourcePolicy
* @see AWS API Documentation
@@ -1565,10 +1170,8 @@ final PutResourcePolicyResult executePutResourcePolicy(PutResourcePolicyRequest
/**
*
- * Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and
- * attaches it to the secret. The version can contain a new SecretString
value or a new
- * SecretBinary
value. You can also specify the staging labels that are initially attached to the new
- * version.
+ * Creates a new version with a new encrypted secret value and attaches it to the secret. The version can contain a
+ * new SecretString
value or a new SecretBinary
value.
*
* We recommend you avoid calling PutSecretValue
at a sustained rate of more than once every 10
@@ -1576,123 +1179,38 @@ final PutResourcePolicyResult executePutResourcePolicy(PutResourcePolicyRequest
* removes outdated versions when there are more than 100, but it does not remove versions created less than 24
* hours ago. If you call PutSecretValue
more than once every 10 minutes, you create more versions than
* Secrets Manager removes, and you will reach the quota for secret versions.
- *
- * If this operation creates the first version for the secret then Secrets Manager automatically attaches the
- * staging label AWSCURRENT
to the new version.
- *
- * If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label
- * AWSCURRENT
to this new version.
+ * You can specify the staging labels to attach to the new version in VersionStages
. If you don't
+ * include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version. If this operation creates the first version for the secret, then Secrets
+ * Manager automatically attaches the staging label AWSCURRENT
to it .
*
* If this operation moves the staging label AWSCURRENT
from another version to this version, then
* Secrets Manager also automatically moves the staging label AWSPREVIOUS
to the version that
* AWSCURRENT
was removed from.
*
* This operation is idempotent. If a version with a VersionId
with the same value as the
- * ClientRequestToken
parameter already exists and you specify the same secret data, the operation
- * succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot
+ * ClientRequestToken
parameter already exists, and you specify the same secret data, the operation
+ * succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't
* modify an existing version; you can only create new ones.
*
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:PutSecretValue - *
- *- * kms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the - * secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for Secrets - * Manager. - *
- *- * Related operations - *
- *- * To retrieve the encrypted value you store in the version of a secret, use GetSecretValue. - *
- *- * To create a secret, use CreateSecret. - *
- *- * To get the details for a secret, use DescribeSecret. - *
- *- * To list the versions attached to a secret, use ListSecretVersionIds. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Remove regions from replication. + * For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify. *
* * @param removeRegionsFromReplicationRequest * @return Result of the RemoveRegionsFromReplication operation returned by the service. * @throws ResourceNotFoundException - * We can't find the resource that you asked for. + * Secrets Manager can't find the resource that you asked for. * @throws InvalidRequestException - * You provided a parameter value that is not valid for the current state of the resource. + * A parameter value is not valid for the current state of the resource. ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions. + * Replicates the secret to a new Regions. See Multi-Region secrets. *
* * @param replicateSecretToRegionsRequest * @return Result of the ReplicateSecretToRegions operation returned by the service. * @throws ResourceNotFoundException - * We can't find the resource that you asked for. + * Secrets Manager can't find the resource that you asked for. * @throws InvalidRequestException - * You provided a parameter value that is not valid for the current state of the resource. + * A parameter value is not valid for the current state of the resource. ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*
- * Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. This makes the
- * secret accessible to query once again.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:RestoreSecret - *
- *- * Related operations - *
- *
- * To delete a secret, use DeleteSecret.
+ * Cancels the scheduled deletion of a secret by removing the DeletedDate
time stamp. You can access a
+ * secret again after it has been restored.
*
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Configures and starts the asynchronous process of rotating this secret. If you include the configuration - * parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not - * include the configuration parameters, the operation starts a rotation with the values already stored in the - * secret. After the rotation completes, the protected service and its clients all use the new version of the - * secret. - *
- *
- * This required configuration information includes the ARN of an Amazon Web Services Lambda function and
- * optionally, the time between scheduled rotations. The Lambda rotation function creates a new version of the
- * secret and creates or updates the credentials on the protected service to match. After testing the new
- * credentials, the function marks the new secret with the staging label AWSCURRENT
so that your
- * clients all immediately begin to use the new version. For more information about rotating secrets and how to
- * configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in
- * Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
- *
- * Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date - * by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the - * hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards - * the top of the hour and influenced by a variety of factors that help distribute load. + * Configures and starts the asynchronous process of rotating the secret. *
*- * The rotation function must end with the versions of the secret in one of two states: + * If you include the configuration parameters, the operation sets the values for the secret and then immediately + * starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the + * values already stored in the secret. For more information about rotation, see Rotate secrets. *
- *
- * The AWSPENDING
and AWSCURRENT
staging labels are attached to the same version of the
- * secret, or
+ * To configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule for the
+ * rotation. The Lambda rotation function creates a new version of the secret and creates or updates the credentials
+ * on the database or service to match. After testing the new credentials, the function marks the new secret version
+ * with the staging label AWSCURRENT
. Then anyone who retrieves the secret gets the new version. For
+ * more information, see How rotation
+ * works.
*
- * The AWSPENDING
staging label is not attached to any version of the secret.
+ * When rotation is successful, the AWSPENDING
staging label might be attached to the same version as
+ * the AWSCURRENT
version, or it might not be attached to any version.
*
* If the AWSPENDING
staging label is present but not attached to the same version as
- * AWSCURRENT
then any later invocation of RotateSecret
assumes that a previous rotation
+ * AWSCURRENT
, then any later invocation of RotateSecret
assumes that a previous rotation
* request is still in progress and returns an error.
*
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:RotateSecret - *
- *- * lambda:InvokeFunction (on the function specified in the secret's metadata) - *
- *- * Related operations - *
- *- * To list the secrets in your account, use ListSecrets. - *
- *- * To get the details for a version of a secret, use DescribeSecret. - *
- *- * To create a new version of a secret, use CreateSecret. - *
- *
- * To attach staging labels to or remove staging labels from a version of a secret, use
- * UpdateSecretVersionStage.
+ * To run this command, you must have secretsmanager:RotateSecret
permissions and
+ * lambda:InvokeFunction
permissions on the function specified in the secret's metadata.
*
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Removes the secret from replication and promotes the secret to a regional secret in the replica Region. + * Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret + * in the replica Region. + *
+ *+ * You must call this operation from the Region in which you want to promote the replica to a primary secret. *
* * @param stopReplicationToReplicaRequest * @return Result of the StopReplicationToReplica operation returned by the service. * @throws ResourceNotFoundException - * We can't find the resource that you asked for. + * Secrets Manager can't find the resource that you asked for. * @throws InvalidRequestException - * You provided a parameter value that is not valid for the current state of the resource. + * A parameter value is not valid for the current state of the resource. ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of - * the secret's overall metadata, and are not associated with any specific version of the secret. This operation - * only appends tags to the existing list of tags. To remove tags, you must use UntagResource. + * Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They + * are not associated with specific versions of the secret. This operation appends tags to the existing list of + * tags. *
*- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
*- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:TagResource - *
- *- * Related operations - *
- *- * To remove one or more tags from the collection attached to a secret, use UntagResource. - *
- *- * To view the list of tags attached to a secret, use DescribeSecret. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Removes one or more tags from the specified secret. + * Removes specific tags from a secret. *
** This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the @@ -2436,48 +1852,20 @@ final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest * blocked and returns an Access Denied error. *
*- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UntagResource - *
- *- * Related operations - *
- *- * To add one or more tags to the collection attached to a secret, use TagResource. - *
- *- * To view the list of tags attached to a secret, use DescribeSecret. - *
- ** Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Modifies many of the details of the specified secret. - *
- *- * To change the secret value, you can also use PutSecretValue. + * Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can + * also use PutSecretValue. *
** To change the rotation configuration of a secret, use RotateSecret instead. @@ -2555,120 +1941,45 @@ final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourc * created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more * versions than Secrets Manager removes, and you will reach the quota for secret versions. *
- *
- * The Secrets Manager console uses only the SecretString
parameter and therefore limits you to
- * encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret,
- * you must use either the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
- *
- * If a version with a VersionId
with the same value as the ClientRequestToken
parameter
- * already exists, the operation results in an error. You cannot modify an existing version, you can only create a
- * new version.
- *
* If you include SecretString
or SecretBinary
to create a new secret version, Secrets
* Manager automatically attaches the staging label AWSCURRENT
to the new version.
*
- * If you call an operation to encrypt or decrypt the SecretString
or SecretBinary
for a
- * secret in the same account as the calling user and that secret doesn't specify a Amazon Web Services KMS
- * encryption key, Secrets Manager uses the account's default Amazon Web Services managed customer master key (CMK)
- * with the alias aws/secretsmanager
. If this key doesn't already exist in your account then Secrets
- * Manager creates it for you automatically. All users and roles in the same Amazon Web Services account
- * automatically have access to use the default CMK. Note that if an Secrets Manager API call results in Amazon Web
- * Services creating the account's Amazon Web Services-managed CMK, it can result in a one-time significant delay in
- * returning the result.
- *
- * If the secret resides in a different Amazon Web Services account from the credentials calling an API that
- * requires encryption or decryption of the secret value then you must create and use a custom Amazon Web Services
- * KMS CMK because you can't access the default CMK for the account using credentials from a different Amazon Web
- * Services account. Store the ARN of the CMK in the secret when you create the secret or when you update it by
- * including it in the KMSKeyId
. If you call an API that must encrypt or decrypt
- * SecretString
or SecretBinary
using credentials from a different account then the Amazon
- * Web Services KMS key policy must grant cross-account access to that other account's user or role for both the
- * kms:GenerateDataKey and kms:Decrypt operations.
- *
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UpdateSecret - *
- *- * kms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do - * not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager. - *
- *- * kms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do not need - * this permission to use the account's Amazon Web Services managed CMK for Secrets Manager. - *
- *- * Related operations - *
- *
- * To create a new secret, use CreateSecret.
+ * If you call this operation with a VersionId
that matches an existing version's
+ * ClientRequestToken
, the operation results in an error. You can't modify an existing version, you can
+ * only create a new version. To remove a version, remove all staging labels from it. See
+ * UpdateSecretVersionStage.
*
- * To add only a new version to an existing secret, use PutSecretValue.
+ * If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key
+ * aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates
+ * it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use
+ * aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant
+ * delay in returning the result.
*
- * To get the details for a secret, use DescribeSecret.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed key.
*
- * To list the versions contained in a secret, use ListSecretVersionIds.
+ * To run this command, you must have secretsmanager:UpdateSecret
permissions. If you use a customer
+ * managed key, you must also have kms:GenerateDataKey
and kms:Decrypt
permissions .
*
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it - * progresses through the secret rotation process. You can attach a staging label to only one version of a secret at - * a time. If a staging label to be added is already attached to another version, then it is moved--removed from the - * other version first and then attached to this one. For more information about staging labels, see Staging - * Labels in the Amazon Web Services Secrets Manager User Guide. + * Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a + * version as it progresses through the secret rotation process. Each staging label can be attached to only one + * version at a time. To add a staging label to a version when it is already attached to another version, Secrets + * Manager first removes it from the other version first and then attaches it to this one. For more information + * about versions and staging labels, see Concepts: + * Version. *
*
* The staging labels that you specify in the VersionStage
parameter are added to the existing list of
- * staging labels--they don't replace it.
+ * staging labels for the version.
*
* You can move the AWSCURRENT
staging label to this version by including it in this call.
@@ -2768,46 +2080,22 @@ final UpdateSecretResult executeUpdateSecret(UpdateSecretRequest updateSecretReq
* If this action results in the last label being removed from a version, then the version is considered to be
* 'deprecated' and can be deleted by Secrets Manager.
*
- * Minimum permissions - *
- *- * To run this command, you must have the following permissions: - *
- *- * secretsmanager:UpdateSecretVersionStage - *
- *- * Related operations - *
- *
- * To get the list of staging labels that are currently associated with a version of a secret, use
- * DescribeSecret
and examine the SecretVersionsToStages
response value.
- *
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Validates that the resource policy does not grant a wide range of IAM principals access to your secret. The JSON - * request string input and response output displays formatted code with white space and line breaks for better - * readability. Submit your input as a single line JSON string. A resource-based policy is optional for secrets. + * Validates that a resource policy does not grant a wide range of principals access to your secret. A + * resource-based policy is optional for secrets. *
*- * The API performs three checks when validating the secret: + * The API performs three checks when validating the policy: *
** Sends a call to Zelkova, an automated reasoning engine, to ensure your Resource Policy does not allow broad access to your - * secret. + * >Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your + * secret, for example policies that use a wildcard for the principal. *
*- * Minimum Permissions - *
- *- * You must have the permissions required to access the following APIs: - *
- *
- * secretsmanager:PutResourcePolicy
- *
- * secretsmanager:ValidateResourcePolicy
- *
* Possible causes: *
*- * You tried to perform the operation on a secret that's currently marked deleted. + * The secret is scheduled for deletion. *
*- * Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -38,16 +37,14 @@ public class CancelRotateSecretRequest extends com.amazonaws.AmazonWebServiceReq /** *
- * Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) - * or the friendly name of the secret. + * The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -58,15 +55,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) - * or the friendly name of the secret. + * @return The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -77,16 +72,14 @@ public String getSecretId() { /** *
- * Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) - * or the friendly name of the secret. + * The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CancelRotateSecretResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CancelRotateSecretResult.java index 2ed02c533f3a..07f699f3eaf0 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CancelRotateSecretResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CancelRotateSecretResult.java @@ -25,33 +25,33 @@ public class CancelRotateSecretResult extends com.amazonaws.AmazonWebServiceResu /** *
- * The ARN of the secret for which rotation was canceled. + * The ARN of the secret. *
*/ private String aRN; /** *- * The friendly name of the secret for which rotation was canceled. + * The name of the secret. *
*/ private String name; /** *
* The unique identifier of the version of the secret created during the rotation. This version might not be
- * complete, and should be evaluated for possible deletion. At the very least, you should remove the
- * VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up
- * a cancelled rotation can block you from successfully starting future rotations.
+ * complete, and should be evaluated for possible deletion. We recommend that you remove the
+ * VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it.
+ * Failing to clean up a cancelled rotation can block you from starting future rotations.
*
- * The ARN of the secret for which rotation was canceled. + * The ARN of the secret. *
* * @param aRN - * The ARN of the secret for which rotation was canceled. + * The ARN of the secret. */ public void setARN(String aRN) { @@ -60,10 +60,10 @@ public void setARN(String aRN) { /** *- * The ARN of the secret for which rotation was canceled. + * The ARN of the secret. *
* - * @return The ARN of the secret for which rotation was canceled. + * @return The ARN of the secret. */ public String getARN() { @@ -72,11 +72,11 @@ public String getARN() { /** *- * The ARN of the secret for which rotation was canceled. + * The ARN of the secret. *
* * @param aRN - * The ARN of the secret for which rotation was canceled. + * The ARN of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -87,11 +87,11 @@ public CancelRotateSecretResult withARN(String aRN) { /** *- * The friendly name of the secret for which rotation was canceled. + * The name of the secret. *
* * @param name - * The friendly name of the secret for which rotation was canceled. + * The name of the secret. */ public void setName(String name) { @@ -100,10 +100,10 @@ public void setName(String name) { /** *- * The friendly name of the secret for which rotation was canceled. + * The name of the secret. *
* - * @return The friendly name of the secret for which rotation was canceled. + * @return The name of the secret. */ public String getName() { @@ -112,11 +112,11 @@ public String getName() { /** *- * The friendly name of the secret for which rotation was canceled. + * The name of the secret. *
* * @param name - * The friendly name of the secret for which rotation was canceled. + * The name of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -128,16 +128,16 @@ public CancelRotateSecretResult withName(String name) { /** *
* The unique identifier of the version of the secret created during the rotation. This version might not be
- * complete, and should be evaluated for possible deletion. At the very least, you should remove the
- * VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up
- * a cancelled rotation can block you from successfully starting future rotations.
+ * complete, and should be evaluated for possible deletion. We recommend that you remove the
+ * VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it.
+ * Failing to clean up a cancelled rotation can block you from starting future rotations.
*
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to
- * clean up a cancelled rotation can block you from successfully starting future rotations.
+ * complete, and should be evaluated for possible deletion. We recommend that you remove the
+ * VersionStage
value AWSPENDING
from this version so that Secrets Manager can
+ * delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
*/
public void setVersionId(String versionId) {
@@ -147,15 +147,15 @@ public void setVersionId(String versionId) {
/**
*
* The unique identifier of the version of the secret created during the rotation. This version might not be
- * complete, and should be evaluated for possible deletion. At the very least, you should remove the
- * VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up
- * a cancelled rotation can block you from successfully starting future rotations.
+ * complete, and should be evaluated for possible deletion. We recommend that you remove the
+ * VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it.
+ * Failing to clean up a cancelled rotation can block you from starting future rotations.
*
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to
- * clean up a cancelled rotation can block you from successfully starting future rotations.
+ * complete, and should be evaluated for possible deletion. We recommend that you remove the
+ * VersionStage
value AWSPENDING
from this version so that Secrets Manager can
+ * delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
*/
public String getVersionId() {
@@ -165,16 +165,16 @@ public String getVersionId() {
/**
*
* The unique identifier of the version of the secret created during the rotation. This version might not be
- * complete, and should be evaluated for possible deletion. At the very least, you should remove the
- * VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to clean up
- * a cancelled rotation can block you from successfully starting future rotations.
+ * complete, and should be evaluated for possible deletion. We recommend that you remove the
+ * VersionStage
value AWSPENDING
from this version so that Secrets Manager can delete it.
+ * Failing to clean up a cancelled rotation can block you from starting future rotations.
*
VersionStage
value AWSPENDING
to enable this version to be deleted. Failing to
- * clean up a cancelled rotation can block you from successfully starting future rotations.
+ * complete, and should be evaluated for possible deletion. We recommend that you remove the
+ * VersionStage
value AWSPENDING
from this version so that Secrets Manager can
+ * delete it. Failing to clean up a cancelled rotation can block you from starting future rotations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CreateSecretRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CreateSecretRequest.java
index dcd2131b2be8..994ca84b3d02 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CreateSecretRequest.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CreateSecretRequest.java
@@ -27,32 +27,30 @@ public class CreateSecretRequest extends com.amazonaws.AmazonWebServiceRequest i
/**
* - * Specifies the friendly name of the new secret. + * The name of the new secret. *
*- * The secret name must be ASCII letters, digits, or the following characters : /_+=.@- + * The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- *
- ** Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and * unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and - * six random characters at the end of the ARN. + * six random characters after the secret name at the end of the ARN. *
- *
- * (Optional) If you include SecretString
or SecretBinary
, then an initial version is
- * created as part of the secret, and this parameter specifies a unique identifier for the new version.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial
+ * version for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this
- * parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for the new version and
- * include the value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for
+ * this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
+ * Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version
+ * and include the value in the request.
*
@@ -89,125 +87,102 @@ public class CreateSecretRequest extends com.amazonaws.AmazonWebServiceRequest i private String clientRequestToken; /** *
- * (Optional) Specifies a user-provided description of the secret. + * The description of the secret. *
*/ private String description; /** *
- * (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be
- * used to encrypt the SecretString
or SecretBinary
values in the versions stored in this
- * secret.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
*
- * You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference - * a CMK in a different account, you can use only the key ARN or the alias ARN. + * To use a KMS key in a different account, use the key ARN or the alias ARN. *
*
- * If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default
- * CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet
- * exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's
- * SecretString
or SecretBinary
fields.
+ * If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key
+ * doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret
+ * value.
*
- * You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from
- * the same account that owns the secret. If the secret resides in a different account, then you must create a
- * custom CMK and specify the ARN in this field.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS
+ * key.
*
- * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this - * parameter in the command-line tools, we recommend that you store your binary data in a file and then use the - * appropriate technique for your tool to pass the contents of the file as a parameter. + * The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary + * data in a file and then pass the contents of the file as a parameter. *
*
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
- * be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
- * This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon - * Web Services CLI or one of the Amazon Web Services SDKs. + * This parameter is not available in the Secrets Manager console. *
*/ private java.nio.ByteBuffer secretBinary; /** *- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. + * The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of + * key/value pairs for your secret value. *
*
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
- * be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
* If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text
* in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON
- * structure of key/value pairs that the Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. - * For more information, see Specifying parameter values for - * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * structure of key/value pairs that a Lambda rotation function can parse. *
*/ private String secretString; /** *- * (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" - * pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use - * UntagResource. + * A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for + * example: + *
+ *
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
*
* Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key * "abc". *
- *
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or
- * removing a tag can change permissions. If the successful completion of this operation would result in you losing
- * your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can
+ * change permissions. If the completion of this operation would result in you losing your permissions for this
+ * secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more
+ * information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the - * various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. For example: - *
- *
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
- *
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to - * avoid confusion with the double quotes required in the JSON text. + * Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use + * single quotes to avoid confusion with the double quotes required in the JSON text. *
*- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
*- * (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the - * list of regions specified in the parameter. + * A list of Regions and KMS keys to replicate secrets. *
*/ private java.util.List- * (Optional) If set, the replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
*/ private Boolean forceOverwriteReplicaSecret; /** *- * Specifies the friendly name of the new secret. + * The name of the new secret. *
*- * The secret name must be ASCII letters, digits, or the following characters : /_+=.@- + * The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- *
- ** Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and * unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and - * six random characters at the end of the ARN. + * six random characters after the secret name at the end of the ARN. *
- *- * The secret name must be ASCII letters, digits, or the following characters : /_+=.@- + * The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- *
- ** Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and * unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen - * and six random characters at the end of the ARN. - *
+ * and six random characters after the secret name at the end of the ARN. */ public void setName(String name) { @@ -280,29 +250,25 @@ public void setName(String name) { /** *- * Specifies the friendly name of the new secret. + * The name of the new secret. *
*- * The secret name must be ASCII letters, digits, or the following characters : /_+=.@- + * The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- *
- ** Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and * unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and - * six random characters at the end of the ARN. + * six random characters after the secret name at the end of the ARN. *
- *- * The secret name must be ASCII letters, digits, or the following characters : /_+=.@- + * The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- *
- ** Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion * and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a - * hyphen and six random characters at the end of the ARN. - *
+ * hyphen and six random characters after the secret name at the end of the ARN. */ public String getName() { @@ -311,30 +277,26 @@ public String getName() { /** *- * Specifies the friendly name of the new secret. + * The name of the new secret. *
*- * The secret name must be ASCII letters, digits, or the following characters : /_+=.@- + * The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- *
- ** Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and * unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and - * six random characters at the end of the ARN. + * six random characters after the secret name at the end of the ARN. *
- *- * The secret name must be ASCII letters, digits, or the following characters : /_+=.@- + * The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- *
- ** Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and * unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen - * and six random characters at the end of the ARN. - *
+ * and six random characters after the secret name at the end of the ARN. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -345,16 +307,16 @@ public CreateSecretRequest withName(String name) { /** *
- * (Optional) If you include SecretString
or SecretBinary
, then an initial version is
- * created as part of the secret, and this parameter specifies a unique identifier for the new version.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial
+ * version for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this
- * parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for the new version and
- * include the value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for
+ * this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
+ * Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version
+ * and include the value in the request.
*
@@ -389,11 +351,11 @@ public CreateSecretRequest withName(String name) { *
* * @param clientRequestToken - * (Optional) If you includeSecretString
or SecretBinary
, then an initial version
- * is created as part of the secret, and this parameter specifies a unique identifier for the new version.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates an
+ * initial version for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then
* you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the
* value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request
* to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself
@@ -437,16 +399,16 @@ public void setClientRequestToken(String clientRequestToken) {
/**
*
- * (Optional) If you include SecretString
or SecretBinary
, then an initial version is
- * created as part of the secret, and this parameter specifies a unique identifier for the new version.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial
+ * version for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this
- * parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for the new version and
- * include the value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for
+ * this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
+ * Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version
+ * and include the value in the request.
*
@@ -480,14 +442,14 @@ public void setClientRequestToken(String clientRequestToken) {
* This value becomes the VersionId
of the new version.
*
SecretString
or SecretBinary
, then an initial version
- * is created as part of the secret, and this parameter specifies a unique identifier for the new version.
+ * @return If you include SecretString
or SecretBinary
, then Secrets Manager creates an
+ * initial version for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
- * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the
- * value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request
- * to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation,
+ * then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it
+ * as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP
+ * request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
* yourself for the new version and include the value in the request.
*
- * (Optional) If you include SecretString
or SecretBinary
, then an initial version is
- * created as part of the secret, and this parameter specifies a unique identifier for the new version.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates an initial
+ * version for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this
- * parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for the new version and
- * include the value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for
+ * this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
+ * Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version
+ * and include the value in the request.
*
@@ -572,11 +534,11 @@ public String getClientRequestToken() { *
* * @param clientRequestToken - * (Optional) If you includeSecretString
or SecretBinary
, then an initial version
- * is created as part of the secret, and this parameter specifies a unique identifier for the new version.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates an
+ * initial version for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then
* you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the
* value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request
* to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself
@@ -622,11 +584,11 @@ public CreateSecretRequest withClientRequestToken(String clientRequestToken) {
/**
*
- * (Optional) Specifies a user-provided description of the secret. + * The description of the secret. *
* * @param description - * (Optional) Specifies a user-provided description of the secret. + * The description of the secret. */ public void setDescription(String description) { @@ -635,10 +597,10 @@ public void setDescription(String description) { /** *- * (Optional) Specifies a user-provided description of the secret. + * The description of the secret. *
* - * @return (Optional) Specifies a user-provided description of the secret. + * @return The description of the secret. */ public String getDescription() { @@ -647,11 +609,11 @@ public String getDescription() { /** *- * (Optional) Specifies a user-provided description of the secret. + * The description of the secret. *
* * @param description - * (Optional) Specifies a user-provided description of the secret. + * The description of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -662,48 +624,37 @@ public CreateSecretRequest withDescription(String description) { /** *
- * (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be
- * used to encrypt the SecretString
or SecretBinary
values in the versions stored in this
- * secret.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
*
- * You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference - * a CMK in a different account, you can use only the key ARN or the alias ARN. + * To use a KMS key in a different account, use the key ARN or the alias ARN. *
*
- * If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default
- * CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet
- * exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's
- * SecretString
or SecretBinary
fields.
+ * If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key
+ * doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret
+ * value.
*
- * You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from
- * the same account that owns the secret. If the secret resides in a different account, then you must create a
- * custom CMK and specify the ARN in this field.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS
+ * key.
*
SecretString
or SecretBinary
values in the versions
- * stored in this secret.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the
+ * secret.
* - * You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to - * reference a CMK in a different account, you can use only the key ARN or the alias ARN. + * To use a KMS key in a different account, use the key ARN or the alias ARN. *
*
- * If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's
- * default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that
- * name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to
- * encrypt a version's SecretString
or SecretBinary
fields.
+ * If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If
+ * that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it
+ * encrypts the secret value.
*
- * You can use the account default CMK to encrypt and decrypt only if you call this operation using - * credentials from the same account that owns the secret. If the secret resides in a different account, then - * you must create a custom CMK and specify the ARN in this field. - *
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you + * can't useaws/secretsmanager
to encrypt the secret, and you must create and use a customer
+ * managed KMS key.
*/
public void setKmsKeyId(String kmsKeyId) {
@@ -712,47 +663,36 @@ public void setKmsKeyId(String kmsKeyId) {
/**
*
- * (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be
- * used to encrypt the SecretString
or SecretBinary
values in the versions stored in this
- * secret.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
*
- * You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference - * a CMK in a different account, you can use only the key ARN or the alias ARN. + * To use a KMS key in a different account, use the key ARN or the alias ARN. *
*
- * If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default
- * CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet
- * exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's
- * SecretString
or SecretBinary
fields.
+ * If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key
+ * doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret
+ * value.
*
- * You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from
- * the same account that owns the secret. If the secret resides in a different account, then you must create a
- * custom CMK and specify the ARN in this field.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS
+ * key.
*
SecretString
or SecretBinary
values in the versions
- * stored in this secret.
+ * @return The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the
+ * secret.
* - * You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to - * reference a CMK in a different account, you can use only the key ARN or the alias ARN. + * To use a KMS key in a different account, use the key ARN or the alias ARN. *
*
- * If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's
- * default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that
- * name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to
- * encrypt a version's SecretString
or SecretBinary
fields.
+ * If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If
+ * that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it
+ * encrypts the secret value.
*
- * You can use the account default CMK to encrypt and decrypt only if you call this operation using - * credentials from the same account that owns the secret. If the secret resides in a different account, - * then you must create a custom CMK and specify the ARN in this field. - *
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then + * you can't useaws/secretsmanager
to encrypt the secret, and you must create and use a
+ * customer managed KMS key.
*/
public String getKmsKeyId() {
@@ -761,48 +701,37 @@ public String getKmsKeyId() {
/**
*
- * (Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to be
- * used to encrypt the SecretString
or SecretBinary
values in the versions stored in this
- * secret.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
*
- * You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to reference - * a CMK in a different account, you can use only the key ARN or the alias ARN. + * To use a KMS key in a different account, use the key ARN or the alias ARN. *
*
- * If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's default
- * CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that name doesn't yet
- * exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's
- * SecretString
or SecretBinary
fields.
+ * If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If that key
+ * doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret
+ * value.
*
- * You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from
- * the same account that owns the secret. If the secret resides in a different account, then you must create a
- * custom CMK and specify the ARN in this field.
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't
+ * use aws/secretsmanager
to encrypt the secret, and you must create and use a customer managed KMS
+ * key.
*
SecretString
or SecretBinary
values in the versions
- * stored in this secret.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the
+ * secret.
* - * You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to - * reference a CMK in a different account, you can use only the key ARN or the alias ARN. + * To use a KMS key in a different account, use the key ARN or the alias ARN. *
*
- * If you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's
- * default CMK (the one named aws/secretsmanager
). If a Amazon Web Services KMS CMK with that
- * name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to
- * encrypt a version's SecretString
or SecretBinary
fields.
+ * If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager
. If
+ * that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it
+ * encrypts the secret value.
*
- * You can use the account default CMK to encrypt and decrypt only if you call this operation using - * credentials from the same account that owns the secret. If the secret resides in a different account, then - * you must create a custom CMK and specify the ARN in this field. - *
+ * If the secret is in a different Amazon Web Services account from the credentials calling the API, then you + * can't useaws/secretsmanager
to encrypt the secret, and you must create and use a customer
+ * managed KMS key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -813,17 +742,14 @@ public CreateSecretRequest withKmsKeyId(String kmsKeyId) {
/**
* - * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this - * parameter in the command-line tools, we recommend that you store your binary data in a file and then use the - * appropriate technique for your tool to pass the contents of the file as a parameter. + * The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary + * data in a file and then pass the contents of the file as a parameter. *
*
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
- * be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
- * This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon - * Web Services CLI or one of the Amazon Web Services SDKs. + * This parameter is not available in the Secrets Manager console. *
** The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. @@ -837,16 +763,13 @@ public CreateSecretRequest withKmsKeyId(String kmsKeyId) { *
* * @param secretBinary - * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To - * use this parameter in the command-line tools, we recommend that you store your binary data in a file and - * then use the appropriate technique for your tool to pass the contents of the file as a parameter. + * The binary data to encrypt and store in the new version of the secret. We recommend that you store your + * binary data in a file and then pass the contents of the file as a parameter. *
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot
- * both be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
- * This parameter is not available using the Secrets Manager console. It can be accessed only by using the - * Amazon Web Services CLI or one of the Amazon Web Services SDKs. + * This parameter is not available in the Secrets Manager console. */ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { @@ -855,17 +778,14 @@ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { /** *
- * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this - * parameter in the command-line tools, we recommend that you store your binary data in a file and then use the - * appropriate technique for your tool to pass the contents of the file as a parameter. + * The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary + * data in a file and then pass the contents of the file as a parameter. *
*
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
- * be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
- * This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon - * Web Services CLI or one of the Amazon Web Services SDKs. + * This parameter is not available in the Secrets Manager console. *
** {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend @@ -875,16 +795,13 @@ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { * {@code position}. *
* - * @return (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To - * use this parameter in the command-line tools, we recommend that you store your binary data in a file and - * then use the appropriate technique for your tool to pass the contents of the file as a parameter. + * @return The binary data to encrypt and store in the new version of the secret. We recommend that you store your + * binary data in a file and then pass the contents of the file as a parameter. *
- * Either SecretString
or SecretBinary
must have a value, but not both. They
- * cannot both be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
- * This parameter is not available using the Secrets Manager console. It can be accessed only by using the - * Amazon Web Services CLI or one of the Amazon Web Services SDKs. + * This parameter is not available in the Secrets Manager console. */ public java.nio.ByteBuffer getSecretBinary() { @@ -893,17 +810,14 @@ public java.nio.ByteBuffer getSecretBinary() { /** *
- * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this - * parameter in the command-line tools, we recommend that you store your binary data in a file and then use the - * appropriate technique for your tool to pass the contents of the file as a parameter. + * The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary + * data in a file and then pass the contents of the file as a parameter. *
*
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
- * be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
- * This parameter is not available using the Secrets Manager console. It can be accessed only by using the Amazon - * Web Services CLI or one of the Amazon Web Services SDKs. + * This parameter is not available in the Secrets Manager console. *
** The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. @@ -917,16 +831,13 @@ public java.nio.ByteBuffer getSecretBinary() { *
* * @param secretBinary - * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To - * use this parameter in the command-line tools, we recommend that you store your binary data in a file and - * then use the appropriate technique for your tool to pass the contents of the file as a parameter. + * The binary data to encrypt and store in the new version of the secret. We recommend that you store your + * binary data in a file and then pass the contents of the file as a parameter. *
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot
- * both be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
- * This parameter is not available using the Secrets Manager console. It can be accessed only by using the - * Amazon Web Services CLI or one of the Amazon Web Services SDKs. + * This parameter is not available in the Secrets Manager console. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -937,40 +848,28 @@ public CreateSecretRequest withSecretBinary(java.nio.ByteBuffer secretBinary) { /** *
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. + * The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of + * key/value pairs for your secret value. *
*
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
- * be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
* If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text
* in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON
- * structure of key/value pairs that the Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. - * For more information, see Specifying parameter values for - * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * structure of key/value pairs that a Lambda rotation function can parse. *
* * @param secretString - * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. + * The text data to encrypt and store in this new version of the secret. We recommend you use a JSON + * structure of key/value pairs for your secret value. *
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot
- * both be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
* If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret
* text in only the SecretString
parameter. The Secrets Manager console stores the information
- * as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value - * pairs. For more information, see Specifying parameter - * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * as a JSON structure of key/value pairs that a Lambda rotation function can parse. */ public void setSecretString(String secretString) { @@ -979,39 +878,27 @@ public void setSecretString(String secretString) { /** *
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. + * The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of + * key/value pairs for your secret value. *
*
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
- * be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
* If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text
* in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON
- * structure of key/value pairs that the Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. - * For more information, see Specifying parameter values for - * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * structure of key/value pairs that a Lambda rotation function can parse. *
* - * @return (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. + * @return The text data to encrypt and store in this new version of the secret. We recommend you use a JSON + * structure of key/value pairs for your secret value. *
- * Either SecretString
or SecretBinary
must have a value, but not both. They
- * cannot both be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
* If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected
* secret text in only the SecretString
parameter. The Secrets Manager console stores the
- * information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value - * pairs. For more information, see Specifying parameter - * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * information as a JSON structure of key/value pairs that a Lambda rotation function can parse. */ public String getSecretString() { @@ -1020,40 +907,28 @@ public String getSecretString() { /** *
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. + * The text data to encrypt and store in this new version of the secret. We recommend you use a JSON structure of + * key/value pairs for your secret value. *
*
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot both
- * be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
* If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text
* in only the SecretString
parameter. The Secrets Manager console stores the information as a JSON
- * structure of key/value pairs that the Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. - * For more information, see Specifying parameter values for - * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * structure of key/value pairs that a Lambda rotation function can parse. *
* * @param secretString - * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. + * The text data to encrypt and store in this new version of the secret. We recommend you use a JSON + * structure of key/value pairs for your secret value. *
- * Either SecretString
or SecretBinary
must have a value, but not both. They cannot
- * both be empty.
+ * Either SecretString
or SecretBinary
must have a value, but not both.
*
* If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret
* text in only the SecretString
parameter. The Secrets Manager console stores the information
- * as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value - * pairs. For more information, see Specifying parameter - * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * as a JSON structure of key/value pairs that a Lambda rotation function can parse. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -1064,57 +939,49 @@ public CreateSecretRequest withSecretString(String secretString) { /** *
- * (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" - * pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use - * UntagResource. + * A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for + * example: + *
+ *
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
*
* Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key * "abc". *
- *
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or
- * removing a tag can change permissions. If the successful completion of this operation would result in you losing
- * your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can
+ * change permissions. If the completion of this operation would result in you losing your permissions for this
+ * secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more
+ * information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the - * various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. For example: - *
- *
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
+ * Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use
+ * single quotes to avoid confusion with the double quotes required in the JSON text.
*
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to - * avoid confusion with the double quotes required in the JSON text. - *
- *- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
*
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
+ *
* Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one * with key "abc". *
- *
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then
- * adding or removing a tag can change permissions. If the successful completion of this operation would
- * result in you losing your permissions for this secret, then this operation is blocked and returns an
- * Access Denied
error.
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a
+ * tag can change permissions. If the completion of this operation would result in you losing your
+ * permissions for this secret, then Secrets Manager blocks the operation and returns an
+ * Access Denied
error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter - * for the various command line tool environments, see Using - * JSON for Parameters in the CLI User Guide. For example: - *
- *
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
+ * JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter,
+ * you should use single quotes to avoid confusion with the double quotes required in the JSON text.
*
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single - * quotes to avoid confusion with the double quotes required in the JSON text. - *
- *- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have + * If you use your tagging schema across multiple services and resources, other services might have * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers * representable in UTF-8, plus the following special characters: + - = . _ : / @. *
@@ -1217,57 +1077,49 @@ public java.util.List- * (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" - * pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use - * UntagResource. + * A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for + * example: + *
+ *
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
*
* Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key * "abc". *
- *
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or
- * removing a tag can change permissions. If the successful completion of this operation would result in you losing
- * your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can
+ * change permissions. If the completion of this operation would result in you losing your permissions for this
+ * secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more
+ * information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the - * various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. For example: - *
- *
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
+ * Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use
+ * single quotes to avoid confusion with the double quotes required in the JSON text.
*
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to - * avoid confusion with the double quotes required in the JSON text. - *
- *- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
*
- * Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one
- * with key "abc".
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
*
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then
- * adding or removing a tag can change permissions. If the successful completion of this operation would
- * result in you losing your permissions for this secret, then this operation is blocked and returns an
- * Access Denied
error.
+ * Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one
+ * with key "abc".
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter for
- * the various command line tool environments, see Using
- * JSON for Parameters in the CLI User Guide. For example:
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a tag
+ * can change permissions. If the completion of this operation would result in you losing your permissions
+ * for this secret, then Secrets Manager blocks the operation and returns an Access Denied
+ * error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
+ * For information about how to format a JSON parameter for the various command line tool environments, see
+ * Using
+ * JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter,
+ * you should use single quotes to avoid confusion with the double quotes required in the JSON text.
*
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single - * quotes to avoid confusion with the double quotes required in the JSON text. - *
- *- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have + * If you use your tagging schema across multiple services and resources, other services might have * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers * representable in UTF-8, plus the following special characters: + - = . _ : / @. *
@@ -1376,57 +1220,49 @@ public void setTags(java.util.Collection- * (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" - * pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use - * UntagResource. + * A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for + * example: + *
+ *
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
*
* Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key * "abc". *
- *
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or
- * removing a tag can change permissions. If the successful completion of this operation would result in you losing
- * your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can
+ * change permissions. If the completion of this operation would result in you losing your permissions for this
+ * secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more
+ * information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the - * various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. For example: + * Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use + * single quotes to avoid confusion with the double quotes required in the JSON text. *
*
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
- *
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to - * avoid confusion with the double quotes required in the JSON text. - *
- *- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
*- * Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one - * with key "abc". - *
- *
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then
- * adding or removing a tag can change permissions. If the successful completion of this operation would
- * result in you losing your permissions for this secret, then this operation is blocked and returns an
- * Access Denied
error.
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter for - * the various command line tool environments, see Using - * JSON for Parameters in the CLI User Guide. For example: + * Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one + * with key "abc". *
*
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a tag
+ * can change permissions. If the completion of this operation would result in you losing your permissions
+ * for this secret, then Secrets Manager blocks the operation and returns an Access Denied
+ * error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single - * quotes to avoid confusion with the double quotes required in the JSON text. + * For information about how to format a JSON parameter for the various command line tool environments, see + * Using + * JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, + * you should use single quotes to avoid confusion with the double quotes required in the JSON text. *
*- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have + * If you use your tagging schema across multiple services and resources, other services might have * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers * representable in UTF-8, plus the following special characters: + - = . _ : / @. *
@@ -1542,57 +1370,49 @@ public CreateSecretRequest withTags(Tag... tags) { /** *- * (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" - * pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use - * UntagResource. + * A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for + * example: + *
+ *
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
*
* Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key * "abc". *
- *
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then adding or
- * removing a tag can change permissions. If the successful completion of this operation would result in you losing
- * your permissions for this secret, then this operation is blocked and returns an Access Denied
error.
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can
+ * change permissions. If the completion of this operation would result in you losing your permissions for this
+ * secret, then Secrets Manager blocks the operation and returns an Access Denied
error. For more
+ * information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the - * various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. For example: + * Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use + * single quotes to avoid confusion with the double quotes required in the JSON text. *
*
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
- *
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to - * avoid confusion with the double quotes required in the JSON text. - *
- *- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have - * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in - * UTF-8, plus the following special characters: + - = . _ : / @. + * If you use your tagging schema across multiple services and resources, other services might have restrictions on + * allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the + * following special characters: + - = . _ : / @. *
*- * Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one - * with key "abc". - *
- *
- * If you check tags in IAM policy Condition
elements as part of your security strategy, then
- * adding or removing a tag can change permissions. If the successful completion of this operation would
- * result in you losing your permissions for this secret, then this operation is blocked and returns an
- * Access Denied
error.
+ * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
*
- * This parameter requires a JSON text string argument. For information on how to format a JSON parameter for - * the various command line tool environments, see Using - * JSON for Parameters in the CLI User Guide. For example: + * Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one + * with key "abc". *
*
- * [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
+ * If you check tags in permissions policies as part of your security strategy, then adding or removing a tag
+ * can change permissions. If the completion of this operation would result in you losing your permissions
+ * for this secret, then Secrets Manager blocks the operation and returns an Access Denied
+ * error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags.
*
- * If your command-line tool or SDK requires quotation marks around the parameter, you should use single - * quotes to avoid confusion with the double quotes required in the JSON text. + * For information about how to format a JSON parameter for the various command line tool environments, see + * Using + * JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, + * you should use single quotes to avoid confusion with the double quotes required in the JSON text. *
*- * The following basic restrictions apply to tags: + * The following restrictions apply to tags: *
*- * Maximum number of tags per secret—50 + * Maximum number of tags per secret: 50 *
*- * Maximum key length—127 Unicode characters in UTF-8 + * Maximum key length: 127 Unicode characters in UTF-8 *
*- * Maximum value length—255 Unicode characters in UTF-8 + * Maximum value length: 255 Unicode characters in UTF-8 *
*- * If you use your tagging schema across multiple services and resources, remember other services might have + * If you use your tagging schema across multiple services and resources, other services might have * restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers * representable in UTF-8, plus the following special characters: + - = . _ : / @. *
@@ -1698,12 +1510,10 @@ public CreateSecretRequest withTags(java.util.Collection- * (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the - * list of regions specified in the parameter. + * A list of Regions and KMS keys to replicate secrets. *
* - * @return (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to - * the list of regions specified in the parameter. + * @return A list of Regions and KMS keys to replicate secrets. */ public java.util.List- * (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the - * list of regions specified in the parameter. + * A list of Regions and KMS keys to replicate secrets. *
* * @param addReplicaRegions - * (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to - * the list of regions specified in the parameter. + * A list of Regions and KMS keys to replicate secrets. */ public void setAddReplicaRegions(java.util.Collection- * (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the - * list of regions specified in the parameter. + * A list of Regions and KMS keys to replicate secrets. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -1742,8 +1549,7 @@ public void setAddReplicaRegions(java.util.Collection
- * (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the - * list of regions specified in the parameter. + * A list of Regions and KMS keys to replicate secrets. *
* * @param addReplicaRegions - * (Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to - * the list of regions specified in the parameter. + * A list of Regions and KMS keys to replicate secrets. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -1776,11 +1580,11 @@ public CreateSecretRequest withAddReplicaRegions(java.util.Collection- * (Optional) If set, the replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
* - * @return (Optional) If set, the replication overwrites a secret with the same name in the destination region. + * @return Specifies whether to overwrite a secret with the same name in the destination Region. */ public Boolean getForceOverwriteReplicaSecret() { @@ -1801,11 +1605,11 @@ public Boolean getForceOverwriteReplicaSecret() { /** *- * (Optional) If set, the replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
* * @param forceOverwriteReplicaSecret - * (Optional) If set, the replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -1816,10 +1620,10 @@ public CreateSecretRequest withForceOverwriteReplicaSecret(Boolean forceOverwrit /** *- * (Optional) If set, the replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
* - * @return (Optional) If set, the replication overwrites a secret with the same name in the destination region. + * @return Specifies whether to overwrite a secret with the same name in the destination Region. */ public Boolean isForceOverwriteReplicaSecret() { diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CreateSecretResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CreateSecretResult.java index 694409d9a528..c1f062058476 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CreateSecretResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/CreateSecretResult.java @@ -25,60 +25,59 @@ public class CreateSecretResult extends com.amazonaws.AmazonWebServiceResult- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. - *
- *- * The friendly name of the secret that you just created. + * The name of the new secret. *
*/ private String name; /** *- * The unique identifier associated with the version of the secret you just created. + * The unique identifier associated with the version of the new secret. *
*/ private String versionId; /** *
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.
+ * A list of the replicas of this secret and their status:
*
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * The Amazon Resource Name (ARN) of the secret that you just created. + * The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This + * ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old + * secret don't get access to the new secret because the ARNs are different. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs are - * different. - *
+ * The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This + * ensures that if you create a new secret with the same name as a deleted secret, then users with access to + * the old secret don't get access to the new secret because the ARNs are different. */ public void setARN(String aRN) { @@ -87,25 +86,14 @@ public void setARN(String aRN) { /** *- * The Amazon Resource Name (ARN) of the secret that you just created. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. + * The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This + * ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old + * secret don't get access to the new secret because the ARNs are different. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs - * are different. - *
+ * @return The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. + * This ensures that if you create a new secret with the same name as a deleted secret, then users with + * access to the old secret don't get access to the new secret because the ARNs are different. */ public String getARN() { @@ -114,26 +102,15 @@ public String getARN() { /** *- * The Amazon Resource Name (ARN) of the secret that you just created. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. + * The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This + * ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old + * secret don't get access to the new secret because the ARNs are different. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs are - * different. - *
+ * The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This + * ensures that if you create a new secret with the same name as a deleted secret, then users with access to + * the old secret don't get access to the new secret because the ARNs are different. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -144,11 +121,11 @@ public CreateSecretResult withARN(String aRN) { /** *- * The friendly name of the secret that you just created. + * The name of the new secret. *
* * @param name - * The friendly name of the secret that you just created. + * The name of the new secret. */ public void setName(String name) { @@ -157,10 +134,10 @@ public void setName(String name) { /** *- * The friendly name of the secret that you just created. + * The name of the new secret. *
* - * @return The friendly name of the secret that you just created. + * @return The name of the new secret. */ public String getName() { @@ -169,11 +146,11 @@ public String getName() { /** *- * The friendly name of the secret that you just created. + * The name of the new secret. *
* * @param name - * The friendly name of the secret that you just created. + * The name of the new secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -184,11 +161,11 @@ public CreateSecretResult withName(String name) { /** *- * The unique identifier associated with the version of the secret you just created. + * The unique identifier associated with the version of the new secret. *
* * @param versionId - * The unique identifier associated with the version of the secret you just created. + * The unique identifier associated with the version of the new secret. */ public void setVersionId(String versionId) { @@ -197,10 +174,10 @@ public void setVersionId(String versionId) { /** *- * The unique identifier associated with the version of the secret you just created. + * The unique identifier associated with the version of the new secret. *
* - * @return The unique identifier associated with the version of the secret you just created. + * @return The unique identifier associated with the version of the new secret. */ public String getVersionId() { @@ -209,11 +186,11 @@ public String getVersionId() { /** *- * The unique identifier associated with the version of the secret you just created. + * The unique identifier associated with the version of the new secret. *
* * @param versionId - * The unique identifier associated with the version of the secret you just created. + * The unique identifier associated with the version of the new secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -224,12 +201,43 @@ public CreateSecretResult withVersionId(String versionId) { /** *
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
*
InProgress
, Failed
or
- * InSync
.
+ * @return A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
*
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
InProgress
, Failed
or
- * InSync
.
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if
@@ -268,8 +323,23 @@ public void setReplicationStatus(java.util.Collection
InProgress
, Failed
or
- * InSync
.
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
*
+ * InSync
, which indicates that the replica was created.
+ *
InProgress
, Failed
or
- * InSync
.
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to delete the attached resource-based policy for. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -38,16 +37,14 @@ public class DeleteResourcePolicyRequest extends com.amazonaws.AmazonWebServiceR /** *
- * Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to delete the attached resource-based policy for. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to delete the attached resource-based policy for. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to delete the attached resource-based policy for. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -58,15 +55,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to delete the attached resource-based policy for. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret that you want to delete the attached resource-based policy for. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or name of the secret to delete the attached resource-based policy for. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -77,16 +72,14 @@ public String getSecretId() { /** *
- * Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to delete the attached resource-based policy for. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to delete the attached resource-based policy for. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to delete the attached resource-based policy for. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DeleteResourcePolicyResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DeleteResourcePolicyResult.java index 275c7bb21d65..b408dd22f76a 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DeleteResourcePolicyResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DeleteResourcePolicyResult.java @@ -31,7 +31,7 @@ public class DeleteResourcePolicyResult extends com.amazonaws.AmazonWebServiceRe private String aRN; /** *
- * The friendly name of the secret that the resource-based policy was deleted for. + * The name of the secret that the resource-based policy was deleted for. *
*/ private String name; @@ -78,11 +78,11 @@ public DeleteResourcePolicyResult withARN(String aRN) { /** *- * The friendly name of the secret that the resource-based policy was deleted for. + * The name of the secret that the resource-based policy was deleted for. *
* * @param name - * The friendly name of the secret that the resource-based policy was deleted for. + * The name of the secret that the resource-based policy was deleted for. */ public void setName(String name) { @@ -91,10 +91,10 @@ public void setName(String name) { /** *- * The friendly name of the secret that the resource-based policy was deleted for. + * The name of the secret that the resource-based policy was deleted for. *
* - * @return The friendly name of the secret that the resource-based policy was deleted for. + * @return The name of the secret that the resource-based policy was deleted for. */ public String getName() { @@ -103,11 +103,11 @@ public String getName() { /** *- * The friendly name of the secret that the resource-based policy was deleted for. + * The name of the secret that the resource-based policy was deleted for. *
* * @param name - * The friendly name of the secret that the resource-based policy was deleted for. + * The name of the secret that the resource-based policy was deleted for. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DeleteSecretRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DeleteSecretRequest.java index 58831803d983..6c79b3d6e4e5 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DeleteSecretRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DeleteSecretRequest.java @@ -27,8 +27,7 @@ public class DeleteSecretRequest extends com.amazonaws.AmazonWebServiceRequest i /** *- * Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the - * secret. + * The ARN or name of the secret to delete. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -37,52 +36,44 @@ public class DeleteSecretRequest extends com.amazonaws.AmazonWebServiceRequest i private String secretId; /** *
- * (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
- * You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
- *
- * This value can range from 7 to 30 days with a default value of 30.
+ * 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.
*
- * (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
- * parameter and the RecoveryWindowInDays
parameter in the same API call.
+ * 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.
*
- * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same name, - * ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short + * delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with + * the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
- * permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
+ * 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
* parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no
* opportunity to recover the secret. You lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
- * the error ResourceNotFoundException
in order to correctly handle retries.
- *
- * Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the - * secret. + * The ARN or name of the secret to delete. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name - * of the secret. + * The ARN or name of the secret to delete. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -93,15 +84,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the - * secret. + * The ARN or name of the secret to delete. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly - * name of the secret. + * @return The ARN or name of the secret to delete. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -112,16 +101,14 @@ public String getSecretId() { /** *
- * Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the - * secret. + * The ARN or name of the secret to delete. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name - * of the secret. + * The ARN or name of the secret to delete. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -134,19 +121,15 @@ public DeleteSecretRequest withSecretId(String secretId) { /** *
- * (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
- * You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
- *
- * This value can range from 7 to 30 days with a default value of 30.
+ * 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.
*
ForceDeleteWithoutRecovery
parameter in the
- * same API call.
- *
- * This value can range from 7 to 30 days with a default value of 30.
+ * 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.
*/
public void setRecoveryWindowInDays(Long recoveryWindowInDays) {
@@ -155,18 +138,14 @@ public void setRecoveryWindowInDays(Long recoveryWindowInDays) {
/**
*
- * (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
- * You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
- *
- * This value can range from 7 to 30 days with a default value of 30.
+ * 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.
*
ForceDeleteWithoutRecovery
parameter in
- * the same API call.
- *
- * This value can range from 7 to 30 days with a default value of 30.
+ * @return 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.
*/
public Long getRecoveryWindowInDays() {
@@ -175,19 +154,15 @@ public Long getRecoveryWindowInDays() {
/**
*
- * (Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret.
- * You can't use both this parameter and the ForceDeleteWithoutRecovery
parameter in the same API call.
- *
- * This value can range from 7 to 30 days with a default value of 30.
+ * 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.
*
ForceDeleteWithoutRecovery
parameter in the
- * same API call.
- *
- * This value can range from 7 to 30 days with a default value of 30.
+ * 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -198,49 +173,41 @@ public DeleteSecretRequest withRecoveryWindowInDays(Long recoveryWindowInDays) {
/**
*
- * (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
- * parameter and the RecoveryWindowInDays
parameter in the same API call.
+ * 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.
*
- * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same name, - * ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short + * delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with + * the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
- * permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
+ * 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
* parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no
* opportunity to recover the secret. You lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
- * the error ResourceNotFoundException
in order to correctly handle retries.
- *
RecoveryWindowInDays
parameter in the same API call.
+ * 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.
* - * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same - * name, ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a + * short delay before the secret is permanently deleted. If you delete a secret and then immediately create a + * secret with the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period
- * before the permanent deletion that Amazon Web Services would normally impose with the
+ * 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
parameter. If you delete a secret with the
* ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You
* lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not
- * return the error ResourceNotFoundException
in order to correctly handle retries.
- *
- * (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
- * parameter and the RecoveryWindowInDays
parameter in the same API call.
+ * 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.
*
- * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same name, - * ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short + * delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with + * the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
- * permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
+ * 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
* parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no
* opportunity to recover the secret. You lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
- * the error ResourceNotFoundException
in order to correctly handle retries.
- *
RecoveryWindowInDays
parameter in the same API call.
+ * @return 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.
* - * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same - * name, ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a + * short delay before the secret is permanently deleted. If you delete a secret and then immediately create + * a secret with the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period
- * before the permanent deletion that Amazon Web Services would normally impose with the
+ * 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
parameter. If you delete a secret with the
* ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You
* lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not
- * return the error ResourceNotFoundException
in order to correctly handle retries.
- *
- * (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
- * parameter and the RecoveryWindowInDays
parameter in the same API call.
+ * 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.
*
- * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same name, - * ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short + * delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with + * the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
- * permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
+ * 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
* parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no
* opportunity to recover the secret. You lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
- * the error ResourceNotFoundException
in order to correctly handle retries.
- *
RecoveryWindowInDays
parameter in the same API call.
+ * 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.
* - * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same - * name, ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a + * short delay before the secret is permanently deleted. If you delete a secret and then immediately create a + * secret with the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period
- * before the permanent deletion that Amazon Web Services would normally impose with the
+ * 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
parameter. If you delete a secret with the
* ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You
* lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not
- * return the error ResourceNotFoundException
in order to correctly handle retries.
- *
- * (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this
- * parameter and the RecoveryWindowInDays
parameter in the same API call.
+ * 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.
*
- * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same name, - * ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a short + * delay before the secret is permanently deleted. If you delete a secret and then immediately create a secret with + * the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the
- * permanent deletion that Amazon Web Services would normally impose with the RecoveryWindowInDays
+ * 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
* parameter. If you delete a secret with the ForceDeleteWithouRecovery
parameter, then you have no
* opportunity to recover the secret. You lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return
- * the error ResourceNotFoundException
in order to correctly handle retries.
- *
RecoveryWindowInDays
parameter in the same API call.
+ * @return 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.
* - * An asynchronous background process performs the actual deletion, so there can be a short delay before the - * operation completes. If you write code to delete and then immediately recreate a secret with the same - * name, ensure that your code includes appropriate back off and retry logic. + * Secrets Manager performs the actual deletion with an asynchronous background process, so there might be a + * short delay before the secret is permanently deleted. If you delete a secret and then immediately create + * a secret with the same name, use appropriate back off and retry logic. *
*
- * Use this parameter with caution. This parameter causes the operation to skip the normal waiting period
- * before the permanent deletion that Amazon Web Services would normally impose with the
+ * 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
parameter. If you delete a secret with the
* ForceDeleteWithouRecovery
parameter, then you have no opportunity to recover the secret. You
* lose the secret permanently.
*
- * If you use this parameter and include a previously deleted or nonexistent secret, the operation does not
- * return the error ResourceNotFoundException
in order to correctly handle retries.
- *
- * The friendly name of the secret currently scheduled for deletion. + * The name of the secret. *
*/ private String name; /** *
- * The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This
- * value is the date and time of the delete request plus the number of days specified in
+ * The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no
+ * longer be restored. This value is the date and time of the delete request plus the number of days in
* RecoveryWindowInDays
.
*
- * The ARN of the secret that is now scheduled for deletion. + * The ARN of the secret. *
* - * @return The ARN of the secret that is now scheduled for deletion. + * @return The ARN of the secret. */ public String getARN() { @@ -71,11 +71,11 @@ public String getARN() { /** *- * The ARN of the secret that is now scheduled for deletion. + * The ARN of the secret. *
* * @param aRN - * The ARN of the secret that is now scheduled for deletion. + * The ARN of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -86,11 +86,11 @@ public DeleteSecretResult withARN(String aRN) { /** *- * The friendly name of the secret currently scheduled for deletion. + * The name of the secret. *
* * @param name - * The friendly name of the secret currently scheduled for deletion. + * The name of the secret. */ public void setName(String name) { @@ -99,10 +99,10 @@ public void setName(String name) { /** *- * The friendly name of the secret currently scheduled for deletion. + * The name of the secret. *
* - * @return The friendly name of the secret currently scheduled for deletion. + * @return The name of the secret. */ public String getName() { @@ -111,11 +111,11 @@ public String getName() { /** *- * The friendly name of the secret currently scheduled for deletion. + * The name of the secret. *
* * @param name - * The friendly name of the secret currently scheduled for deletion. + * The name of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -126,14 +126,14 @@ public DeleteSecretResult withName(String name) { /** *
- * The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This
- * value is the date and time of the delete request plus the number of days specified in
+ * The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no
+ * longer be restored. This value is the date and time of the delete request plus the number of days in
* RecoveryWindowInDays
.
*
RecoveryWindowInDays
.
*/
@@ -143,13 +143,13 @@ public void setDeletionDate(java.util.Date deletionDate) {
/**
*
- * The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This
- * value is the date and time of the delete request plus the number of days specified in
+ * The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no
+ * longer be restored. This value is the date and time of the delete request plus the number of days in
* RecoveryWindowInDays
.
*
RecoveryWindowInDays
.
*/
@@ -159,14 +159,14 @@ public java.util.Date getDeletionDate() {
/**
*
- * The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This
- * value is the date and time of the delete request plus the number of days specified in
+ * The date and time after which this secret Secrets Manager can permanently delete this secret, and it can no
+ * longer be restored. This value is the date and time of the delete request plus the number of days in
* RecoveryWindowInDays
.
*
RecoveryWindowInDays
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DescribeSecretRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DescribeSecretRequest.java
index b4aea5943b2d..f93dcf56235c 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DescribeSecretRequest.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DescribeSecretRequest.java
@@ -27,8 +27,7 @@ public class DescribeSecretRequest extends com.amazonaws.AmazonWebServiceRequest
/**
* - * The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -38,16 +37,14 @@ public class DescribeSecretRequest extends com.amazonaws.AmazonWebServiceRequest /** *
- * The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * The identifier of the secret whose details you want to retrieve. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -58,15 +55,13 @@ public void setSecretId(String secretId) { /** *
- * The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return The identifier of the secret whose details you want to retrieve. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -77,16 +72,14 @@ public String getSecretId() { /** *
- * The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * The identifier of the secret whose details you want to retrieve. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
* For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
* @return Returns a reference to this object so that method calls can be chained together.
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DescribeSecretResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DescribeSecretResult.java
index cf22fc8f2702..580fe381f923 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DescribeSecretResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/DescribeSecretResult.java
@@ -31,56 +31,50 @@ public class DescribeSecretResult extends com.amazonaws.AmazonWebServiceResult
- * The user-provided description of the secret. + * The description of the secret. *
*/ private String description; /** *
- * The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the
- * SecretString
or SecretBinary
fields in each version of the secret. If you don't provide
- * a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK
- * (the one named awssecretsmanager
) for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the
+ * Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*
- * Specifies whether automatic rotation is enabled for this secret. + * Specifies whether automatic rotation is turned on for this secret. *
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater
- * than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
*
- * The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the
- * schedule or manually by a call to RotateSecret
.
+ * The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
*
- * A structure with the rotation configuration for this secret. This field is only populated if rotation is - * configured. + * The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but + * it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never + * had rotation turned on, this field is omitted. *
*/ private RotationRulesType rotationRules; /** *- * The last date and time that the rotation process for this secret was invoked. - *
- *- * The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret - * doesn't rotate, Secrets Manager returns a null value. + * The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, + * Secrets Manager returns null. *
*/ private java.util.Date lastRotatedDate; @@ -92,66 +86,109 @@ public class DescribeSecretResult extends com.amazonaws.AmazonWebServiceResult- * This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets - * Manager deletes the secret and all of its versions. + * The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When + * you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. + * Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions. *
*- * If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not - * accessible. To cancel a scheduled deletion and restore access, use RestoreSecret. + * If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. + * To cancel a scheduled deletion and restore access to the secret, use RestoreSecret. *
*/ private java.util.Date deletedDate; /** *- * The list of user-defined tags that are associated with the secret. To add tags to a secret, use - * TagResource. To remove tags, use UntagResource. + * The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use + * UntagResource. *
*/ private java.util.List
- * A list of all of the currently assigned VersionStage
staging labels and the VersionId
- * that each is attached to. Staging labels are used to keep track of the different versions during the rotation
- * process.
+ * A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels
+ * are considered deprecated and Secrets Manager can delete them.
*
- * A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such - * versions are not included in this list. + * Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging + * labels for rotation are: + *
+ *
+ * AWSCURRENT
, which indicates the current version of the secret.
+ *
+ * AWSPENDING
, which indicates the version of the secret that contains new secret information that will
+ * become the next current version when rotation finishes.
+ *
+ * During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret
+ * version. To check if a secret version exists, call GetSecretValue.
+ *
+ * AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the
+ * last known good version.
+ *
+ * For more information about rotation and staging labels, see How rotation + * works. *
- *- * Returns the name of the service that created this secret. + * The name of the service that created this secret. *
*/ private String owningService; /** *- * The date you created the secret. + * The date the secret was created. *
*/ private java.util.Date createdDate; /** *
- * Specifies the primary region for secret replication.
+ * The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
+ * ReplicationStatus
.
*
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.P
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
*
+ * InSync
, which indicates that the replica was created.
+ *
- * The user-provided friendly name of the secret. + * The name of the secret. *
* * @param name - * The user-provided friendly name of the secret. + * The name of the secret. */ public void setName(String name) { @@ -210,10 +247,10 @@ public void setName(String name) { /** *- * The user-provided friendly name of the secret. + * The name of the secret. *
* - * @return The user-provided friendly name of the secret. + * @return The name of the secret. */ public String getName() { @@ -222,11 +259,11 @@ public String getName() { /** *- * The user-provided friendly name of the secret. + * The name of the secret. *
* * @param name - * The user-provided friendly name of the secret. + * The name of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -237,11 +274,11 @@ public DescribeSecretResult withName(String name) { /** *- * The user-provided description of the secret. + * The description of the secret. *
* * @param description - * The user-provided description of the secret. + * The description of the secret. */ public void setDescription(String description) { @@ -250,10 +287,10 @@ public void setDescription(String description) { /** *- * The user-provided description of the secret. + * The description of the secret. *
* - * @return The user-provided description of the secret. + * @return The description of the secret. */ public String getDescription() { @@ -262,11 +299,11 @@ public String getDescription() { /** *- * The user-provided description of the secret. + * The description of the secret. *
* * @param description - * The user-provided description of the secret. + * The description of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -277,17 +314,13 @@ public DescribeSecretResult withDescription(String description) { /** *
- * The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the
- * SecretString
or SecretBinary
fields in each version of the secret. If you don't provide
- * a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK
- * (the one named awssecretsmanager
) for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the
+ * Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*
SecretString
or SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web
- * Services KMS CMK (the one named awssecretsmanager
) for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted
+ * with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*/
public void setKmsKeyId(String kmsKeyId) {
@@ -296,16 +329,12 @@ public void setKmsKeyId(String kmsKeyId) {
/**
*
- * The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the
- * SecretString
or SecretBinary
fields in each version of the secret. If you don't provide
- * a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK
- * (the one named awssecretsmanager
) for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the
+ * Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*
SecretString
or SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web
- * Services KMS CMK (the one named awssecretsmanager
) for this account.
+ * @return The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted
+ * with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*/
public String getKmsKeyId() {
@@ -314,17 +343,13 @@ public String getKmsKeyId() {
/**
*
- * The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the
- * SecretString
or SecretBinary
fields in each version of the secret. If you don't provide
- * a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web Services KMS CMK
- * (the one named awssecretsmanager
) for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the
+ * Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*
SecretString
or SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default Amazon Web
- * Services KMS CMK (the one named awssecretsmanager
) for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted
+ * with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -335,18 +360,16 @@ public DescribeSecretResult withKmsKeyId(String kmsKeyId) {
/**
* - * Specifies whether automatic rotation is enabled for this secret. + * Specifies whether automatic rotation is turned on for this secret. *
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater
- * than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value
- * greater than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
*/
public void setRotationEnabled(Boolean rotationEnabled) {
@@ -355,17 +378,15 @@ public void setRotationEnabled(Boolean rotationEnabled) {
/**
*
- * Specifies whether automatic rotation is enabled for this secret. + * Specifies whether automatic rotation is turned on for this secret. *
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater
- * than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value
- * greater than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
*/
public Boolean getRotationEnabled() {
@@ -374,18 +395,16 @@ public Boolean getRotationEnabled() {
/**
*
- * Specifies whether automatic rotation is enabled for this secret. + * Specifies whether automatic rotation is turned on for this secret. *
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater
- * than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value
- * greater than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -396,17 +415,15 @@ public DescribeSecretResult withRotationEnabled(Boolean rotationEnabled) {
/**
*
- * Specifies whether automatic rotation is enabled for this secret. + * Specifies whether automatic rotation is turned on for this secret. *
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value greater
- * than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
*
- * To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays
set to a value
- * greater than 0. To disable rotation, use CancelRotateSecret.
+ * To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
*/
public Boolean isRotationEnabled() {
@@ -415,13 +432,11 @@ public Boolean isRotationEnabled() {
/**
*
- * The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the
- * schedule or manually by a call to RotateSecret
.
+ * The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
*
RotateSecret
.
+ * The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
*/
public void setRotationLambdaARN(String rotationLambdaARN) {
@@ -430,12 +445,10 @@ public void setRotationLambdaARN(String rotationLambdaARN) {
/**
*
- * The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the
- * schedule or manually by a call to RotateSecret
.
+ * The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
*
RotateSecret
.
+ * @return The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
*/
public String getRotationLambdaARN() {
@@ -444,13 +457,11 @@ public String getRotationLambdaARN() {
/**
*
- * The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the
- * schedule or manually by a call to RotateSecret
.
+ * The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
*
RotateSecret
.
+ * The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -461,13 +472,15 @@ public DescribeSecretResult withRotationLambdaARN(String rotationLambdaARN) {
/**
* - * A structure with the rotation configuration for this secret. This field is only populated if rotation is - * configured. + * The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but + * it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never + * had rotation turned on, this field is omitted. *
* * @param rotationRules - * A structure with the rotation configuration for this secret. This field is only populated if rotation is - * configured. + * The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned + * on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If + * the secret never had rotation turned on, this field is omitted. */ public void setRotationRules(RotationRulesType rotationRules) { @@ -476,12 +489,14 @@ public void setRotationRules(RotationRulesType rotationRules) { /** *- * A structure with the rotation configuration for this secret. This field is only populated if rotation is - * configured. + * The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but + * it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never + * had rotation turned on, this field is omitted. *
* - * @return A structure with the rotation configuration for this secret. This field is only populated if rotation is - * configured. + * @return The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned + * on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If + * the secret never had rotation turned on, this field is omitted. */ public RotationRulesType getRotationRules() { @@ -490,13 +505,15 @@ public RotationRulesType getRotationRules() { /** *- * A structure with the rotation configuration for this secret. This field is only populated if rotation is - * configured. + * The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but + * it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never + * had rotation turned on, this field is omitted. *
* * @param rotationRules - * A structure with the rotation configuration for this secret. This field is only populated if rotation is - * configured. + * The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned + * on, but it is now turned off, this field shows the previous rotation schedule and rotation function. If + * the secret never had rotation turned on, this field is omitted. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -507,18 +524,13 @@ public DescribeSecretResult withRotationRules(RotationRulesType rotationRules) { /** *- * The last date and time that the rotation process for this secret was invoked. - *
- *- * The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret - * doesn't rotate, Secrets Manager returns a null value. + * The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, + * Secrets Manager returns null. *
* * @param lastRotatedDate - * The last date and time that the rotation process for this secret was invoked. - *- * The most recent date and time that the Secrets Manager rotation process successfully completed. If the - * secret doesn't rotate, Secrets Manager returns a null value. + * The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for + * rotation, Secrets Manager returns null. */ public void setLastRotatedDate(java.util.Date lastRotatedDate) { @@ -527,17 +539,12 @@ public void setLastRotatedDate(java.util.Date lastRotatedDate) { /** *
- * The last date and time that the rotation process for this secret was invoked. - *
- *- * The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret - * doesn't rotate, Secrets Manager returns a null value. + * The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, + * Secrets Manager returns null. *
* - * @return The last date and time that the rotation process for this secret was invoked. - *- * The most recent date and time that the Secrets Manager rotation process successfully completed. If the - * secret doesn't rotate, Secrets Manager returns a null value. + * @return The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for + * rotation, Secrets Manager returns null. */ public java.util.Date getLastRotatedDate() { @@ -546,18 +553,13 @@ public java.util.Date getLastRotatedDate() { /** *
- * The last date and time that the rotation process for this secret was invoked. - *
- *- * The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret - * doesn't rotate, Secrets Manager returns a null value. + * The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, + * Secrets Manager returns null. *
* * @param lastRotatedDate - * The last date and time that the rotation process for this secret was invoked. - *- * The most recent date and time that the Secrets Manager rotation process successfully completed. If the - * secret doesn't rotate, Secrets Manager returns a null value. + * The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for + * rotation, Secrets Manager returns null. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -608,13 +610,13 @@ public DescribeSecretResult withLastChangedDate(java.util.Date lastChangedDate) /** *
- * The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows - * only the date, not the time. + * The last date that the secret value was retrieved. This value does not include the time. This field is omitted if + * the secret has never been retrieved. *
* * @param lastAccessedDate - * The last date that this secret was accessed. This value is truncated to midnight of the date and therefore - * shows only the date, not the time. + * The last date that the secret value was retrieved. This value does not include the time. This field is + * omitted if the secret has never been retrieved. */ public void setLastAccessedDate(java.util.Date lastAccessedDate) { @@ -623,12 +625,12 @@ public void setLastAccessedDate(java.util.Date lastAccessedDate) { /** *- * The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows - * only the date, not the time. + * The last date that the secret value was retrieved. This value does not include the time. This field is omitted if + * the secret has never been retrieved. *
* - * @return The last date that this secret was accessed. This value is truncated to midnight of the date and - * therefore shows only the date, not the time. + * @return The last date that the secret value was retrieved. This value does not include the time. This field is + * omitted if the secret has never been retrieved. */ public java.util.Date getLastAccessedDate() { @@ -637,13 +639,13 @@ public java.util.Date getLastAccessedDate() { /** *- * The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows - * only the date, not the time. + * The last date that the secret value was retrieved. This value does not include the time. This field is omitted if + * the secret has never been retrieved. *
* * @param lastAccessedDate - * The last date that this secret was accessed. This value is truncated to midnight of the date and therefore - * shows only the date, not the time. + * The last date that the secret value was retrieved. This value does not include the time. This field is + * omitted if the secret has never been retrieved. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -654,20 +656,23 @@ public DescribeSecretResult withLastAccessedDate(java.util.Date lastAccessedDate /** *- * This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets - * Manager deletes the secret and all of its versions. + * The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When + * you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. + * Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions. *
*- * If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not - * accessible. To cancel a scheduled deletion and restore access, use RestoreSecret. + * If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. + * To cancel a scheduled deletion and restore access to the secret, use RestoreSecret. *
* * @param deletedDate - * This value exists if the secret is scheduled for deletion. Some time after the specified date and time, - * Secrets Manager deletes the secret and all of its versions. + * The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. + * When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting + * the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its + * versions. *- * If a secret is scheduled for deletion, then its details, including the encrypted secret information, is - * not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret. + * If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not + * accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret. */ public void setDeletedDate(java.util.Date deletedDate) { @@ -676,19 +681,22 @@ public void setDeletedDate(java.util.Date deletedDate) { /** *
- * This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets - * Manager deletes the secret and all of its versions. + * The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When + * you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. + * Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions. *
*- * If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not - * accessible. To cancel a scheduled deletion and restore access, use RestoreSecret. + * If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. + * To cancel a scheduled deletion and restore access to the secret, use RestoreSecret. *
* - * @return This value exists if the secret is scheduled for deletion. Some time after the specified date and time, - * Secrets Manager deletes the secret and all of its versions. + * @return The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is + * omitted. When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before + * deleting the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all + * of its versions. *- * If a secret is scheduled for deletion, then its details, including the encrypted secret information, is - * not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret. + * If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not + * accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret. */ public java.util.Date getDeletedDate() { @@ -697,20 +705,23 @@ public java.util.Date getDeletedDate() { /** *
- * This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets - * Manager deletes the secret and all of its versions. + * The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. When + * you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting the secret. + * Some time after the deleted date, Secrets Manager deletes the secret, including all of its versions. *
*- * If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not - * accessible. To cancel a scheduled deletion and restore access, use RestoreSecret. + * If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not accessible. + * To cancel a scheduled deletion and restore access to the secret, use RestoreSecret. *
* * @param deletedDate - * This value exists if the secret is scheduled for deletion. Some time after the specified date and time, - * Secrets Manager deletes the secret and all of its versions. + * The date the secret is scheduled for deletion. If it is not scheduled for deletion, this field is omitted. + * When you delete a secret, Secrets Manager requires a recovery window of at least 7 days before deleting + * the secret. Some time after the deleted date, Secrets Manager deletes the secret, including all of its + * versions. *- * If a secret is scheduled for deletion, then its details, including the encrypted secret information, is - * not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret. + * If a secret is scheduled for deletion, then its details, including the encrypted secret value, is not + * accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -721,12 +732,12 @@ public DescribeSecretResult withDeletedDate(java.util.Date deletedDate) { /** *
- * The list of user-defined tags that are associated with the secret. To add tags to a secret, use - * TagResource. To remove tags, use UntagResource. + * The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use + * UntagResource. *
* - * @return The list of user-defined tags that are associated with the secret. To add tags to a secret, use - * TagResource. To remove tags, use UntagResource. + * @return The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, + * use UntagResource. */ public java.util.List- * The list of user-defined tags that are associated with the secret. To add tags to a secret, use - * TagResource. To remove tags, use UntagResource. + * The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use + * UntagResource. *
* * @param tags - * The list of user-defined tags that are associated with the secret. To add tags to a secret, use - * TagResource. To remove tags, use UntagResource. + * The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, + * use UntagResource. */ public void setTags(java.util.Collection- * The list of user-defined tags that are associated with the secret. To add tags to a secret, use - * TagResource. To remove tags, use UntagResource. + * The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use + * UntagResource. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -765,8 +776,8 @@ public void setTags(java.util.Collection
- * The list of user-defined tags that are associated with the secret. To add tags to a secret, use - * TagResource. To remove tags, use UntagResource. + * The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use + * UntagResource. *
* * @param tags - * The list of user-defined tags that are associated with the secret. To add tags to a secret, use - * TagResource. To remove tags, use UntagResource. + * The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, + * use UntagResource. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -799,24 +810,75 @@ public DescribeSecretResult withTags(java.util.Collection
- * A list of all of the currently assigned VersionStage
staging labels and the VersionId
- * that each is attached to. Staging labels are used to keep track of the different versions during the rotation
- * process.
+ * A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels
+ * are considered deprecated and Secrets Manager can delete them.
+ *
+ * Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging + * labels for rotation are: + *
+ *
+ * AWSCURRENT
, which indicates the current version of the secret.
+ *
+ * AWSPENDING
, which indicates the version of the secret that contains new secret information that will
+ * become the next current version when rotation finishes.
*
- * A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such
- * versions are not included in this list.
+ * During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new secret
+ * version. To check if a secret version exists, call GetSecretValue.
+ *
+ * AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the
+ * last known good version.
+ *
+ * For more information about rotation and staging labels, see How rotation + * works. *
- *VersionStage
staging labels and the
- * VersionId
that each is attached to. Staging labels are used to keep track of the different
- * versions during the rotation process. - * A version that does not have any staging labels attached is considered deprecated and subject to - * deletion. Such versions are not included in this list. + * Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three + * staging labels for rotation are: *
+ *
+ * AWSCURRENT
, which indicates the current version of the secret.
+ *
+ * AWSPENDING
, which indicates the version of the secret that contains new secret information
+ * that will become the next current version when rotation finishes.
+ *
+ * During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new
+ * secret version. To check if a secret version exists, call GetSecretValue.
+ *
+ * AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as
+ * the last known good version.
+ *
+ * For more information about rotation and staging labels, see How rotation
+ * works.
*/
public java.util.Map
- * A list of all of the currently assigned
+ * Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging
+ * labels for rotation are:
+ *
+ *
- * A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such
- * versions are not included in this list.
+ *
+ * During rotation, Secrets Manager creates an
+ *
+ * For more information about rotation and staging labels, see How rotation
+ * works.
* VersionStage
staging labels and the VersionId
- * that each is attached to. Staging labels are used to keep track of the different versions during the rotation
- * process.
+ * A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels
+ * are considered deprecated and Secrets Manager can delete them.
+ *
+ *
+ * AWSCURRENT
, which indicates the current version of the secret.
* AWSPENDING
, which indicates the version of the secret that contains new secret information that will
+ * become the next current version when rotation finishes.
+ * AWSPENDING
version ID before creating the new secret
+ * version. To check if a secret version exists, call GetSecretValue.
+ * AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the
+ * last known good version.
+ *
VersionStage
staging labels and the
- * VersionId
that each is attached to. Staging labels are used to keep track of the different
- * versions during the rotation process. + * Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three + * staging labels for rotation are: + *
+ *
- * A version that does not have any staging labels attached is considered deprecated and subject to deletion.
- * Such versions are not included in this list.
+ * AWSCURRENT
, which indicates the current version of the secret.
*
+ * AWSPENDING
, which indicates the version of the secret that contains new secret information
+ * that will become the next current version when rotation finishes.
+ *
+ * During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new
+ * secret version. To check if a secret version exists, call GetSecretValue.
+ *
+ * AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as
+ * the last known good version.
+ *
+ * For more information about rotation and staging labels, see How rotation
+ * works.
*/
public void setVersionIdsToStages(java.util.Map
- * A list of all of the currently assigned
+ * Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three staging
+ * labels for rotation are:
+ *
+ *
+ *
+ * During rotation, Secrets Manager creates an
+ *
- * A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such
- * versions are not included in this list.
+ * For more information about rotation and staging labels, see How rotation
+ * works.
* VersionStage
staging labels and the VersionId
- * that each is attached to. Staging labels are used to keep track of the different versions during the rotation
- * process.
+ * A list of the versions of the secret that have staging labels attached. Versions that don't have staging labels
+ * are considered deprecated and Secrets Manager can delete them.
+ *
+ *
* AWSCURRENT
, which indicates the current version of the secret.
+ * AWSPENDING
, which indicates the version of the secret that contains new secret information that will
+ * become the next current version when rotation finishes.
+ * AWSPENDING
version ID before creating the new secret
+ * version. To check if a secret version exists, call GetSecretValue.
+ * AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as the
+ * last known good version.
*
VersionStage
staging labels and the
- * VersionId
that each is attached to. Staging labels are used to keep track of the different
- * versions during the rotation process. + * Secrets Manager uses staging labels to indicate the status of a secret version during rotation. The three + * staging labels for rotation are: + *
+ *
+ * AWSCURRENT
, which indicates the current version of the secret.
+ *
+ * AWSPENDING
, which indicates the version of the secret that contains new secret information
+ * that will become the next current version when rotation finishes.
+ *
+ * During rotation, Secrets Manager creates an AWSPENDING
version ID before creating the new
+ * secret version. To check if a secret version exists, call GetSecretValue.
+ *
- * A version that does not have any staging labels attached is considered deprecated and subject to deletion.
- * Such versions are not included in this list.
+ * AWSPREVIOUS
, which indicates the previous current version of the secret. You can use this as
+ * the last known good version.
*
+ * For more information about rotation and staging labels, see How rotation + * works. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -909,11 +1073,11 @@ public DescribeSecretResult clearVersionIdsToStagesEntries() { /** *
- * Returns the name of the service that created this secret. + * The name of the service that created this secret. *
* * @param owningService - * Returns the name of the service that created this secret. + * The name of the service that created this secret. */ public void setOwningService(String owningService) { @@ -922,10 +1086,10 @@ public void setOwningService(String owningService) { /** *- * Returns the name of the service that created this secret. + * The name of the service that created this secret. *
* - * @return Returns the name of the service that created this secret. + * @return The name of the service that created this secret. */ public String getOwningService() { @@ -934,11 +1098,11 @@ public String getOwningService() { /** *- * Returns the name of the service that created this secret. + * The name of the service that created this secret. *
* * @param owningService - * Returns the name of the service that created this secret. + * The name of the service that created this secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -949,11 +1113,11 @@ public DescribeSecretResult withOwningService(String owningService) { /** *- * The date you created the secret. + * The date the secret was created. *
* * @param createdDate - * The date you created the secret. + * The date the secret was created. */ public void setCreatedDate(java.util.Date createdDate) { @@ -962,10 +1126,10 @@ public void setCreatedDate(java.util.Date createdDate) { /** *- * The date you created the secret. + * The date the secret was created. *
* - * @return The date you created the secret. + * @return The date the secret was created. */ public java.util.Date getCreatedDate() { @@ -974,11 +1138,11 @@ public java.util.Date getCreatedDate() { /** *- * The date you created the secret. + * The date the secret was created. *
* * @param createdDate - * The date you created the secret. + * The date the secret was created. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -989,11 +1153,13 @@ public DescribeSecretResult withCreatedDate(java.util.Date createdDate) { /** *
- * Specifies the primary region for secret replication.
+ * The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
+ * ReplicationStatus
.
*
ReplicationStatus
.
*/
public void setPrimaryRegion(String primaryRegion) {
@@ -1002,10 +1168,12 @@ public void setPrimaryRegion(String primaryRegion) {
/**
*
- * Specifies the primary region for secret replication.
+ * The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
+ * ReplicationStatus
.
*
ReplicationStatus
.
*/
public String getPrimaryRegion() {
@@ -1014,11 +1182,13 @@ public String getPrimaryRegion() {
/**
*
- * Specifies the primary region for secret replication.
+ * The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
+ * ReplicationStatus
.
*
ReplicationStatus
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -1029,12 +1199,43 @@ public DescribeSecretResult withPrimaryRegion(String primaryRegion) {
/**
*
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.P
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
*
InProgress
, Failed
or
- * InSync
.P
+ * @return A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.P
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
*
InProgress
, Failed
or
- * InSync
.P
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.P
+ * A list of the replicas of this secret and their status:
*
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setReplicationStatus(java.util.Collection)} or {@link #withReplicationStatus(java.util.Collection)} if
@@ -1073,8 +1321,23 @@ public void setReplicationStatus(java.util.Collection
InProgress
, Failed
or
- * InSync
.P
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * Describes a list of replication status objects as InProgress
, Failed
or
- * InSync
.P
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
*
+ * InSync
, which indicates that the replica was created.
+ *
InProgress
, Failed
or
- * InSync
.P
+ * A list of the replicas of this secret and their status:
+ *
+ * Failed
, which indicates that the replica was not created.
+ *
+ * InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
+ *
+ * InSync
, which indicates that the replica was created.
+ *
- * Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master - * key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer - * Master Key. + * Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the KMS key is + * available, enabled, and not in an invalid state. For more information, see Key state: Effect on your KMS key. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/Filter.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/Filter.java index c37a13b34b23..4fd92bcbf7c8 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/Filter.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/Filter.java @@ -19,7 +19,9 @@ /** *- * Allows you to add filters when you use the search function in Secrets Manager. + * Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets + * Manager. *
* * @see AWS API @@ -30,13 +32,46 @@ public class Filter implements Serializable, Cloneable, StructuredPojo { /** *- * Filters your list of secrets by a specific key. + * The following are keys you can use: *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. + *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. + *
+ *- * Filters your list of secrets by a specific value. + * The keyword to filter for. *
*
* You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
@@ -46,11 +81,76 @@ public class Filter implements Serializable, Cloneable, StructuredPojo {
/**
*
- * Filters your list of secrets by a specific key. + * The following are keys you can use: + *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. + *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. + *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. + *
+ *- * Filters your list of secrets by a specific key. + * The following are keys you can use: + *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. + *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. + *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. + *
+ *- * Filters your list of secrets by a specific key. + * The following are keys you can use: *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. + *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. + *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. + *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. + *
+ *- * Filters your list of secrets by a specific key. + * The following are keys you can use: + *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. + *
+ *+ * description: Prefix match, not case-sensitive. + *
+ *+ * name: Prefix match, case-sensitive. + *
+ *+ * tag-key: Prefix match, case-sensitive. + *
+ *+ * tag-value: Prefix match, case-sensitive. + *
+ *+ * primary-region: Prefix match, case-sensitive. + *
+ *+ * all: Breaks the filter value string into words and then searches all attributes for matches. Not + * case-sensitive. + *
+ *- * Filters your list of secrets by a specific value. + * The keyword to filter for. *
*
* You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
*
* You can prefix your search value with an exclamation mark (
- * Filters your list of secrets by a specific value.
+ * The keyword to filter for.
*
* You can prefix your search value with an exclamation mark (!
) in order to perform negation
* filters.
@@ -123,14 +418,14 @@ public java.util.List!
) in order to perform negation filters.
*
* You can prefix your search value with an exclamation mark (
- * Filters your list of secrets by a specific value.
+ * The keyword to filter for.
*
* You can prefix your search value with an exclamation mark (!
) in order to perform negation
* filters.
@@ -147,7 +442,7 @@ public void setValues(java.util.Collection!
) in order to perform negation filters.
@@ -159,7 +454,7 @@ public void setValues(java.util.Collection
* You can prefix your search value with an exclamation mark (!
) in order to perform negation
* filters.
@@ -178,14 +473,14 @@ public Filter withValues(String... values) {
/**
*
- * Filters your list of secrets by a specific value. + * The keyword to filter for. *
*
* You can prefix your search value with an exclamation mark (!
) in order to perform negation filters.
*
* You can prefix your search value with an exclamation mark (!
) in order to perform negation
* filters.
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetRandomPasswordRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetRandomPasswordRequest.java
index a3822658de28..60795e706654 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetRandomPasswordRequest.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetRandomPasswordRequest.java
@@ -27,78 +27,67 @@ public class GetRandomPasswordRequest extends com.amazonaws.AmazonWebServiceRequ
/**
*
- * The desired length of the generated password. The default value if you do not include this parameter is 32 - * characters. + * The length of the password. If you don't include this parameter, the default length is 32 characters. *
*/ private Long passwordLength; /** *- * A string that includes characters that should not be included in the generated password. The default is that all - * characters from the included sets can be used. + * A string of the characters that you don't want in the password. *
*/ private String excludeCharacters; /** *- * Specifies that the generated password should not include digits. The default if you do not include this switch - * parameter is that digits can be included. + * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can + * contain numbers. *
*/ private Boolean excludeNumbers; /** *- * Specifies that the generated password should not include punctuation characters. The default if you do not - * include this switch parameter is that punctuation characters can be included. - *
- *
- * The following are the punctuation characters that can be included in the generated password if you don't
- * explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this
+ * switch, the password can contain punctuation.
*
- * Specifies that the generated password should not include uppercase letters. The default if you do not include - * this switch parameter is that uppercase letters can be included. + * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password + * can contain uppercase letters. *
*/ private Boolean excludeUppercase; /** *- * Specifies that the generated password should not include lowercase letters. The default if you do not include - * this switch parameter is that lowercase letters can be included. + * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password + * can contain lowercase letters. *
*/ private Boolean excludeLowercase; /** *- * Specifies that the generated password can include the space character. The default if you do not include this - * switch parameter is that the space character is not included. + * Specifies whether to include the space character. If you include this switch, the password can contain space + * characters. *
*/ private Boolean includeSpace; /** *
- * A boolean value that specifies whether the generated password must include at least one of every allowed
- * character type. The default value is True
and the operation requires at least one of every character
- * type.
+ * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
+ * don't include this switch, the password contains at least one of every character type.
*
- * The desired length of the generated password. The default value if you do not include this parameter is 32 - * characters. + * The length of the password. If you don't include this parameter, the default length is 32 characters. *
* * @param passwordLength - * The desired length of the generated password. The default value if you do not include this parameter is 32 - * characters. + * The length of the password. If you don't include this parameter, the default length is 32 characters. */ public void setPasswordLength(Long passwordLength) { @@ -107,12 +96,10 @@ public void setPasswordLength(Long passwordLength) { /** *- * The desired length of the generated password. The default value if you do not include this parameter is 32 - * characters. + * The length of the password. If you don't include this parameter, the default length is 32 characters. *
* - * @return The desired length of the generated password. The default value if you do not include this parameter is - * 32 characters. + * @return The length of the password. If you don't include this parameter, the default length is 32 characters. */ public Long getPasswordLength() { @@ -121,13 +108,11 @@ public Long getPasswordLength() { /** *- * The desired length of the generated password. The default value if you do not include this parameter is 32 - * characters. + * The length of the password. If you don't include this parameter, the default length is 32 characters. *
* * @param passwordLength - * The desired length of the generated password. The default value if you do not include this parameter is 32 - * characters. + * The length of the password. If you don't include this parameter, the default length is 32 characters. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -138,13 +123,11 @@ public GetRandomPasswordRequest withPasswordLength(Long passwordLength) { /** *- * A string that includes characters that should not be included in the generated password. The default is that all - * characters from the included sets can be used. + * A string of the characters that you don't want in the password. *
* * @param excludeCharacters - * A string that includes characters that should not be included in the generated password. The default is - * that all characters from the included sets can be used. + * A string of the characters that you don't want in the password. */ public void setExcludeCharacters(String excludeCharacters) { @@ -153,12 +136,10 @@ public void setExcludeCharacters(String excludeCharacters) { /** *- * A string that includes characters that should not be included in the generated password. The default is that all - * characters from the included sets can be used. + * A string of the characters that you don't want in the password. *
* - * @return A string that includes characters that should not be included in the generated password. The default is - * that all characters from the included sets can be used. + * @return A string of the characters that you don't want in the password. */ public String getExcludeCharacters() { @@ -167,13 +148,11 @@ public String getExcludeCharacters() { /** *- * A string that includes characters that should not be included in the generated password. The default is that all - * characters from the included sets can be used. + * A string of the characters that you don't want in the password. *
* * @param excludeCharacters - * A string that includes characters that should not be included in the generated password. The default is - * that all characters from the included sets can be used. + * A string of the characters that you don't want in the password. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -184,13 +163,13 @@ public GetRandomPasswordRequest withExcludeCharacters(String excludeCharacters) /** *- * Specifies that the generated password should not include digits. The default if you do not include this switch - * parameter is that digits can be included. + * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can + * contain numbers. *
* * @param excludeNumbers - * Specifies that the generated password should not include digits. The default if you do not include this - * switch parameter is that digits can be included. + * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can + * contain numbers. */ public void setExcludeNumbers(Boolean excludeNumbers) { @@ -199,12 +178,12 @@ public void setExcludeNumbers(Boolean excludeNumbers) { /** *- * Specifies that the generated password should not include digits. The default if you do not include this switch - * parameter is that digits can be included. + * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can + * contain numbers. *
* - * @return Specifies that the generated password should not include digits. The default if you do not include this - * switch parameter is that digits can be included. + * @return Specifies whether to exclude numbers from the password. If you don't include this switch, the password + * can contain numbers. */ public Boolean getExcludeNumbers() { @@ -213,13 +192,13 @@ public Boolean getExcludeNumbers() { /** *- * Specifies that the generated password should not include digits. The default if you do not include this switch - * parameter is that digits can be included. + * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can + * contain numbers. *
* * @param excludeNumbers - * Specifies that the generated password should not include digits. The default if you do not include this - * switch parameter is that digits can be included. + * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can + * contain numbers. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -230,12 +209,12 @@ public GetRandomPasswordRequest withExcludeNumbers(Boolean excludeNumbers) { /** *- * Specifies that the generated password should not include digits. The default if you do not include this switch - * parameter is that digits can be included. + * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can + * contain numbers. *
* - * @return Specifies that the generated password should not include digits. The default if you do not include this - * switch parameter is that digits can be included. + * @return Specifies whether to exclude numbers from the password. If you don't include this switch, the password + * can contain numbers. */ public Boolean isExcludeNumbers() { @@ -244,26 +223,15 @@ public Boolean isExcludeNumbers() { /** *- * Specifies that the generated password should not include punctuation characters. The default if you do not - * include this switch parameter is that punctuation characters can be included. - *
- *
- * The following are the punctuation characters that can be included in the generated password if you don't
- * explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this
+ * switch, the password can contain punctuation.
*
- * The following are the punctuation characters that can be included in the generated password if you
- * don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't
+ * include this switch, the password can contain punctuation.
*/
public void setExcludePunctuation(Boolean excludePunctuation) {
@@ -272,25 +240,14 @@ public void setExcludePunctuation(Boolean excludePunctuation) {
/**
*
- * Specifies that the generated password should not include punctuation characters. The default if you do not - * include this switch parameter is that punctuation characters can be included. - *
- *
- * The following are the punctuation characters that can be included in the generated password if you don't
- * explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this
+ * switch, the password can contain punctuation.
*
- * The following are the punctuation characters that can be included in the generated password if you
- * don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * @return Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't
+ * include this switch, the password can contain punctuation.
*/
public Boolean getExcludePunctuation() {
@@ -299,26 +256,15 @@ public Boolean getExcludePunctuation() {
/**
*
- * Specifies that the generated password should not include punctuation characters. The default if you do not - * include this switch parameter is that punctuation characters can be included. - *
- *
- * The following are the punctuation characters that can be included in the generated password if you don't
- * explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this
+ * switch, the password can contain punctuation.
*
- * The following are the punctuation characters that can be included in the generated password if you
- * don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't
+ * include this switch, the password can contain punctuation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -329,25 +275,14 @@ public GetRandomPasswordRequest withExcludePunctuation(Boolean excludePunctuatio
/**
*
- * Specifies that the generated password should not include punctuation characters. The default if you do not - * include this switch parameter is that punctuation characters can be included. - *
- *
- * The following are the punctuation characters that can be included in the generated password if you don't
- * explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't include this
+ * switch, the password can contain punctuation.
*
- * The following are the punctuation characters that can be included in the generated password if you
- * don't explicitly exclude them with ExcludeCharacters
or ExcludePunctuation
:
- *
- * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
+ * @return Specifies whether to exclude the following punctuation characters from the password:
+ * ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~
. If you don't
+ * include this switch, the password can contain punctuation.
*/
public Boolean isExcludePunctuation() {
@@ -356,13 +291,13 @@ public Boolean isExcludePunctuation() {
/**
*
- * Specifies that the generated password should not include uppercase letters. The default if you do not include - * this switch parameter is that uppercase letters can be included. + * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password + * can contain uppercase letters. *
* * @param excludeUppercase - * Specifies that the generated password should not include uppercase letters. The default if you do not - * include this switch parameter is that uppercase letters can be included. + * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the + * password can contain uppercase letters. */ public void setExcludeUppercase(Boolean excludeUppercase) { @@ -371,12 +306,12 @@ public void setExcludeUppercase(Boolean excludeUppercase) { /** *- * Specifies that the generated password should not include uppercase letters. The default if you do not include - * this switch parameter is that uppercase letters can be included. + * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password + * can contain uppercase letters. *
* - * @return Specifies that the generated password should not include uppercase letters. The default if you do not - * include this switch parameter is that uppercase letters can be included. + * @return Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the + * password can contain uppercase letters. */ public Boolean getExcludeUppercase() { @@ -385,13 +320,13 @@ public Boolean getExcludeUppercase() { /** *- * Specifies that the generated password should not include uppercase letters. The default if you do not include - * this switch parameter is that uppercase letters can be included. + * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password + * can contain uppercase letters. *
* * @param excludeUppercase - * Specifies that the generated password should not include uppercase letters. The default if you do not - * include this switch parameter is that uppercase letters can be included. + * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the + * password can contain uppercase letters. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -402,12 +337,12 @@ public GetRandomPasswordRequest withExcludeUppercase(Boolean excludeUppercase) { /** *- * Specifies that the generated password should not include uppercase letters. The default if you do not include - * this switch parameter is that uppercase letters can be included. + * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password + * can contain uppercase letters. *
* - * @return Specifies that the generated password should not include uppercase letters. The default if you do not - * include this switch parameter is that uppercase letters can be included. + * @return Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the + * password can contain uppercase letters. */ public Boolean isExcludeUppercase() { @@ -416,13 +351,13 @@ public Boolean isExcludeUppercase() { /** *- * Specifies that the generated password should not include lowercase letters. The default if you do not include - * this switch parameter is that lowercase letters can be included. + * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password + * can contain lowercase letters. *
* * @param excludeLowercase - * Specifies that the generated password should not include lowercase letters. The default if you do not - * include this switch parameter is that lowercase letters can be included. + * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the + * password can contain lowercase letters. */ public void setExcludeLowercase(Boolean excludeLowercase) { @@ -431,12 +366,12 @@ public void setExcludeLowercase(Boolean excludeLowercase) { /** *- * Specifies that the generated password should not include lowercase letters. The default if you do not include - * this switch parameter is that lowercase letters can be included. + * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password + * can contain lowercase letters. *
* - * @return Specifies that the generated password should not include lowercase letters. The default if you do not - * include this switch parameter is that lowercase letters can be included. + * @return Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the + * password can contain lowercase letters. */ public Boolean getExcludeLowercase() { @@ -445,13 +380,13 @@ public Boolean getExcludeLowercase() { /** *- * Specifies that the generated password should not include lowercase letters. The default if you do not include - * this switch parameter is that lowercase letters can be included. + * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password + * can contain lowercase letters. *
* * @param excludeLowercase - * Specifies that the generated password should not include lowercase letters. The default if you do not - * include this switch parameter is that lowercase letters can be included. + * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the + * password can contain lowercase letters. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -462,12 +397,12 @@ public GetRandomPasswordRequest withExcludeLowercase(Boolean excludeLowercase) { /** *- * Specifies that the generated password should not include lowercase letters. The default if you do not include - * this switch parameter is that lowercase letters can be included. + * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password + * can contain lowercase letters. *
* - * @return Specifies that the generated password should not include lowercase letters. The default if you do not - * include this switch parameter is that lowercase letters can be included. + * @return Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the + * password can contain lowercase letters. */ public Boolean isExcludeLowercase() { @@ -476,13 +411,13 @@ public Boolean isExcludeLowercase() { /** *- * Specifies that the generated password can include the space character. The default if you do not include this - * switch parameter is that the space character is not included. + * Specifies whether to include the space character. If you include this switch, the password can contain space + * characters. *
* * @param includeSpace - * Specifies that the generated password can include the space character. The default if you do not include - * this switch parameter is that the space character is not included. + * Specifies whether to include the space character. If you include this switch, the password can contain + * space characters. */ public void setIncludeSpace(Boolean includeSpace) { @@ -491,12 +426,12 @@ public void setIncludeSpace(Boolean includeSpace) { /** *- * Specifies that the generated password can include the space character. The default if you do not include this - * switch parameter is that the space character is not included. + * Specifies whether to include the space character. If you include this switch, the password can contain space + * characters. *
* - * @return Specifies that the generated password can include the space character. The default if you do not include - * this switch parameter is that the space character is not included. + * @return Specifies whether to include the space character. If you include this switch, the password can contain + * space characters. */ public Boolean getIncludeSpace() { @@ -505,13 +440,13 @@ public Boolean getIncludeSpace() { /** *- * Specifies that the generated password can include the space character. The default if you do not include this - * switch parameter is that the space character is not included. + * Specifies whether to include the space character. If you include this switch, the password can contain space + * characters. *
* * @param includeSpace - * Specifies that the generated password can include the space character. The default if you do not include - * this switch parameter is that the space character is not included. + * Specifies whether to include the space character. If you include this switch, the password can contain + * space characters. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -522,12 +457,12 @@ public GetRandomPasswordRequest withIncludeSpace(Boolean includeSpace) { /** *- * Specifies that the generated password can include the space character. The default if you do not include this - * switch parameter is that the space character is not included. + * Specifies whether to include the space character. If you include this switch, the password can contain space + * characters. *
* - * @return Specifies that the generated password can include the space character. The default if you do not include - * this switch parameter is that the space character is not included. + * @return Specifies whether to include the space character. If you include this switch, the password can contain + * space characters. */ public Boolean isIncludeSpace() { @@ -536,15 +471,13 @@ public Boolean isIncludeSpace() { /** *
- * A boolean value that specifies whether the generated password must include at least one of every allowed
- * character type. The default value is True
and the operation requires at least one of every character
- * type.
+ * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
+ * don't include this switch, the password contains at least one of every character type.
*
True
and the operation requires at least one of every
- * character type.
+ * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If
+ * you don't include this switch, the password contains at least one of every character type.
*/
public void setRequireEachIncludedType(Boolean requireEachIncludedType) {
@@ -553,14 +486,12 @@ public void setRequireEachIncludedType(Boolean requireEachIncludedType) {
/**
*
- * A boolean value that specifies whether the generated password must include at least one of every allowed
- * character type. The default value is True
and the operation requires at least one of every character
- * type.
+ * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
+ * don't include this switch, the password contains at least one of every character type.
*
True
and the operation requires at least one of every
- * character type.
+ * @return Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If
+ * you don't include this switch, the password contains at least one of every character type.
*/
public Boolean getRequireEachIncludedType() {
@@ -569,15 +500,13 @@ public Boolean getRequireEachIncludedType() {
/**
*
- * A boolean value that specifies whether the generated password must include at least one of every allowed
- * character type. The default value is True
and the operation requires at least one of every character
- * type.
+ * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
+ * don't include this switch, the password contains at least one of every character type.
*
True
and the operation requires at least one of every
- * character type.
+ * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If
+ * you don't include this switch, the password contains at least one of every character type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -588,14 +517,12 @@ public GetRandomPasswordRequest withRequireEachIncludedType(Boolean requireEachI
/**
*
- * A boolean value that specifies whether the generated password must include at least one of every allowed
- * character type. The default value is True
and the operation requires at least one of every character
- * type.
+ * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you
+ * don't include this switch, the password contains at least one of every character type.
*
True
and the operation requires at least one of every
- * character type.
+ * @return Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If
+ * you don't include this switch, the password contains at least one of every character type.
*/
public Boolean isRequireEachIncludedType() {
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetRandomPasswordResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetRandomPasswordResult.java
index 1a1058b2380a..7aa97732cfce 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetRandomPasswordResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetRandomPasswordResult.java
@@ -25,18 +25,18 @@ public class GetRandomPasswordResult extends com.amazonaws.AmazonWebServiceResul
/**
* - * A string with the generated password. + * A string with the password. *
*/ private String randomPassword; /** *- * A string with the generated password. + * A string with the password. *
* * @param randomPassword - * A string with the generated password. + * A string with the password. */ public void setRandomPassword(String randomPassword) { @@ -45,10 +45,10 @@ public void setRandomPassword(String randomPassword) { /** *- * A string with the generated password. + * A string with the password. *
* - * @return A string with the generated password. + * @return A string with the password. */ public String getRandomPassword() { @@ -57,11 +57,11 @@ public String getRandomPassword() { /** *- * A string with the generated password. + * A string with the password. *
* * @param randomPassword - * A string with the generated password. + * A string with the password. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetResourcePolicyRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetResourcePolicyRequest.java index f84d9504561c..33f0e846f82b 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetResourcePolicyRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetResourcePolicyRequest.java @@ -27,8 +27,7 @@ public class GetResourcePolicyRequest extends com.amazonaws.AmazonWebServiceRequ /** *- * Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve the attached resource-based policy for. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -38,16 +37,14 @@ public class GetResourcePolicyRequest extends com.amazonaws.AmazonWebServiceRequ /** *
- * Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve the attached resource-based policy for. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve the attached resource-based policy for. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -58,15 +55,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve the attached resource-based policy for. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or name of the secret to retrieve the attached resource-based policy for. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -77,16 +72,14 @@ public String getSecretId() { /** *
- * Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve the attached resource-based policy for. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve the attached resource-based policy for. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetResourcePolicyResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetResourcePolicyResult.java index 67024aac499a..27ef7afa6a68 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetResourcePolicyResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetResourcePolicyResult.java @@ -31,18 +31,16 @@ public class GetResourcePolicyResult extends com.amazonaws.AmazonWebServiceResul private String aRN; /** *
- * The friendly name of the secret that the resource-based policy was retrieved for. + * The name of the secret that the resource-based policy was retrieved for. *
*/ private String name; /** *- * A JSON-formatted string that describes the permissions that are associated with the attached secret. These - * permissions are combined with any permissions that are associated with the user or role that attempts to access - * this secret. The combined permissions specify who can access the secret and what actions they can perform. For - * more information, see Authentication and Access - * Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide. + * A JSON-formatted string that contains the permissions policy attached to the secret. For more information about + * permissions policies, see Authentication and access + * control for Secrets Manager. *
*/ private String resourcePolicy; @@ -89,11 +87,11 @@ public GetResourcePolicyResult withARN(String aRN) { /** *- * The friendly name of the secret that the resource-based policy was retrieved for. + * The name of the secret that the resource-based policy was retrieved for. *
* * @param name - * The friendly name of the secret that the resource-based policy was retrieved for. + * The name of the secret that the resource-based policy was retrieved for. */ public void setName(String name) { @@ -102,10 +100,10 @@ public void setName(String name) { /** *- * The friendly name of the secret that the resource-based policy was retrieved for. + * The name of the secret that the resource-based policy was retrieved for. *
* - * @return The friendly name of the secret that the resource-based policy was retrieved for. + * @return The name of the secret that the resource-based policy was retrieved for. */ public String getName() { @@ -114,11 +112,11 @@ public String getName() { /** *- * The friendly name of the secret that the resource-based policy was retrieved for. + * The name of the secret that the resource-based policy was retrieved for. *
* * @param name - * The friendly name of the secret that the resource-based policy was retrieved for. + * The name of the secret that the resource-based policy was retrieved for. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -129,22 +127,17 @@ public GetResourcePolicyResult withName(String name) { /** *- * A JSON-formatted string that describes the permissions that are associated with the attached secret. These - * permissions are combined with any permissions that are associated with the user or role that attempts to access - * this secret. The combined permissions specify who can access the secret and what actions they can perform. For - * more information, see Authentication and Access - * Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide. + * A JSON-formatted string that contains the permissions policy attached to the secret. For more information about + * permissions policies, see Authentication and access + * control for Secrets Manager. *
* * @param resourcePolicy - * A JSON-formatted string that describes the permissions that are associated with the attached secret. These - * permissions are combined with any permissions that are associated with the user or role that attempts to - * access this secret. The combined permissions specify who can access the secret and what actions they can - * perform. For more information, see Authentication and - * Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager - * User Guide. + * A JSON-formatted string that contains the permissions policy attached to the secret. For more information + * about permissions policies, see Authentication and + * access control for Secrets Manager. */ public void setResourcePolicy(String resourcePolicy) { @@ -153,21 +146,16 @@ public void setResourcePolicy(String resourcePolicy) { /** *- * A JSON-formatted string that describes the permissions that are associated with the attached secret. These - * permissions are combined with any permissions that are associated with the user or role that attempts to access - * this secret. The combined permissions specify who can access the secret and what actions they can perform. For - * more information, see Authentication and Access - * Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide. + * A JSON-formatted string that contains the permissions policy attached to the secret. For more information about + * permissions policies, see Authentication and access + * control for Secrets Manager. *
* - * @return A JSON-formatted string that describes the permissions that are associated with the attached secret. - * These permissions are combined with any permissions that are associated with the user or role that - * attempts to access this secret. The combined permissions specify who can access the secret and what - * actions they can perform. For more information, see Authentication and - * Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager - * User Guide. + * @return A JSON-formatted string that contains the permissions policy attached to the secret. For more information + * about permissions policies, see Authentication + * and access control for Secrets Manager. */ public String getResourcePolicy() { @@ -176,22 +164,17 @@ public String getResourcePolicy() { /** *- * A JSON-formatted string that describes the permissions that are associated with the attached secret. These - * permissions are combined with any permissions that are associated with the user or role that attempts to access - * this secret. The combined permissions specify who can access the secret and what actions they can perform. For - * more information, see Authentication and Access - * Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide. + * A JSON-formatted string that contains the permissions policy attached to the secret. For more information about + * permissions policies, see Authentication and access + * control for Secrets Manager. *
* * @param resourcePolicy - * A JSON-formatted string that describes the permissions that are associated with the attached secret. These - * permissions are combined with any permissions that are associated with the user or role that attempts to - * access this secret. The combined permissions specify who can access the secret and what actions they can - * perform. For more information, see Authentication and - * Access Control for Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager - * User Guide. + * A JSON-formatted string that contains the permissions policy attached to the secret. For more information + * about permissions policies, see Authentication and + * access control for Secrets Manager. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetSecretValueRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetSecretValueRequest.java index 6e9926ff0238..bc2bc376a183 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetSecretValueRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetSecretValueRequest.java @@ -27,8 +27,7 @@ public class GetSecretValueRequest extends com.amazonaws.AmazonWebServiceRequest /** *- * Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource - * Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -37,10 +36,10 @@ public class GetSecretValueRequest extends com.amazonaws.AmazonWebServiceRequest private String secretId; /** *
- * Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this
- * parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't
- * specify either a VersionStage
or VersionId
then the default is to perform the operation
- * on the version with the VersionStage
value of AWSCURRENT
.
+ * The unique identifier of the version of the secret to retrieve. If you include both this parameter and
+ * VersionStage
, the two parameters must refer to the same secret version. If you don't specify either
+ * a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
+ * version.
*
* This value is typically a UUID-type value @@ -50,29 +49,27 @@ public class GetSecretValueRequest extends com.amazonaws.AmazonWebServiceRequest private String versionId; /** *
- * Specifies the secret version that you want to retrieve by the staging label attached to the version. + * The staging label of the version of the secret to retrieve. *
*
- * Staging labels are used to keep track of different versions during the rotation process. If you specify both this
- * parameter and VersionId
, the two parameters must refer to the same secret version . If you don't
- * specify either a VersionStage
or VersionId
, then the default is to perform the
- * operation on the version with the VersionStage
value of AWSCURRENT
.
+ * Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you
+ * include both this parameter and VersionId
, the two parameters must refer to the same secret version.
+ * If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the
+ * AWSCURRENT
version.
*
- * Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource - * Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -83,15 +80,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource - * Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or name of the secret to retrieve. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -102,16 +97,14 @@ public String getSecretId() { /** *
- * Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource - * Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to retrieve. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -124,10 +117,10 @@ public GetSecretValueRequest withSecretId(String secretId) { /** *
- * Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this
- * parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't
- * specify either a VersionStage
or VersionId
then the default is to perform the operation
- * on the version with the VersionStage
value of AWSCURRENT
.
+ * The unique identifier of the version of the secret to retrieve. If you include both this parameter and
+ * VersionStage
, the two parameters must refer to the same secret version. If you don't specify either
+ * a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
+ * version.
*
* This value is typically a UUID-type value @@ -135,11 +128,10 @@ public GetSecretValueRequest withSecretId(String secretId) { *
* * @param versionId - * Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify - * both this parameter andVersionStage
, the two parameters must refer to the same secret
- * version. If you don't specify either a VersionStage
or VersionId
then the
- * default is to perform the operation on the version with the VersionStage
value of
- * AWSCURRENT
.
+ * The unique identifier of the version of the secret to retrieve. If you include both this parameter and
+ * VersionStage
, the two parameters must refer to the same secret version. If you don't specify
+ * either a VersionStage
or VersionId
, then Secrets Manager returns the
+ * AWSCURRENT
version.
* * This value is typically a UUID-type * value with 32 hexadecimal digits. @@ -151,21 +143,20 @@ public void setVersionId(String versionId) { /** *
- * Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this
- * parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't
- * specify either a VersionStage
or VersionId
then the default is to perform the operation
- * on the version with the VersionStage
value of AWSCURRENT
.
+ * The unique identifier of the version of the secret to retrieve. If you include both this parameter and
+ * VersionStage
, the two parameters must refer to the same secret version. If you don't specify either
+ * a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
+ * version.
*
* This value is typically a UUID-type value * with 32 hexadecimal digits. *
* - * @return Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify - * both this parameter andVersionStage
, the two parameters must refer to the same secret
- * version. If you don't specify either a VersionStage
or VersionId
then the
- * default is to perform the operation on the version with the VersionStage
value of
- * AWSCURRENT
.
+ * @return The unique identifier of the version of the secret to retrieve. If you include both this parameter and
+ * VersionStage
, the two parameters must refer to the same secret version. If you don't specify
+ * either a VersionStage
or VersionId
, then Secrets Manager returns the
+ * AWSCURRENT
version.
* * This value is typically a UUID-type value with 32 hexadecimal @@ -178,10 +169,10 @@ public String getVersionId() { /** *
- * Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this
- * parameter and VersionStage
, the two parameters must refer to the same secret version. If you don't
- * specify either a VersionStage
or VersionId
then the default is to perform the operation
- * on the version with the VersionStage
value of AWSCURRENT
.
+ * The unique identifier of the version of the secret to retrieve. If you include both this parameter and
+ * VersionStage
, the two parameters must refer to the same secret version. If you don't specify either
+ * a VersionStage
or VersionId
, then Secrets Manager returns the AWSCURRENT
+ * version.
*
* This value is typically a UUID-type value @@ -189,11 +180,10 @@ public String getVersionId() { *
* * @param versionId - * Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify - * both this parameter andVersionStage
, the two parameters must refer to the same secret
- * version. If you don't specify either a VersionStage
or VersionId
then the
- * default is to perform the operation on the version with the VersionStage
value of
- * AWSCURRENT
.
+ * The unique identifier of the version of the secret to retrieve. If you include both this parameter and
+ * VersionStage
, the two parameters must refer to the same secret version. If you don't specify
+ * either a VersionStage
or VersionId
, then Secrets Manager returns the
+ * AWSCURRENT
version.
* * This value is typically a UUID-type * value with 32 hexadecimal digits. @@ -207,22 +197,22 @@ public GetSecretValueRequest withVersionId(String versionId) { /** *
- * Specifies the secret version that you want to retrieve by the staging label attached to the version. + * The staging label of the version of the secret to retrieve. *
*
- * Staging labels are used to keep track of different versions during the rotation process. If you specify both this
- * parameter and VersionId
, the two parameters must refer to the same secret version . If you don't
- * specify either a VersionStage
or VersionId
, then the default is to perform the
- * operation on the version with the VersionStage
value of AWSCURRENT
.
+ * Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you
+ * include both this parameter and VersionId
, the two parameters must refer to the same secret version.
+ * If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the
+ * AWSCURRENT
version.
*
- * Staging labels are used to keep track of different versions during the rotation process. If you specify
- * both this parameter and VersionId
, the two parameters must refer to the same secret version .
- * If you don't specify either a VersionStage
or VersionId
, then the default is to
- * perform the operation on the version with the VersionStage
value of AWSCURRENT
.
+ * Secrets Manager uses staging labels to keep track of different versions during the rotation process. If
+ * you include both this parameter and VersionId
, the two parameters must refer to the same
+ * secret version. If you don't specify either a VersionStage
or VersionId
, Secrets
+ * Manager returns the AWSCURRENT
version.
*/
public void setVersionStage(String versionStage) {
@@ -231,22 +221,21 @@ public void setVersionStage(String versionStage) {
/**
*
- * Specifies the secret version that you want to retrieve by the staging label attached to the version. + * The staging label of the version of the secret to retrieve. *
*
- * Staging labels are used to keep track of different versions during the rotation process. If you specify both this
- * parameter and VersionId
, the two parameters must refer to the same secret version . If you don't
- * specify either a VersionStage
or VersionId
, then the default is to perform the
- * operation on the version with the VersionStage
value of AWSCURRENT
.
+ * Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you
+ * include both this parameter and VersionId
, the two parameters must refer to the same secret version.
+ * If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the
+ * AWSCURRENT
version.
*
- * Staging labels are used to keep track of different versions during the rotation process. If you specify
- * both this parameter and VersionId
, the two parameters must refer to the same secret version
- * . If you don't specify either a VersionStage
or VersionId
, then the default is
- * to perform the operation on the version with the VersionStage
value of
- * AWSCURRENT
.
+ * Secrets Manager uses staging labels to keep track of different versions during the rotation process. If
+ * you include both this parameter and VersionId
, the two parameters must refer to the same
+ * secret version. If you don't specify either a VersionStage
or VersionId
,
+ * Secrets Manager returns the AWSCURRENT
version.
*/
public String getVersionStage() {
@@ -255,22 +244,22 @@ public String getVersionStage() {
/**
*
- * Specifies the secret version that you want to retrieve by the staging label attached to the version. + * The staging label of the version of the secret to retrieve. *
*
- * Staging labels are used to keep track of different versions during the rotation process. If you specify both this
- * parameter and VersionId
, the two parameters must refer to the same secret version . If you don't
- * specify either a VersionStage
or VersionId
, then the default is to perform the
- * operation on the version with the VersionStage
value of AWSCURRENT
.
+ * Secrets Manager uses staging labels to keep track of different versions during the rotation process. If you
+ * include both this parameter and VersionId
, the two parameters must refer to the same secret version.
+ * If you don't specify either a VersionStage
or VersionId
, Secrets Manager returns the
+ * AWSCURRENT
version.
*
- * Staging labels are used to keep track of different versions during the rotation process. If you specify
- * both this parameter and VersionId
, the two parameters must refer to the same secret version .
- * If you don't specify either a VersionStage
or VersionId
, then the default is to
- * perform the operation on the version with the VersionStage
value of AWSCURRENT
.
+ * Secrets Manager uses staging labels to keep track of different versions during the rotation process. If
+ * you include both this parameter and VersionId
, the two parameters must refer to the same
+ * secret version. If you don't specify either a VersionStage
or VersionId
, Secrets
+ * Manager returns the AWSCURRENT
version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetSecretValueResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetSecretValueResult.java
index 25da23fd395d..78c4b4471898 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetSecretValueResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/GetSecretValueResult.java
@@ -43,32 +43,24 @@ public class GetSecretValueResult extends com.amazonaws.AmazonWebServiceResult
- * This parameter is not used if the secret is created by the Secrets Manager console. - *
- *
- * If you store custom information in this field of the secret, then you must code your Lambda rotation function to
- * parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
+ * If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as
+ * a string, then this field is omitted. The secret value appears in SecretString
instead.
*
- * The decrypted part of the protected secret information that was originally provided as a string. - *
- *
- * If you create this secret by using the Secrets Manager console then only the SecretString
parameter
- * contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda
- * rotation function knows how to parse.
+ * The decrypted secret value, if the secret value was originally provided as a string or through the Secrets
+ * Manager console.
*
- * If you store custom information in the secret by using the CreateSecret, UpdateSecret, or - * PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret - * type in the console, then you must code your Lambda rotation function to parse and interpret those values. + * If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure + * of key/value pairs. *
*/ private String secretString; @@ -80,7 +72,9 @@ public class GetSecretValueResult extends com.amazonaws.AmazonWebServiceResult
- * The date and time that this version of the secret was created.
+ * The date and time that this version of the secret was created. If you don't specify which version in
+ * VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
+ * version.
*
- * The decrypted part of the protected secret information that was originally provided as binary data in the form of - * a byte array. The response parameter represents the binary data as a base64-encoded string. *
*- * This parameter is not used if the secret is created by the Secrets Manager console. - *
- *
- * If you store custom information in this field of the secret, then you must code your Lambda rotation function to
- * parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
+ * If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as
+ * a string, then this field is omitted. The secret value appears in SecretString
instead.
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. @@ -230,16 +221,13 @@ public GetSecretValueResult withVersionId(String versionId) { *
* * @param secretBinary - * The decrypted part of the protected secret information that was originally provided as binary data in the - * form of a byte array. The response parameter represents the binary data as a base64-encoded string. *- * This parameter is not used if the secret is created by the Secrets Manager console. - *
- *
- * If you store custom information in this field of the secret, then you must code your Lambda rotation
- * function to parse and interpret whatever you store in the SecretString
or
- * SecretBinary
fields.
+ * If the secret was created by using the Secrets Manager console, or if the secret value was originally
+ * provided as a string, then this field is omitted. The secret value appears in SecretString
+ * instead.
*/
public void setSecretBinary(java.nio.ByteBuffer secretBinary) {
@@ -248,16 +236,13 @@ public void setSecretBinary(java.nio.ByteBuffer secretBinary) {
/**
*
- * The decrypted part of the protected secret information that was originally provided as binary data in the form of - * a byte array. The response parameter represents the binary data as a base64-encoded string. *
*- * This parameter is not used if the secret is created by the Secrets Manager console. - *
- *
- * If you store custom information in this field of the secret, then you must code your Lambda rotation function to
- * parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
+ * If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as
+ * a string, then this field is omitted. The secret value appears in SecretString
instead.
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend @@ -267,16 +252,13 @@ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { * {@code position}. *
* - * @return The decrypted part of the protected secret information that was originally provided as binary data in the - * form of a byte array. The response parameter represents the binary data as a base64-encoded string. *- * This parameter is not used if the secret is created by the Secrets Manager console. - *
- *
- * If you store custom information in this field of the secret, then you must code your Lambda rotation
- * function to parse and interpret whatever you store in the SecretString
or
- * SecretBinary
fields.
+ * If the secret was created by using the Secrets Manager console, or if the secret value was originally
+ * provided as a string, then this field is omitted. The secret value appears in SecretString
+ * instead.
*/
public java.nio.ByteBuffer getSecretBinary() {
@@ -285,16 +267,13 @@ public java.nio.ByteBuffer getSecretBinary() {
/**
*
- * The decrypted part of the protected secret information that was originally provided as binary data in the form of - * a byte array. The response parameter represents the binary data as a base64-encoded string. *
*- * This parameter is not used if the secret is created by the Secrets Manager console. - *
- *
- * If you store custom information in this field of the secret, then you must code your Lambda rotation function to
- * parse and interpret whatever you store in the SecretString
or SecretBinary
fields.
+ * If the secret was created by using the Secrets Manager console, or if the secret value was originally provided as
+ * a string, then this field is omitted. The secret value appears in SecretString
instead.
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. @@ -308,16 +287,13 @@ public java.nio.ByteBuffer getSecretBinary() { *
* * @param secretBinary - * The decrypted part of the protected secret information that was originally provided as binary data in the - * form of a byte array. The response parameter represents the binary data as a base64-encoded string. *- * This parameter is not used if the secret is created by the Secrets Manager console. - *
- *
- * If you store custom information in this field of the secret, then you must code your Lambda rotation
- * function to parse and interpret whatever you store in the SecretString
or
- * SecretBinary
fields.
+ * If the secret was created by using the Secrets Manager console, or if the secret value was originally
+ * provided as a string, then this field is omitted. The secret value appears in SecretString
+ * instead.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -328,31 +304,20 @@ public GetSecretValueResult withSecretBinary(java.nio.ByteBuffer secretBinary) {
/**
*
- * The decrypted part of the protected secret information that was originally provided as a string. - *
- *
- * If you create this secret by using the Secrets Manager console then only the SecretString
parameter
- * contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda
- * rotation function knows how to parse.
+ * The decrypted secret value, if the secret value was originally provided as a string or through the Secrets
+ * Manager console.
*
- * If you store custom information in the secret by using the CreateSecret, UpdateSecret, or - * PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret - * type in the console, then you must code your Lambda rotation function to parse and interpret those values. + * If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure + * of key/value pairs. *
* * @param secretString - * The decrypted part of the protected secret information that was originally provided as a string. - *
- * If you create this secret by using the Secrets Manager console then only the SecretString
- * parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs
- * that the Lambda rotation function knows how to parse.
- *
- * If you store custom information in the secret by using the CreateSecret, UpdateSecret, or - * PutSecretValue API operations instead of the Secrets Manager console, or by using the Other - * secret type in the console, then you must code your Lambda rotation function to parse and interpret - * those values. + * If this secret was created by using the console, then Secrets Manager stores the information as a JSON + * structure of key/value pairs. */ public void setSecretString(String secretString) { @@ -361,30 +326,19 @@ public void setSecretString(String secretString) { /** *
- * The decrypted part of the protected secret information that was originally provided as a string. + * The decrypted secret value, if the secret value was originally provided as a string or through the Secrets + * Manager console. *
*
- * If you create this secret by using the Secrets Manager console then only the SecretString
parameter
- * contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda
- * rotation function knows how to parse.
- *
- * If you store custom information in the secret by using the CreateSecret, UpdateSecret, or - * PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret - * type in the console, then you must code your Lambda rotation function to parse and interpret those values. + * If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure + * of key/value pairs. *
* - * @return The decrypted part of the protected secret information that was originally provided as a string. - *
- * If you create this secret by using the Secrets Manager console then only the SecretString
- * parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs
- * that the Lambda rotation function knows how to parse.
- *
- * If you store custom information in the secret by using the CreateSecret, UpdateSecret, or - * PutSecretValue API operations instead of the Secrets Manager console, or by using the Other - * secret type in the console, then you must code your Lambda rotation function to parse and interpret - * those values. + * If this secret was created by using the console, then Secrets Manager stores the information as a JSON + * structure of key/value pairs. */ public String getSecretString() { @@ -393,31 +347,20 @@ public String getSecretString() { /** *
- * The decrypted part of the protected secret information that was originally provided as a string. + * The decrypted secret value, if the secret value was originally provided as a string or through the Secrets + * Manager console. *
*
- * If you create this secret by using the Secrets Manager console then only the SecretString
parameter
- * contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda
- * rotation function knows how to parse.
- *
- * If you store custom information in the secret by using the CreateSecret, UpdateSecret, or - * PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret - * type in the console, then you must code your Lambda rotation function to parse and interpret those values. + * If this secret was created by using the console, then Secrets Manager stores the information as a JSON structure + * of key/value pairs. *
* * @param secretString - * The decrypted part of the protected secret information that was originally provided as a string. - *
- * If you create this secret by using the Secrets Manager console then only the SecretString
- * parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs
- * that the Lambda rotation function knows how to parse.
- *
- * If you store custom information in the secret by using the CreateSecret, UpdateSecret, or
- * PutSecretValue API operations instead of the Secrets Manager console, or by using the Other
- * secret type in the console, then you must code your Lambda rotation function to parse and interpret
- * those values.
+ * If this secret was created by using the console, then Secrets Manager stores the information as a JSON
+ * structure of key/value pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -498,11 +441,15 @@ public GetSecretValueResult withVersionStages(java.util.Collection
- * The date and time that this version of the secret was created.
+ * The date and time that this version of the secret was created. If you don't specify which version in
+ *
- * The date and time that this version of the secret was created.
+ * The date and time that this version of the secret was created. If you don't specify which version in
+ *
- * The date and time that this version of the secret was created.
+ * The date and time that this version of the secret was created. If you don't specify which version in
+ *
- * You provided an invalid
- * You provided an invalid value for a parameter.
+ * The parameter name is invalid value.
*
- * You provided a parameter value that is not valid for the current state of the resource.
+ * A parameter value is not valid for the current state of the resource.
*
* Possible causes:
@@ -24,7 +24,7 @@
*
- * You tried to perform the operation on a secret that's currently marked deleted.
+ * The secret is scheduled for deletion.
*
- * The request failed because it would exceed one of the Secrets Manager internal limits.
+ * The request failed because it would exceed one of the Secrets Manager quotas.
*
- * The identifier for the secret containing the versions you want to list. You can specify either the Amazon
- * Resource Name (ARN) or the friendly name of the secret.
+ * The ARN or name of the secret whose versions you want to list.
*
* For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
@@ -37,44 +36,39 @@ public class ListSecretVersionIdsRequest extends com.amazonaws.AmazonWebServiceR
private String secretId;
/**
*
- * (Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
- * it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
- * specify, the
+ * If there are more results available, in the response, Secrets Manager includes
- * (Optional) Use this parameter in a request if you receive a
- * (Optional) Specifies that you want the results to include versions that do not have any staging labels attached
- * to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
+ * 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.
*
- * The identifier for the secret containing the versions you want to list. You can specify either the Amazon
- * Resource Name (ARN) or the friendly name of the secret.
+ * The ARN or name of the secret whose versions you want to list.
*
* For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
* VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
+ * version.
* VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
+ * version.
*/
public void setCreatedDate(java.util.Date createdDate) {
@@ -511,10 +458,14 @@ public void setCreatedDate(java.util.Date createdDate) {
/**
* VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
+ * version.
* VersionId
or VersionStage
, then Secrets Manager uses the
+ * AWSCURRENT
version.
*/
public java.util.Date getCreatedDate() {
@@ -523,11 +474,15 @@ public java.util.Date getCreatedDate() {
/**
* VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
+ * version.
* VersionId
or VersionStage
, then Secrets Manager uses the AWSCURRENT
+ * version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/InvalidNextTokenException.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/InvalidNextTokenException.java
index 48f4a7624ea1..e2cdde5dc110 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/InvalidNextTokenException.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/InvalidNextTokenException.java
@@ -16,7 +16,7 @@
/**
* NextToken
value.
+ * The NextToken
value is invalid.
*
*
NextToken
response element is present and has a value (isn't null). Include that value
- * as the NextToken
request parameter in the next call to the operation to get the next part of the
- * results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
- * available. You should check NextToken
after every operation to ensure that you receive all of the
- * results.
+ * The number of results to include in the response.
+ * NextToken
. To get the
+ * next results, call ListSecretVersionIds
again with the value from NextToken
.
* NextToken
response in a previous request
- * indicating there's more output available. In a subsequent call, set it to the value of the previous call
- * NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results. To get
+ * the next results, call ListSecretVersionIds
again with this value.
*
* For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -85,15 +79,13 @@ public void setSecretId(String secretId) { /** *
- * The identifier for the secret containing the versions you want to list. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret whose versions you want to list. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return The identifier for the secret containing the versions you want to list. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or name of the secret whose versions you want to list. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -104,16 +96,14 @@ public String getSecretId() { /** *
- * The identifier for the secret containing the versions you want to list. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret whose versions you want to list. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * The identifier for the secret containing the versions you want to list. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret whose versions you want to list. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -126,23 +116,19 @@ public ListSecretVersionIdsRequest withSecretId(String secretId) { /** *
- * (Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
- * it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
- * specify, the NextToken
response element is present and has a value (isn't null). Include that value
- * as the NextToken
request parameter in the next call to the operation to get the next part of the
- * results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
- * available. You should check NextToken
after every operation to ensure that you receive all of the
- * results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To get the
+ * next results, call ListSecretVersionIds
again with the value from NextToken
.
*
NextToken
response element is present and has a value (isn't null).
- * Include that value as the NextToken
request parameter in the next call to the operation to
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
- * even when there are more results available. You should check NextToken
after every operation
- * to ensure that you receive all of the results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To
+ * get the next results, call ListSecretVersionIds
again with the value from
+ * NextToken
.
*/
public void setMaxResults(Integer maxResults) {
@@ -151,22 +137,18 @@ public void setMaxResults(Integer maxResults) {
/**
*
- * (Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
- * it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
- * specify, the NextToken
response element is present and has a value (isn't null). Include that value
- * as the NextToken
request parameter in the next call to the operation to get the next part of the
- * results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
- * available. You should check NextToken
after every operation to ensure that you receive all of the
- * results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To get the
+ * next results, call ListSecretVersionIds
again with the value from NextToken
.
*
NextToken
response element is present and has a value (isn't null).
- * Include that value as the NextToken
request parameter in the next call to the operation to
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
- * even when there are more results available. You should check NextToken
after every operation
- * to ensure that you receive all of the results.
+ * @return The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To
+ * get the next results, call ListSecretVersionIds
again with the value from
+ * NextToken
.
*/
public Integer getMaxResults() {
@@ -175,23 +157,19 @@ public Integer getMaxResults() {
/**
*
- * (Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
- * it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
- * specify, the NextToken
response element is present and has a value (isn't null). Include that value
- * as the NextToken
request parameter in the next call to the operation to get the next part of the
- * results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
- * available. You should check NextToken
after every operation to ensure that you receive all of the
- * results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To get the
+ * next results, call ListSecretVersionIds
again with the value from NextToken
.
*
NextToken
response element is present and has a value (isn't null).
- * Include that value as the NextToken
request parameter in the next call to the operation to
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
- * even when there are more results available. You should check NextToken
after every operation
- * to ensure that you receive all of the results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To
+ * get the next results, call ListSecretVersionIds
again with the value from
+ * NextToken
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -202,15 +180,13 @@ public ListSecretVersionIdsRequest withMaxResults(Integer maxResults) {
/**
*
- * (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request
- * indicating there's more output available. In a subsequent call, set it to the value of the previous call
- * NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results. To get
+ * the next results, call ListSecretVersionIds
again with this value.
*
NextToken
response in a previous
- * request indicating there's more output available. In a subsequent call, set it to the value of the
- * previous call NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results.
+ * To get the next results, call ListSecretVersionIds
again with this value.
*/
public void setNextToken(String nextToken) {
@@ -219,14 +195,12 @@ public void setNextToken(String nextToken) {
/**
*
- * (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request
- * indicating there's more output available. In a subsequent call, set it to the value of the previous call
- * NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results. To get
+ * the next results, call ListSecretVersionIds
again with this value.
*
NextToken
response in a previous
- * request indicating there's more output available. In a subsequent call, set it to the value of the
- * previous call NextToken
response to indicate where the output should continue from.
+ * @return A token that indicates where the output should continue from, if a previous call did not show all
+ * results. To get the next results, call ListSecretVersionIds
again with this value.
*/
public String getNextToken() {
@@ -235,15 +209,13 @@ public String getNextToken() {
/**
*
- * (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request
- * indicating there's more output available. In a subsequent call, set it to the value of the previous call
- * NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results. To get
+ * the next results, call ListSecretVersionIds
again with this value.
*
NextToken
response in a previous
- * request indicating there's more output available. In a subsequent call, set it to the value of the
- * previous call NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results.
+ * To get the next results, call ListSecretVersionIds
again with this value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -254,14 +226,13 @@ public ListSecretVersionIdsRequest withNextToken(String nextToken) {
/**
* - * (Optional) Specifies that you want the results to include versions that do not have any staging labels attached - * to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed. + * 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. *
* * @param includeDeprecated - * (Optional) Specifies that you want the results to include versions that do not have any staging labels - * attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager - * as needed. + * 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. */ public void setIncludeDeprecated(Boolean includeDeprecated) { @@ -270,13 +241,12 @@ public void setIncludeDeprecated(Boolean includeDeprecated) { /** *- * (Optional) Specifies that you want the results to include versions that do not have any staging labels attached - * to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed. + * 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. *
* - * @return (Optional) Specifies that you want the results to include versions that do not have any staging labels - * attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager - * as needed. + * @return 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. */ public Boolean getIncludeDeprecated() { @@ -285,14 +255,13 @@ public Boolean getIncludeDeprecated() { /** *- * (Optional) Specifies that you want the results to include versions that do not have any staging labels attached - * to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed. + * 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. *
* * @param includeDeprecated - * (Optional) Specifies that you want the results to include versions that do not have any staging labels - * attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager - * as needed. + * 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. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -303,13 +272,12 @@ public ListSecretVersionIdsRequest withIncludeDeprecated(Boolean includeDeprecat /** *- * (Optional) Specifies that you want the results to include versions that do not have any staging labels attached - * to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed. + * 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. *
* - * @return (Optional) Specifies that you want the results to include versions that do not have any staging labels - * attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager - * as needed. + * @return 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. */ public Boolean isIncludeDeprecated() { diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretVersionIdsResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretVersionIdsResult.java index d7c1ab058622..bb003c6631e2 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretVersionIdsResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretVersionIdsResult.java @@ -25,47 +25,37 @@ public class ListSecretVersionIdsResult extends com.amazonaws.AmazonWebServiceRe /** *- * The list of the currently available versions of the specified secret. + * A list of the versions of the secret. *
*/ private java.util.List
- * If present in the response, this value indicates that there's more output available than included in the current
+ * Secrets Manager includes this value if there's more output available than what is included in the current
* response. This can occur even when the response includes no values at all, such as when you ask for a filtered
- * view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to
- * the operation to continue processing and get the next part of the output. You should repeat this until the
- * NextToken
response element comes back empty (as null
).
+ * view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
*
- * The Amazon Resource Name (ARN) for the secret. + * The ARN of the secret. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. - *
- *- * The friendly name of the secret. + * The name of the secret. *
*/ private String name; /** *- * The list of the currently available versions of the specified secret. + * A list of the versions of the secret. *
* - * @return The list of the currently available versions of the specified secret. + * @return A list of the versions of the secret. */ public java.util.List- * The list of the currently available versions of the specified secret. + * A list of the versions of the secret. *
* * @param versions - * The list of the currently available versions of the specified secret. + * A list of the versions of the secret. */ public void setVersions(java.util.Collection- * The list of the currently available versions of the specified secret. + * A list of the versions of the secret. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -101,7 +91,7 @@ public void setVersions(java.util.Collection
- * The list of the currently available versions of the specified secret. + * A list of the versions of the secret. *
* * @param versions - * The list of the currently available versions of the specified secret. + * A list of the versions of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -132,19 +122,16 @@ public ListSecretVersionIdsResult withVersions(java.util.CollectionNextToken
request parameter in a subsequent call to
- * the operation to continue processing and get the next part of the output. You should repeat this until the
- * NextToken
response element comes back empty (as null
).
+ * view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
*
*
* @param nextToken
- * If present in the response, this value indicates that there's more output available than included in the
- * current response. This can occur even when the response includes no values at all, such as when you ask
- * for a filtered view of a very long list. Use this value in the NextToken
request parameter in
- * a subsequent call to the operation to continue processing and get the next part of the output. You should
- * repeat this until the NextToken
response element comes back empty (as null
).
+ * Secrets Manager includes this value if there's more output available than what is included in the current
+ * response. This can occur even when the response includes no values at all, such as when you ask for a
+ * filtered view of a long list. To get the next results, call ListSecretVersionIds
again with
+ * this value.
*/
public void setNextToken(String nextToken) {
@@ -153,19 +140,15 @@ public void setNextToken(String nextToken) {
/**
*
- * If present in the response, this value indicates that there's more output available than included in the current
+ * Secrets Manager includes this value if there's more output available than what is included in the current
* response. This can occur even when the response includes no values at all, such as when you ask for a filtered
- * view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to
- * the operation to continue processing and get the next part of the output. You should repeat this until the
- * NextToken
response element comes back empty (as null
).
+ * view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
*
NextToken
request parameter
- * in a subsequent call to the operation to continue processing and get the next part of the output. You
- * should repeat this until the NextToken
response element comes back empty (as
- * null
).
+ * @return Secrets Manager includes this value if there's more output available than what is included in the current
+ * response. This can occur even when the response includes no values at all, such as when you ask for a
+ * filtered view of a long list. To get the next results, call ListSecretVersionIds
again with
+ * this value.
*/
public String getNextToken() {
@@ -174,19 +157,16 @@ public String getNextToken() {
/**
*
- * If present in the response, this value indicates that there's more output available than included in the current
+ * Secrets Manager includes this value if there's more output available than what is included in the current
* response. This can occur even when the response includes no values at all, such as when you ask for a filtered
- * view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to
- * the operation to continue processing and get the next part of the output. You should repeat this until the
- * NextToken
response element comes back empty (as null
).
+ * view of a long list. To get the next results, call ListSecretVersionIds
again with this value.
*
NextToken
request parameter in
- * a subsequent call to the operation to continue processing and get the next part of the output. You should
- * repeat this until the NextToken
response element comes back empty (as null
).
+ * Secrets Manager includes this value if there's more output available than what is included in the current
+ * response. This can occur even when the response includes no values at all, such as when you ask for a
+ * filtered view of a long list. To get the next results, call ListSecretVersionIds
again with
+ * this value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -197,26 +177,11 @@ public ListSecretVersionIdsResult withNextToken(String nextToken) {
/**
* - * The Amazon Resource Name (ARN) for the secret. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. + * The ARN of the secret. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs are - * different. - *
+ * The ARN of the secret. */ public void setARN(String aRN) { @@ -225,25 +190,10 @@ public void setARN(String aRN) { /** *- * The Amazon Resource Name (ARN) for the secret. + * The ARN of the secret. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs - * are different. - *
+ * @return The ARN of the secret. */ public String getARN() { @@ -252,26 +202,11 @@ public String getARN() { /** *- * The Amazon Resource Name (ARN) for the secret. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. + * The ARN of the secret. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs are - * different. - *
+ * The ARN of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -282,11 +217,11 @@ public ListSecretVersionIdsResult withARN(String aRN) { /** *- * The friendly name of the secret. + * The name of the secret. *
* * @param name - * The friendly name of the secret. + * The name of the secret. */ public void setName(String name) { @@ -295,10 +230,10 @@ public void setName(String name) { /** *- * The friendly name of the secret. + * The name of the secret. *
* - * @return The friendly name of the secret. + * @return The name of the secret. */ public String getName() { @@ -307,11 +242,11 @@ public String getName() { /** *- * The friendly name of the secret. + * The name of the secret. *
* * @param name - * The friendly name of the secret. + * The name of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretsRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretsRequest.java index 09625663f760..cd3d665fe0fe 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretsRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretsRequest.java @@ -27,27 +27,24 @@ public class ListSecretsRequest extends com.amazonaws.AmazonWebServiceRequest im /** *
- * (Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
- * it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
- * specify, the NextToken
response element is present and has a value (isn't null). Include that value
- * as the NextToken
request parameter in the next call to the operation to get the next part of the
- * results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
- * available. You should check NextToken
after every operation to ensure that you receive all of the
- * results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To get the
+ * next results, call ListSecrets
again with the value from NextToken
.
*
- * (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request
- * indicating there's more output available. In a subsequent call, set it to the value of the previous call
- * NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results. To get
+ * the next results, call ListSecrets
again with this value.
*
- * Lists the secret request filters. + * The filters to apply to the list of secrets. *
*/ private java.util.List
- * (Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
- * it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
- * specify, the NextToken
response element is present and has a value (isn't null). Include that value
- * as the NextToken
request parameter in the next call to the operation to get the next part of the
- * results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
- * available. You should check NextToken
after every operation to ensure that you receive all of the
- * results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To get the
+ * next results, call ListSecrets
again with the value from NextToken
.
*
NextToken
response element is present and has a value (isn't null).
- * Include that value as the NextToken
request parameter in the next call to the operation to
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
- * even when there are more results available. You should check NextToken
after every operation
- * to ensure that you receive all of the results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To
+ * get the next results, call ListSecrets
again with the value from NextToken
.
*/
public void setMaxResults(Integer maxResults) {
@@ -85,22 +77,17 @@ public void setMaxResults(Integer maxResults) {
/**
*
- * (Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
- * it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
- * specify, the NextToken
response element is present and has a value (isn't null). Include that value
- * as the NextToken
request parameter in the next call to the operation to get the next part of the
- * results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
- * available. You should check NextToken
after every operation to ensure that you receive all of the
- * results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To get the
+ * next results, call ListSecrets
again with the value from NextToken
.
*
NextToken
response element is present and has a value (isn't null).
- * Include that value as the NextToken
request parameter in the next call to the operation to
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
- * even when there are more results available. You should check NextToken
after every operation
- * to ensure that you receive all of the results.
+ * @return The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To
+ * get the next results, call ListSecrets
again with the value from NextToken
.
*/
public Integer getMaxResults() {
@@ -109,23 +96,18 @@ public Integer getMaxResults() {
/**
*
- * (Optional) Limits the number of results you want to include in the response. If you don't include this parameter,
- * it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you
- * specify, the NextToken
response element is present and has a value (isn't null). Include that value
- * as the NextToken
request parameter in the next call to the operation to get the next part of the
- * results. Note that Secrets Manager might return fewer results than the maximum even when there are more results
- * available. You should check NextToken
after every operation to ensure that you receive all of the
- * results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To get the
+ * next results, call ListSecrets
again with the value from NextToken
.
*
NextToken
response element is present and has a value (isn't null).
- * Include that value as the NextToken
request parameter in the next call to the operation to
- * get the next part of the results. Note that Secrets Manager might return fewer results than the maximum
- * even when there are more results available. You should check NextToken
after every operation
- * to ensure that you receive all of the results.
+ * The number of results to include in the response.
+ *
+ * If there are more results available, in the response, Secrets Manager includes NextToken
. To
+ * get the next results, call ListSecrets
again with the value from NextToken
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -136,15 +118,13 @@ public ListSecretsRequest withMaxResults(Integer maxResults) {
/**
*
- * (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request
- * indicating there's more output available. In a subsequent call, set it to the value of the previous call
- * NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results. To get
+ * the next results, call ListSecrets
again with this value.
*
NextToken
response in a previous
- * request indicating there's more output available. In a subsequent call, set it to the value of the
- * previous call NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results.
+ * To get the next results, call ListSecrets
again with this value.
*/
public void setNextToken(String nextToken) {
@@ -153,14 +133,12 @@ public void setNextToken(String nextToken) {
/**
*
- * (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request
- * indicating there's more output available. In a subsequent call, set it to the value of the previous call
- * NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results. To get
+ * the next results, call ListSecrets
again with this value.
*
NextToken
response in a previous
- * request indicating there's more output available. In a subsequent call, set it to the value of the
- * previous call NextToken
response to indicate where the output should continue from.
+ * @return A token that indicates where the output should continue from, if a previous call did not show all
+ * results. To get the next results, call ListSecrets
again with this value.
*/
public String getNextToken() {
@@ -169,15 +147,13 @@ public String getNextToken() {
/**
*
- * (Optional) Use this parameter in a request if you receive a NextToken
response in a previous request
- * indicating there's more output available. In a subsequent call, set it to the value of the previous call
- * NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results. To get
+ * the next results, call ListSecrets
again with this value.
*
NextToken
response in a previous
- * request indicating there's more output available. In a subsequent call, set it to the value of the
- * previous call NextToken
response to indicate where the output should continue from.
+ * A token that indicates where the output should continue from, if a previous call did not show all results.
+ * To get the next results, call ListSecrets
again with this value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -188,10 +164,10 @@ public ListSecretsRequest withNextToken(String nextToken) {
/**
* - * Lists the secret request filters. + * The filters to apply to the list of secrets. *
* - * @return Lists the secret request filters. + * @return The filters to apply to the list of secrets. */ public java.util.List- * Lists the secret request filters. + * The filters to apply to the list of secrets. *
* * @param filters - * Lists the secret request filters. + * The filters to apply to the list of secrets. */ public void setFilters(java.util.Collection- * Lists the secret request filters. + * The filters to apply to the list of secrets. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -227,7 +203,7 @@ public void setFilters(java.util.Collection
- * Lists the secret request filters. + * The filters to apply to the list of secrets. *
* * @param filters - * Lists the secret request filters. + * The filters to apply to the list of secrets. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretsResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretsResult.java index 9a52e3502f5b..bb97d0a02bad 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretsResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ListSecretsResult.java @@ -31,11 +31,9 @@ public class ListSecretsResult extends com.amazonaws.AmazonWebServiceResult
- * If present in the response, this value indicates that there's more output available than included in the current
+ * Secrets Manager includes this value if there's more output available than what is included in the current
* response. This can occur even when the response includes no values at all, such as when you ask for a filtered
- * view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to
- * the operation to continue processing and get the next part of the output. You should repeat this until the
- * NextToken
response element comes back empty (as null
).
+ * view of a long list. To get the next results, call ListSecrets
again with this value.
*
- * If present in the response, this value indicates that there's more output available than included in the current
+ * Secrets Manager includes this value if there's more output available than what is included in the current
* response. This can occur even when the response includes no values at all, such as when you ask for a filtered
- * view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to
- * the operation to continue processing and get the next part of the output. You should repeat this until the
- * NextToken
response element comes back empty (as null
).
+ * view of a long list. To get the next results, call ListSecrets
again with this value.
*
NextToken
request parameter in
- * a subsequent call to the operation to continue processing and get the next part of the output. You should
- * repeat this until the NextToken
response element comes back empty (as null
).
+ * Secrets Manager includes this value if there's more output available than what is included in the current
+ * response. This can occur even when the response includes no values at all, such as when you ask for a
+ * filtered view of a long list. To get the next results, call ListSecrets
again with this
+ * value.
*/
public void setNextToken(String nextToken) {
@@ -133,19 +128,15 @@ public void setNextToken(String nextToken) {
/**
*
- * If present in the response, this value indicates that there's more output available than included in the current
+ * Secrets Manager includes this value if there's more output available than what is included in the current
* response. This can occur even when the response includes no values at all, such as when you ask for a filtered
- * view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to
- * the operation to continue processing and get the next part of the output. You should repeat this until the
- * NextToken
response element comes back empty (as null
).
+ * view of a long list. To get the next results, call ListSecrets
again with this value.
*
NextToken
request parameter
- * in a subsequent call to the operation to continue processing and get the next part of the output. You
- * should repeat this until the NextToken
response element comes back empty (as
- * null
).
+ * @return Secrets Manager includes this value if there's more output available than what is included in the current
+ * response. This can occur even when the response includes no values at all, such as when you ask for a
+ * filtered view of a long list. To get the next results, call ListSecrets
again with this
+ * value.
*/
public String getNextToken() {
@@ -154,19 +145,16 @@ public String getNextToken() {
/**
*
- * If present in the response, this value indicates that there's more output available than included in the current
+ * Secrets Manager includes this value if there's more output available than what is included in the current
* response. This can occur even when the response includes no values at all, such as when you ask for a filtered
- * view of a very long list. Use this value in the NextToken
request parameter in a subsequent call to
- * the operation to continue processing and get the next part of the output. You should repeat this until the
- * NextToken
response element comes back empty (as null
).
+ * view of a long list. To get the next results, call ListSecrets
again with this value.
*
NextToken
request parameter in
- * a subsequent call to the operation to continue processing and get the next part of the output. You should
- * repeat this until the NextToken
response element comes back empty (as null
).
+ * Secrets Manager includes this value if there's more output available than what is included in the current
+ * response. This can occur even when the response includes no values at all, such as when you ask for a
+ * filtered view of a long list. To get the next results, call ListSecrets
again with this
+ * value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/MalformedPolicyDocumentException.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/MalformedPolicyDocumentException.java
index 7e81ead3a02c..9f9640c80572 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/MalformedPolicyDocumentException.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/MalformedPolicyDocumentException.java
@@ -16,7 +16,7 @@
/**
* - * You provided a resource-based policy with syntax errors. + * The resource policy has syntax errors. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PublicPolicyException.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PublicPolicyException.java index dc7d101239ce..4e481b609a52 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PublicPolicyException.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PublicPolicyException.java @@ -16,7 +16,8 @@ /** *
- * The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.
+ * The BlockPublicPolicy
parameter is set to true, and the resource policy did not prevent broad access to
+ * the secret.
*
- * Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the - * friendly name of the secret. + * The ARN or name of the secret to attach the resource-based policy. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -37,34 +36,30 @@ public class PutResourcePolicyRequest extends com.amazonaws.AmazonWebServiceRequ private String secretId; /** *
- * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based - * policy. The policy in the string identifies who can access or manage this secret and its versions. For - * information on how to format a JSON parameter for the various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. + * A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions + * policy examples. *
*/ private String resourcePolicy; /** *
- * (Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based
- * policies that allow broad access to the secret.
+ * Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets
+ * Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
*
- * Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the - * friendly name of the secret. + * The ARN or name of the secret to attach the resource-based policy. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or - * the friendly name of the secret. + * The ARN or name of the secret to attach the resource-based policy. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -75,15 +70,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the - * friendly name of the secret. + * The ARN or name of the secret to attach the resource-based policy. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or - * the friendly name of the secret. + * @return The ARN or name of the secret to attach the resource-based policy. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -94,16 +87,14 @@ public String getSecretId() { /** *
- * Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the - * friendly name of the secret. + * The ARN or name of the secret to attach the resource-based policy. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or - * the friendly name of the secret. + * The ARN or name of the secret to attach the resource-based policy. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -116,20 +107,16 @@ public PutResourcePolicyRequest withSecretId(String secretId) { /** *
- * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based - * policy. The policy in the string identifies who can access or manage this secret and its versions. For - * information on how to format a JSON parameter for the various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. + * A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions + * policy examples. *
* * @param resourcePolicy - * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services - * resource-based policy. The policy in the string identifies who can access or manage this secret and its - * versions. For information on how to format a JSON parameter for the various command line tool - * environments, see Using - * JSON for Parameters in the CLI User Guide. + * A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions + * policy examples. */ public void setResourcePolicy(String resourcePolicy) { @@ -138,19 +125,15 @@ public void setResourcePolicy(String resourcePolicy) { /** *- * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based - * policy. The policy in the string identifies who can access or manage this secret and its versions. For - * information on how to format a JSON parameter for the various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. + * A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions + * policy examples. *
* - * @return A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services - * resource-based policy. The policy in the string identifies who can access or manage this secret and its - * versions. For information on how to format a JSON parameter for the various command line tool - * environments, see Using - * JSON for Parameters in the CLI User Guide. + * @return A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions + * policy examples. */ public String getResourcePolicy() { @@ -159,20 +142,16 @@ public String getResourcePolicy() { /** *- * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based - * policy. The policy in the string identifies who can access or manage this secret and its versions. For - * information on how to format a JSON parameter for the various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide. + * A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions + * policy examples. *
* * @param resourcePolicy - * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services - * resource-based policy. The policy in the string identifies who can access or manage this secret and its - * versions. For information on how to format a JSON parameter for the various command line tool - * environments, see Using - * JSON for Parameters in the CLI User Guide. + * A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions + * policy examples. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -183,13 +162,14 @@ public PutResourcePolicyRequest withResourcePolicy(String resourcePolicy) { /** *
- * (Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based
- * policies that allow broad access to the secret.
+ * Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets
+ * Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
*
BlockPublicPolicy
to true, then you block resource-based
- * policies that allow broad access to the secret.
+ * Specifies whether to block resource-based policies that allow broad access to the secret. By default,
+ * Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the
+ * principal.
*/
public void setBlockPublicPolicy(Boolean blockPublicPolicy) {
@@ -198,12 +178,13 @@ public void setBlockPublicPolicy(Boolean blockPublicPolicy) {
/**
*
- * (Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based
- * policies that allow broad access to the secret.
+ * Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets
+ * Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
*
BlockPublicPolicy
to true, then you block
- * resource-based policies that allow broad access to the secret.
+ * @return Specifies whether to block resource-based policies that allow broad access to the secret. By default,
+ * Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the
+ * principal.
*/
public Boolean getBlockPublicPolicy() {
@@ -212,13 +193,14 @@ public Boolean getBlockPublicPolicy() {
/**
*
- * (Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based
- * policies that allow broad access to the secret.
+ * Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets
+ * Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
*
BlockPublicPolicy
to true, then you block resource-based
- * policies that allow broad access to the secret.
+ * Specifies whether to block resource-based policies that allow broad access to the secret. By default,
+ * Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the
+ * principal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -229,12 +211,13 @@ public PutResourcePolicyRequest withBlockPublicPolicy(Boolean blockPublicPolicy)
/**
*
- * (Optional) If you set the parameter, BlockPublicPolicy
to true, then you block resource-based
- * policies that allow broad access to the secret.
+ * Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets
+ * Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
*
BlockPublicPolicy
to true, then you block
- * resource-based policies that allow broad access to the secret.
+ * @return Specifies whether to block resource-based policies that allow broad access to the secret. By default,
+ * Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the
+ * principal.
*/
public Boolean isBlockPublicPolicy() {
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutResourcePolicyResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutResourcePolicyResult.java
index a4fbc996ea7d..2b1b39beca7c 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutResourcePolicyResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutResourcePolicyResult.java
@@ -25,24 +25,24 @@ public class PutResourcePolicyResult extends com.amazonaws.AmazonWebServiceResul
/**
* - * The ARN of the secret retrieved by the resource-based policy. + * The ARN of the secret. *
*/ private String aRN; /** *- * The friendly name of the secret retrieved by the resource-based policy. + * The name of the secret. *
*/ private String name; /** *- * The ARN of the secret retrieved by the resource-based policy. + * The ARN of the secret. *
* * @param aRN - * The ARN of the secret retrieved by the resource-based policy. + * The ARN of the secret. */ public void setARN(String aRN) { @@ -51,10 +51,10 @@ public void setARN(String aRN) { /** *- * The ARN of the secret retrieved by the resource-based policy. + * The ARN of the secret. *
* - * @return The ARN of the secret retrieved by the resource-based policy. + * @return The ARN of the secret. */ public String getARN() { @@ -63,11 +63,11 @@ public String getARN() { /** *- * The ARN of the secret retrieved by the resource-based policy. + * The ARN of the secret. *
* * @param aRN - * The ARN of the secret retrieved by the resource-based policy. + * The ARN of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -78,11 +78,11 @@ public PutResourcePolicyResult withARN(String aRN) { /** *- * The friendly name of the secret retrieved by the resource-based policy. + * The name of the secret. *
* * @param name - * The friendly name of the secret retrieved by the resource-based policy. + * The name of the secret. */ public void setName(String name) { @@ -91,10 +91,10 @@ public void setName(String name) { /** *- * The friendly name of the secret retrieved by the resource-based policy. + * The name of the secret. *
* - * @return The friendly name of the secret retrieved by the resource-based policy. + * @return The name of the secret. */ public String getName() { @@ -103,11 +103,11 @@ public String getName() { /** *- * The friendly name of the secret retrieved by the resource-based policy. + * The name of the secret. *
* * @param name - * The friendly name of the secret retrieved by the resource-based policy. + * The name of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutSecretValueRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutSecretValueRequest.java index 69cd85409542..addae1e454f0 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutSecretValueRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutSecretValueRequest.java @@ -27,31 +27,33 @@ public class PutSecretValueRequest extends com.amazonaws.AmazonWebServiceRequest /** *- * Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. The secret must already exist. + * The ARN or name of the secret to add a new version to. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
+ *
+ * If the secret doesn't already exist, use CreateSecret
instead.
+ *
- * (Optional) Specifies a unique identifier for the new version of the secret. + * A unique identifier for the new version of the secret. *
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If
- * you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you
- * must generate a ClientRequestToken
yourself for new versions and include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead
+ * generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
+ * ClientRequestToken
yourself for new versions and include that value in the request.
*
* This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of - * duplicate versions if there are failures and retries during the Lambda rotation function's processing. We - * recommend that you generate a UUID-type - * value to ensure uniqueness within the specified secret. + * duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend + * that you generate a UUID-type value to + * ensure uniqueness within the specified secret. *
*
* If a version with this value already exists and that version's SecretString
or
- * SecretBinary
values are the same as those in the request then the request is ignored (the operation
- * is idempotent).
+ * SecretBinary
values are the same as those in the request then the request is ignored. The operation
+ * is idempotent.
*
* If a version with this value already exists and the version of the SecretString
and
- * SecretBinary
values are different from those in the request then the request fails because you
- * cannot modify an existing secret version. You can only create new versions to store new secret values.
+ * SecretBinary
values are different from those in the request, then the request fails because you
+ * can't modify a secret version. You can only create new versions to store new secret values.
*
- * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this
- * parameter in the command-line tools, we recommend that you store your binary data in a file and then use the
- * appropriate technique for your tool to pass the contents of the file as a parameter. Either
- * SecretBinary
or SecretString
must have a value, but not both. They cannot both be
- * empty.
+ * The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line
+ * tools, we recommend that you store your binary data in a file and then pass the contents of the file as a
+ * parameter.
+ *
+ * You must include SecretBinary
or SecretString
, but not both.
*
- * This parameter is not accessible if the secret using the Secrets Manager console. + * You can't access this value from the Secrets Manager console. *
- * */ private java.nio.ByteBuffer secretBinary; /** *
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either
- * SecretString
or SecretBinary
must have a value, but not both. They cannot both be
- * empty.
+ * The text to encrypt and store in the new version of the secret.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret
- * text in only the SecretString
parameter. The Secrets Manager console stores the information as a
- * JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
+ * You must include SecretBinary
or SecretString
, but not both.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. - * For more information, see Specifying parameter values for - * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * We recommend you create the secret string as JSON key/value pairs, as shown in the example. *
*/ private String secretString; /** *- * (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging - * labels are used to track the versions through the rotation process by the Lambda rotation function. + * A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track + * versions of a secret through the rotation process. *
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's already
- * associated with a different version of the same secret then that staging label is automatically removed from the
- * other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret, then
+ * Secrets Manager removes the label from the other version and attaches it to this version. If you specify
+ * AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the
+ * staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
*
- * If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging
- * label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version.
*
- * Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. The secret must already exist. + * The ARN or name of the secret to add a new version to. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
+ *
+ * If the secret doesn't already exist, use CreateSecret
instead.
+ *
* For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + *
+ *
+ * If the secret doesn't already exist, use CreateSecret
instead.
*/
public void setSecretId(String secretId) {
@@ -152,17 +152,21 @@ public void setSecretId(String secretId) {
/**
*
- * Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. The secret must already exist. + * The ARN or name of the secret to add a new version to. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
+ *
+ * If the secret doesn't already exist, use CreateSecret
instead.
+ *
* For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + *
+ *
+ * If the secret doesn't already exist, use CreateSecret
instead.
*/
public String getSecretId() {
@@ -171,18 +175,22 @@ public String getSecretId() {
/**
*
- * Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. The secret must already exist. + * The ARN or name of the secret to add a new version to. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
+ *
+ * If the secret doesn't already exist, use CreateSecret
instead.
+ *
* For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + *
+ *
+ * If the secret doesn't already exist, use CreateSecret
instead.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -193,21 +201,21 @@ public PutSecretValueRequest withSecretId(String secretId) {
/**
*
- * (Optional) Specifies a unique identifier for the new version of the secret. + * A unique identifier for the new version of the secret. *
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If
- * you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you
- * must generate a ClientRequestToken
yourself for new versions and include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead
+ * generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
+ * ClientRequestToken
yourself for new versions and include that value in the request.
*
* This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of - * duplicate versions if there are failures and retries during the Lambda rotation function's processing. We - * recommend that you generate a UUID-type - * value to ensure uniqueness within the specified secret. + * duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend + * that you generate a UUID-type value to + * ensure uniqueness within the specified secret. *
*
* If a version with this value already exists and that version's SecretString
or
- * SecretBinary
values are the same as those in the request then the request is ignored (the operation
- * is idempotent).
+ * SecretBinary
values are the same as those in the request then the request is ignored. The operation
+ * is idempotent.
*
* If a version with this value already exists and the version of the SecretString
and
- * SecretBinary
values are different from those in the request then the request fails because you
- * cannot modify an existing secret version. You can only create new versions to store new secret values.
+ * SecretBinary
values are different from those in the request, then the request fails because you
+ * can't modify a secret version. You can only create new versions to store new secret values.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
- * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in
- * the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for new versions and
- * include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then
+ * you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK
+ * and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
+ * ClientRequestToken
yourself for new versions and include that value in the request.
*
* This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of - * duplicate versions if there are failures and retries during the Lambda rotation function's processing. We + * duplicate versions if there are failures and retries during the Lambda rotation function processing. We * recommend that you generate a UUID-type value to ensure uniqueness * within the specified secret. @@ -262,15 +269,15 @@ public PutSecretValueRequest withSecretId(String secretId) { *
* If a version with this value already exists and that version's SecretString
or
- * SecretBinary
values are the same as those in the request then the request is ignored (the
- * operation is idempotent).
+ * SecretBinary
values are the same as those in the request then the request is ignored. The
+ * operation is idempotent.
*
* If a version with this value already exists and the version of the SecretString
and
- * SecretBinary
values are different from those in the request then the request fails because
- * you cannot modify an existing secret version. You can only create new versions to store new secret values.
+ * SecretBinary
values are different from those in the request, then the request fails because
+ * you can't modify a secret version. You can only create new versions to store new secret values.
*
- * (Optional) Specifies a unique identifier for the new version of the secret. + * A unique identifier for the new version of the secret. *
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If
- * you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you
- * must generate a ClientRequestToken
yourself for new versions and include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead
+ * generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
+ * ClientRequestToken
yourself for new versions and include that value in the request.
*
* This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of - * duplicate versions if there are failures and retries during the Lambda rotation function's processing. We - * recommend that you generate a UUID-type - * value to ensure uniqueness within the specified secret. + * duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend + * that you generate a UUID-type value to + * ensure uniqueness within the specified secret. *
*
* If a version with this value already exists and that version's SecretString
or
- * SecretBinary
values are the same as those in the request then the request is ignored (the operation
- * is idempotent).
+ * SecretBinary
values are the same as those in the request then the request is ignored. The operation
+ * is idempotent.
*
* If a version with this value already exists and the version of the SecretString
and
- * SecretBinary
values are different from those in the request then the request fails because you
- * cannot modify an existing secret version. You can only create new versions to store new secret values.
+ * SecretBinary
values are different from those in the request, then the request fails because you
+ * can't modify a secret version. You can only create new versions to store new secret values.
*
VersionId
of the new version.
*
*
- * @return (Optional) Specifies a unique identifier for the new version of the secret.
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
- * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in
- * the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for new versions and
- * include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation,
+ * then you can leave this parameter empty because they generate a random UUID for you. If you don't use the
+ * SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must
+ * generate a ClientRequestToken
yourself for new versions and include that value in the
+ * request.
*
* This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation - * of duplicate versions if there are failures and retries during the Lambda rotation function's processing. + * of duplicate versions if there are failures and retries during the Lambda rotation function processing. * We recommend that you generate a UUID-type value to ensure uniqueness * within the specified secret. @@ -352,16 +359,15 @@ public void setClientRequestToken(String clientRequestToken) { *
* If a version with this value already exists and that version's SecretString
or
- * SecretBinary
values are the same as those in the request then the request is ignored (the
- * operation is idempotent).
+ * SecretBinary
values are the same as those in the request then the request is ignored. The
+ * operation is idempotent.
*
* If a version with this value already exists and the version of the SecretString
and
- * SecretBinary
values are different from those in the request then the request fails because
- * you cannot modify an existing secret version. You can only create new versions to store new secret
- * values.
+ * SecretBinary
values are different from those in the request, then the request fails because
+ * you can't modify a secret version. You can only create new versions to store new secret values.
*
- * (Optional) Specifies a unique identifier for the new version of the secret. + * A unique identifier for the new version of the secret. *
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If
- * you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you
- * must generate a ClientRequestToken
yourself for new versions and include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK and instead
+ * generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
+ * ClientRequestToken
yourself for new versions and include that value in the request.
*
* This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of - * duplicate versions if there are failures and retries during the Lambda rotation function's processing. We - * recommend that you generate a UUID-type - * value to ensure uniqueness within the specified secret. + * duplicate versions if there are failures and retries during the Lambda rotation function processing. We recommend + * that you generate a UUID-type value to + * ensure uniqueness within the specified secret. *
*
* If a version with this value already exists and that version's SecretString
or
- * SecretBinary
values are the same as those in the request then the request is ignored (the operation
- * is idempotent).
+ * SecretBinary
values are the same as those in the request then the request is ignored. The operation
+ * is idempotent.
*
* If a version with this value already exists and the version of the SecretString
and
- * SecretBinary
values are different from those in the request then the request fails because you
- * cannot modify an existing secret version. You can only create new versions to store new secret values.
+ * SecretBinary
values are different from those in the request, then the request fails because you
+ * can't modify a secret version. You can only create new versions to store new secret values.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
- * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in
- * the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for new versions and
- * include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then
+ * you can leave this parameter empty because they generate a random UUID for you. If you don't use the SDK
+ * and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
+ * ClientRequestToken
yourself for new versions and include that value in the request.
*
* This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of - * duplicate versions if there are failures and retries during the Lambda rotation function's processing. We + * duplicate versions if there are failures and retries during the Lambda rotation function processing. We * recommend that you generate a UUID-type value to ensure uniqueness * within the specified secret. @@ -444,15 +449,15 @@ public String getClientRequestToken() { *
* If a version with this value already exists and that version's SecretString
or
- * SecretBinary
values are the same as those in the request then the request is ignored (the
- * operation is idempotent).
+ * SecretBinary
values are the same as those in the request then the request is ignored. The
+ * operation is idempotent.
*
* If a version with this value already exists and the version of the SecretString
and
- * SecretBinary
values are different from those in the request then the request fails because
- * you cannot modify an existing secret version. You can only create new versions to store new secret values.
+ * SecretBinary
values are different from those in the request, then the request fails because
+ * you can't modify a secret version. You can only create new versions to store new secret values.
*
- * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this
- * parameter in the command-line tools, we recommend that you store your binary data in a file and then use the
- * appropriate technique for your tool to pass the contents of the file as a parameter. Either
- * SecretBinary
or SecretString
must have a value, but not both. They cannot both be
- * empty.
+ * The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line
+ * tools, we recommend that you store your binary data in a file and then pass the contents of the file as a
+ * parameter.
*
- * This parameter is not accessible if the secret using the Secrets Manager console.
+ * You must include SecretBinary
or SecretString
, but not both.
+ *
+ * You can't access this value from the Secrets Manager console. *
- * ** The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. @@ -490,14 +495,14 @@ public PutSecretValueRequest withClientRequestToken(String clientRequestToken) { *
* * @param secretBinary - * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To - * use this parameter in the command-line tools, we recommend that you store your binary data in a file and - * then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either - *SecretBinary
or SecretString
must have a value, but not both. They cannot both
- * be empty.
+ * The binary data to encrypt and store in the new version of the secret. To use this parameter in the
+ * command-line tools, we recommend that you store your binary data in a file and then pass the contents of
+ * the file as a parameter.
*
- * This parameter is not accessible if the secret using the Secrets Manager console.
+ * You must include SecretBinary
or SecretString
, but not both.
*
+ * You can't access this value from the Secrets Manager console. */ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { @@ -506,16 +511,16 @@ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { /** *
- * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this
- * parameter in the command-line tools, we recommend that you store your binary data in a file and then use the
- * appropriate technique for your tool to pass the contents of the file as a parameter. Either
- * SecretBinary
or SecretString
must have a value, but not both. They cannot both be
- * empty.
+ * The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line
+ * tools, we recommend that you store your binary data in a file and then pass the contents of the file as a
+ * parameter.
*
- * This parameter is not accessible if the secret using the Secrets Manager console.
+ * You must include SecretBinary
or SecretString
, but not both.
+ *
+ * You can't access this value from the Secrets Manager console. *
- * ** {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend * using {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view of the buffer with an independent @@ -524,14 +529,14 @@ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { * {@code position}. *
* - * @return (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To - * use this parameter in the command-line tools, we recommend that you store your binary data in a file and - * then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either - *SecretBinary
or SecretString
must have a value, but not both. They cannot both
- * be empty.
+ * @return The binary data to encrypt and store in the new version of the secret. To use this parameter in the
+ * command-line tools, we recommend that you store your binary data in a file and then pass the contents of
+ * the file as a parameter.
*
- * This parameter is not accessible if the secret using the Secrets Manager console.
+ * You must include SecretBinary
or SecretString
, but not both.
*
+ * You can't access this value from the Secrets Manager console. */ public java.nio.ByteBuffer getSecretBinary() { @@ -540,16 +545,16 @@ public java.nio.ByteBuffer getSecretBinary() { /** *
- * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this
- * parameter in the command-line tools, we recommend that you store your binary data in a file and then use the
- * appropriate technique for your tool to pass the contents of the file as a parameter. Either
- * SecretBinary
or SecretString
must have a value, but not both. They cannot both be
- * empty.
+ * The binary data to encrypt and store in the new version of the secret. To use this parameter in the command-line
+ * tools, we recommend that you store your binary data in a file and then pass the contents of the file as a
+ * parameter.
*
- * This parameter is not accessible if the secret using the Secrets Manager console.
+ * You must include SecretBinary
or SecretString
, but not both.
+ *
+ * You can't access this value from the Secrets Manager console. *
- * ** The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. * Users of the SDK should not perform Base64 encoding on this field. @@ -562,14 +567,14 @@ public java.nio.ByteBuffer getSecretBinary() { *
* * @param secretBinary - * (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To - * use this parameter in the command-line tools, we recommend that you store your binary data in a file and - * then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either - *SecretBinary
or SecretString
must have a value, but not both. They cannot both
- * be empty.
+ * The binary data to encrypt and store in the new version of the secret. To use this parameter in the
+ * command-line tools, we recommend that you store your binary data in a file and then pass the contents of
+ * the file as a parameter.
*
- * This parameter is not accessible if the secret using the Secrets Manager console.
+ * You must include SecretBinary
or SecretString
, but not both.
*
+ * You can't access this value from the Secrets Manager console. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -580,37 +585,22 @@ public PutSecretValueRequest withSecretBinary(java.nio.ByteBuffer secretBinary) /** *
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either
- * SecretString
or SecretBinary
must have a value, but not both. They cannot both be
- * empty.
+ * The text to encrypt and store in the new version of the secret.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret
- * text in only the SecretString
parameter. The Secrets Manager console stores the information as a
- * JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
+ * You must include SecretBinary
or SecretString
, but not both.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. - * For more information, see Specifying parameter values for - * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * We recommend you create the secret string as JSON key/value pairs, as shown in the example. *
* * @param secretString - * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. - * EitherSecretString
or SecretBinary
must have a value, but not both. They cannot
- * both be empty.
+ * The text to encrypt and store in the new version of the secret.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected
- * secret text in only the SecretString
parameter. The Secrets Manager console stores the
- * information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to
- * parse.
+ * You must include SecretBinary
or SecretString
, but not both.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value - * pairs. For more information, see Specifying parameter - * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * We recommend you create the secret string as JSON key/value pairs, as shown in the example. */ public void setSecretString(String secretString) { @@ -619,36 +609,21 @@ public void setSecretString(String secretString) { /** *
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either
- * SecretString
or SecretBinary
must have a value, but not both. They cannot both be
- * empty.
+ * The text to encrypt and store in the new version of the secret.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret
- * text in only the SecretString
parameter. The Secrets Manager console stores the information as a
- * JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
+ * You must include SecretBinary
or SecretString
, but not both.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. - * For more information, see Specifying parameter values for - * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * We recommend you create the secret string as JSON key/value pairs, as shown in the example. *
* - * @return (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. - * EitherSecretString
or SecretBinary
must have a value, but not both. They
- * cannot both be empty.
+ * @return The text to encrypt and store in the new version of the secret.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected
- * secret text in only the SecretString
parameter. The Secrets Manager console stores the
- * information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to
- * parse.
+ * You must include SecretBinary
or SecretString
, but not both.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value - * pairs. For more information, see Specifying parameter - * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * We recommend you create the secret string as JSON key/value pairs, as shown in the example. */ public String getSecretString() { @@ -657,37 +632,22 @@ public String getSecretString() { /** *
- * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either
- * SecretString
or SecretBinary
must have a value, but not both. They cannot both be
- * empty.
+ * The text to encrypt and store in the new version of the secret.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret
- * text in only the SecretString
parameter. The Secrets Manager console stores the information as a
- * JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
+ * You must include SecretBinary
or SecretString
, but not both.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. - * For more information, see Specifying parameter values for - * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * We recommend you create the secret string as JSON key/value pairs, as shown in the example. *
* * @param secretString - * (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. - * EitherSecretString
or SecretBinary
must have a value, but not both. They cannot
- * both be empty.
+ * The text to encrypt and store in the new version of the secret.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected
- * secret text in only the SecretString
parameter. The Secrets Manager console stores the
- * information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to
- * parse.
+ * You must include SecretBinary
or SecretString
, but not both.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value - * pairs. For more information, see Specifying parameter - * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide. + * We recommend you create the secret string as JSON key/value pairs, as shown in the example. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -698,30 +658,32 @@ public PutSecretValueRequest withSecretString(String secretString) { /** *
- * (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging - * labels are used to track the versions through the rotation process by the Lambda rotation function. + * A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track + * versions of a secret through the rotation process. *
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's already
- * associated with a different version of the same secret then that staging label is automatically removed from the
- * other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret, then
+ * Secrets Manager removes the label from the other version and attaches it to this version. If you specify
+ * AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the
+ * staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
*
- * If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging
- * label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version.
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's
- * already associated with a different version of the same secret then that staging label is automatically
- * removed from the other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret,
+ * then Secrets Manager removes the label from the other version and attaches it to this version. If you
+ * specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also
+ * moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed
+ * from.
*
- * If you do not specify a value for
- * (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging
- * labels are used to track the versions through the rotation process by the Lambda rotation function.
+ * A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track
+ * versions of a secret through the rotation process.
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's already
- * associated with a different version of the same secret then that staging label is automatically removed from the
- * other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret, then
+ * Secrets Manager removes the label from the other version and attaches it to this version. If you specify
+ *
- * If you do not specify a value for VersionStages
then Secrets Manager automatically moves the
- * staging label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging
+ * label AWSCURRENT
to this version.
*/
public java.util.ListAWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the
+ * staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
* VersionStages
then Secrets Manager automatically moves the staging
- * label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version.
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's
- * already associated with a different version of the same secret then that staging label is automatically
- * removed from the other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret, then
+ * Secrets Manager removes the label from the other version and attaches it to this version. If you specify
+ * AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves
+ * the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
*
- * If you do not specify a value for
- * (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging
- * labels are used to track the versions through the rotation process by the Lambda rotation function.
+ * A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track
+ * versions of a secret through the rotation process.
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's already
- * associated with a different version of the same secret then that staging label is automatically removed from the
- * other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret, then
+ * Secrets Manager removes the label from the other version and attaches it to this version. If you specify
+ *
- * If you do not specify a value for
* NOTE: This method appends the values to the existing list (if any). Use
@@ -787,17 +751,17 @@ public void setVersionStages(java.util.CollectionVersionStages
then Secrets Manager automatically moves the
- * staging label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging
+ * label AWSCURRENT
to this version.
*/
public void setVersionStages(java.util.CollectionAWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the
+ * staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
* VersionStages
then Secrets Manager automatically moves the staging
- * label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version.
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's
- * already associated with a different version of the same secret then that staging label is automatically
- * removed from the other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret, then
+ * Secrets Manager removes the label from the other version and attaches it to this version. If you specify
+ * AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves
+ * the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
*
- * If you do not specify a value for VersionStages
then Secrets Manager automatically moves the
- * staging label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging
+ * label AWSCURRENT
to this version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -813,31 +777,32 @@ public PutSecretValueRequest withVersionStages(String... versionStages) {
/**
*
- * (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging - * labels are used to track the versions through the rotation process by the Lambda rotation function. + * A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track + * versions of a secret through the rotation process. *
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's already
- * associated with a different version of the same secret then that staging label is automatically removed from the
- * other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret, then
+ * Secrets Manager removes the label from the other version and attaches it to this version. If you specify
+ * AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the
+ * staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
*
- * If you do not specify a value for VersionStages
then Secrets Manager automatically moves the staging
- * label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging label
+ * AWSCURRENT
to this version.
*
- * A staging label must be unique to a single version of the secret. If you specify a staging label that's
- * already associated with a different version of the same secret then that staging label is automatically
- * removed from the other version and attached to this version.
+ * If you specify a staging label that's already associated with a different version of the same secret, then
+ * Secrets Manager removes the label from the other version and attaches it to this version. If you specify
+ * AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves
+ * the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
*
- * If you do not specify a value for VersionStages
then Secrets Manager automatically moves the
- * staging label AWSCURRENT
to this new version.
+ * If you don't include VersionStages
, then Secrets Manager automatically moves the staging
+ * label AWSCURRENT
to this version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutSecretValueResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutSecretValueResult.java
index 834dcf06f059..b7ac745e388b 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutSecretValueResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/PutSecretValueResult.java
@@ -25,37 +25,37 @@ public class PutSecretValueResult extends com.amazonaws.AmazonWebServiceResult
- * The friendly name of the secret for which you just created or updated a version. + * The name of the secret. *
*/ private String name; /** *- * The unique identifier of the version of the secret you just created or updated. + * The unique identifier of the version of the secret. *
*/ private String versionId; /** *- * The list of staging labels that are currently attached to this version of the secret. Staging labels are used to - * track a version as it progresses through the secret rotation process. + * The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses + * staging labels to track a version as it progresses through the secret rotation process. *
*/ private java.util.List- * The Amazon Resource Name (ARN) for the secret for which you just created a version. + * The ARN of the secret. *
* * @param aRN - * The Amazon Resource Name (ARN) for the secret for which you just created a version. + * The ARN of the secret. */ public void setARN(String aRN) { @@ -64,10 +64,10 @@ public void setARN(String aRN) { /** *- * The Amazon Resource Name (ARN) for the secret for which you just created a version. + * The ARN of the secret. *
* - * @return The Amazon Resource Name (ARN) for the secret for which you just created a version. + * @return The ARN of the secret. */ public String getARN() { @@ -76,11 +76,11 @@ public String getARN() { /** *- * The Amazon Resource Name (ARN) for the secret for which you just created a version. + * The ARN of the secret. *
* * @param aRN - * The Amazon Resource Name (ARN) for the secret for which you just created a version. + * The ARN of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -91,11 +91,11 @@ public PutSecretValueResult withARN(String aRN) { /** *- * The friendly name of the secret for which you just created or updated a version. + * The name of the secret. *
* * @param name - * The friendly name of the secret for which you just created or updated a version. + * The name of the secret. */ public void setName(String name) { @@ -104,10 +104,10 @@ public void setName(String name) { /** *- * The friendly name of the secret for which you just created or updated a version. + * The name of the secret. *
* - * @return The friendly name of the secret for which you just created or updated a version. + * @return The name of the secret. */ public String getName() { @@ -116,11 +116,11 @@ public String getName() { /** *- * The friendly name of the secret for which you just created or updated a version. + * The name of the secret. *
* * @param name - * The friendly name of the secret for which you just created or updated a version. + * The name of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -131,11 +131,11 @@ public PutSecretValueResult withName(String name) { /** *- * The unique identifier of the version of the secret you just created or updated. + * The unique identifier of the version of the secret. *
* * @param versionId - * The unique identifier of the version of the secret you just created or updated. + * The unique identifier of the version of the secret. */ public void setVersionId(String versionId) { @@ -144,10 +144,10 @@ public void setVersionId(String versionId) { /** *- * The unique identifier of the version of the secret you just created or updated. + * The unique identifier of the version of the secret. *
* - * @return The unique identifier of the version of the secret you just created or updated. + * @return The unique identifier of the version of the secret. */ public String getVersionId() { @@ -156,11 +156,11 @@ public String getVersionId() { /** *- * The unique identifier of the version of the secret you just created or updated. + * The unique identifier of the version of the secret. *
* * @param versionId - * The unique identifier of the version of the secret you just created or updated. + * The unique identifier of the version of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -171,12 +171,12 @@ public PutSecretValueResult withVersionId(String versionId) { /** *- * The list of staging labels that are currently attached to this version of the secret. Staging labels are used to - * track a version as it progresses through the secret rotation process. + * The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses + * staging labels to track a version as it progresses through the secret rotation process. *
* - * @return The list of staging labels that are currently attached to this version of the secret. Staging labels are - * used to track a version as it progresses through the secret rotation process. + * @return The list of staging labels that are currently attached to this version of the secret. Secrets Manager + * uses staging labels to track a version as it progresses through the secret rotation process. */ public java.util.List- * The list of staging labels that are currently attached to this version of the secret. Staging labels are used to - * track a version as it progresses through the secret rotation process. + * The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses + * staging labels to track a version as it progresses through the secret rotation process. *
* * @param versionStages - * The list of staging labels that are currently attached to this version of the secret. Staging labels are - * used to track a version as it progresses through the secret rotation process. + * The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses + * staging labels to track a version as it progresses through the secret rotation process. */ public void setVersionStages(java.util.Collection- * The list of staging labels that are currently attached to this version of the secret. Staging labels are used to - * track a version as it progresses through the secret rotation process. + * The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses + * staging labels to track a version as it progresses through the secret rotation process. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -215,8 +215,8 @@ public void setVersionStages(java.util.Collection
- * The list of staging labels that are currently attached to this version of the secret. Staging labels are used to - * track a version as it progresses through the secret rotation process. + * The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses + * staging labels to track a version as it progresses through the secret rotation process. *
* * @param versionStages - * The list of staging labels that are currently attached to this version of the secret. Staging labels are - * used to track a version as it progresses through the secret rotation process. + * The list of staging labels that are currently attached to this version of the secret. Secrets Manager uses + * staging labels to track a version as it progresses through the secret rotation process. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RemoveRegionsFromReplicationRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RemoveRegionsFromReplicationRequest.java index a3615d80c172..902e58269598 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RemoveRegionsFromReplicationRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RemoveRegionsFromReplicationRequest.java @@ -27,24 +27,24 @@ public class RemoveRegionsFromReplicationRequest extends com.amazonaws.AmazonWeb /** *
- * Remove a secret by SecretId
from replica Regions.
+ * The ARN or name of the secret.
*
- * Remove replication from specific Regions. + * The Regions of the replicas to remove. *
*/ private java.util.List
- * Remove a secret by SecretId
from replica Regions.
+ * The ARN or name of the secret.
*
SecretId
from replica Regions.
+ * The ARN or name of the secret.
*/
public void setSecretId(String secretId) {
@@ -53,10 +53,10 @@ public void setSecretId(String secretId) {
/**
*
- * Remove a secret by SecretId
from replica Regions.
+ * The ARN or name of the secret.
*
SecretId
from replica Regions.
+ * @return The ARN or name of the secret.
*/
public String getSecretId() {
@@ -65,11 +65,11 @@ public String getSecretId() {
/**
*
- * Remove a secret by SecretId
from replica Regions.
+ * The ARN or name of the secret.
*
SecretId
from replica Regions.
+ * The ARN or name of the secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -80,10 +80,10 @@ public RemoveRegionsFromReplicationRequest withSecretId(String secretId) {
/**
* - * Remove replication from specific Regions. + * The Regions of the replicas to remove. *
* - * @return Remove replication from specific Regions. + * @return The Regions of the replicas to remove. */ public java.util.List- * Remove replication from specific Regions. + * The Regions of the replicas to remove. *
* * @param removeReplicaRegions - * Remove replication from specific Regions. + * The Regions of the replicas to remove. */ public void setRemoveReplicaRegions(java.util.Collection- * Remove replication from specific Regions. + * The Regions of the replicas to remove. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -119,7 +119,7 @@ public void setRemoveReplicaRegions(java.util.Collection
- * Remove replication from specific Regions. + * The Regions of the replicas to remove. *
* * @param removeReplicaRegions - * Remove replication from specific Regions. + * The Regions of the replicas to remove. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RemoveRegionsFromReplicationResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RemoveRegionsFromReplicationResult.java index 65c5df22fbba..0f8082e4c3eb 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RemoveRegionsFromReplicationResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RemoveRegionsFromReplicationResult.java @@ -25,24 +25,24 @@ public class RemoveRegionsFromReplicationResult extends com.amazonaws.AmazonWebS /** *
- * The secret ARN
removed from replication regions.
+ * The ARN of the primary secret.
*
- * Describes the remaining replication status after you remove regions from the replication list. + * The status of replicas for this secret after you remove Regions. *
*/ private java.util.List
- * The secret ARN
removed from replication regions.
+ * The ARN of the primary secret.
*
ARN
removed from replication regions.
+ * The ARN of the primary secret.
*/
public void setARN(String aRN) {
@@ -51,10 +51,10 @@ public void setARN(String aRN) {
/**
*
- * The secret ARN
removed from replication regions.
+ * The ARN of the primary secret.
*
ARN
removed from replication regions.
+ * @return The ARN of the primary secret.
*/
public String getARN() {
@@ -63,11 +63,11 @@ public String getARN() {
/**
*
- * The secret ARN
removed from replication regions.
+ * The ARN of the primary secret.
*
ARN
removed from replication regions.
+ * The ARN of the primary secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -78,10 +78,10 @@ public RemoveRegionsFromReplicationResult withARN(String aRN) {
/**
* - * Describes the remaining replication status after you remove regions from the replication list. + * The status of replicas for this secret after you remove Regions. *
* - * @return Describes the remaining replication status after you remove regions from the replication list. + * @return The status of replicas for this secret after you remove Regions. */ public java.util.List- * Describes the remaining replication status after you remove regions from the replication list. + * The status of replicas for this secret after you remove Regions. *
* * @param replicationStatus - * Describes the remaining replication status after you remove regions from the replication list. + * The status of replicas for this secret after you remove Regions. */ public void setReplicationStatus(java.util.Collection- * Describes the remaining replication status after you remove regions from the replication list. + * The status of replicas for this secret after you remove Regions. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -117,7 +117,7 @@ public void setReplicationStatus(java.util.Collection
- * Describes the remaining replication status after you remove regions from the replication list. + * The status of replicas for this secret after you remove Regions. *
* * @param replicationStatus - * Describes the remaining replication status after you remove regions from the replication list. + * The status of replicas for this secret after you remove Regions. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicaRegionType.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicaRegionType.java index 67cfecd69756..e31b1e80c73a 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicaRegionType.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicaRegionType.java @@ -19,8 +19,7 @@ /** *
- * (Optional) Custom type consisting of a Region
(required) and the KmsKeyId
which can be an
- * ARN
, Key ID
, or Alias
.
+ * A custom type that specifies a Region
and the KmsKeyId
for a replica secret.
*
- * Describes a single instance of Region objects. + * A Region code. For a list of Region codes, see Name and code of Regions. *
*/ private String region; /** *
- * Can be an ARN
, Key ID
, or Alias
.
+ * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager
+ * uses aws/secretsmanager
.
*
- * Describes a single instance of Region objects. + * A Region code. For a list of Region codes, see Name and code of Regions. *
* * @param region - * Describes a single instance of Region objects. + * A Region code. For a list of Region codes, see Name and code of + * Regions. */ public void setRegion(String region) { @@ -57,10 +61,13 @@ public void setRegion(String region) { /** *- * Describes a single instance of Region objects. + * A Region code. For a list of Region codes, see Name and code of Regions. *
* - * @return Describes a single instance of Region objects. + * @return A Region code. For a list of Region codes, see Name and code of + * Regions. */ public String getRegion() { @@ -69,11 +76,14 @@ public String getRegion() { /** *- * Describes a single instance of Region objects. + * A Region code. For a list of Region codes, see Name and code of Regions. *
* * @param region - * Describes a single instance of Region objects. + * A Region code. For a list of Region codes, see Name and code of + * Regions. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -84,11 +94,13 @@ public ReplicaRegionType withRegion(String region) { /** *
- * Can be an ARN
, Key ID
, or Alias
.
+ * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager
+ * uses aws/secretsmanager
.
*
ARN
, Key ID
, or Alias
.
+ * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets
+ * Manager uses aws/secretsmanager
.
*/
public void setKmsKeyId(String kmsKeyId) {
@@ -97,10 +109,12 @@ public void setKmsKeyId(String kmsKeyId) {
/**
*
- * Can be an ARN
, Key ID
, or Alias
.
+ * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager
+ * uses aws/secretsmanager
.
*
ARN
, Key ID
, or Alias
.
+ * @return The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets
+ * Manager uses aws/secretsmanager
.
*/
public String getKmsKeyId() {
@@ -109,11 +123,13 @@ public String getKmsKeyId() {
/**
*
- * Can be an ARN
, Key ID
, or Alias
.
+ * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager
+ * uses aws/secretsmanager
.
*
ARN
, Key ID
, or Alias
.
+ * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets
+ * Manager uses aws/secretsmanager
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicateSecretToRegionsRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicateSecretToRegionsRequest.java
index e544a4cf87d5..7fabcbb34823 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicateSecretToRegionsRequest.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicateSecretToRegionsRequest.java
@@ -27,30 +27,30 @@ public class ReplicateSecretToRegionsRequest extends com.amazonaws.AmazonWebServ
/**
*
- * Use the Secret Id
to replicate a secret to regions.
+ * The ARN or name of the secret to replicate.
*
- * Add Regions to replicate the secret. + * A list of Regions in which to replicate the secret. *
*/ private java.util.List- * (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
*/ private Boolean forceOverwriteReplicaSecret; /** *
- * Use the Secret Id
to replicate a secret to regions.
+ * The ARN or name of the secret to replicate.
*
Secret Id
to replicate a secret to regions.
+ * The ARN or name of the secret to replicate.
*/
public void setSecretId(String secretId) {
@@ -59,10 +59,10 @@ public void setSecretId(String secretId) {
/**
*
- * Use the Secret Id
to replicate a secret to regions.
+ * The ARN or name of the secret to replicate.
*
Secret Id
to replicate a secret to regions.
+ * @return The ARN or name of the secret to replicate.
*/
public String getSecretId() {
@@ -71,11 +71,11 @@ public String getSecretId() {
/**
*
- * Use the Secret Id
to replicate a secret to regions.
+ * The ARN or name of the secret to replicate.
*
Secret Id
to replicate a secret to regions.
+ * The ARN or name of the secret to replicate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -86,10 +86,10 @@ public ReplicateSecretToRegionsRequest withSecretId(String secretId) {
/**
* - * Add Regions to replicate the secret. + * A list of Regions in which to replicate the secret. *
* - * @return Add Regions to replicate the secret. + * @return A list of Regions in which to replicate the secret. */ public java.util.List- * Add Regions to replicate the secret. + * A list of Regions in which to replicate the secret. *
* * @param addReplicaRegions - * Add Regions to replicate the secret. + * A list of Regions in which to replicate the secret. */ public void setAddReplicaRegions(java.util.Collection- * Add Regions to replicate the secret. + * A list of Regions in which to replicate the secret. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -125,7 +125,7 @@ public void setAddReplicaRegions(java.util.Collection
- * Add Regions to replicate the secret. + * A list of Regions in which to replicate the secret. *
* * @param addReplicaRegions - * Add Regions to replicate the secret. + * A list of Regions in which to replicate the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -156,12 +156,11 @@ public ReplicateSecretToRegionsRequest withAddReplicaRegions(java.util.Collectio /** *- * (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
* * @param forceOverwriteReplicaSecret - * (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination - * region. + * Specifies whether to overwrite a secret with the same name in the destination Region. */ public void setForceOverwriteReplicaSecret(Boolean forceOverwriteReplicaSecret) { @@ -170,11 +169,10 @@ public void setForceOverwriteReplicaSecret(Boolean forceOverwriteReplicaSecret) /** *- * (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
* - * @return (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination - * region. + * @return Specifies whether to overwrite a secret with the same name in the destination Region. */ public Boolean getForceOverwriteReplicaSecret() { @@ -183,12 +181,11 @@ public Boolean getForceOverwriteReplicaSecret() { /** *- * (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
* * @param forceOverwriteReplicaSecret - * (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination - * region. + * Specifies whether to overwrite a secret with the same name in the destination Region. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -199,11 +196,10 @@ public ReplicateSecretToRegionsRequest withForceOverwriteReplicaSecret(Boolean f /** *- * (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region. + * Specifies whether to overwrite a secret with the same name in the destination Region. *
* - * @return (Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination - * region. + * @return Specifies whether to overwrite a secret with the same name in the destination Region. */ public Boolean isForceOverwriteReplicaSecret() { diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicateSecretToRegionsResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicateSecretToRegionsResult.java index 138f39c7ff66..7daaecc7352d 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicateSecretToRegionsResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ReplicateSecretToRegionsResult.java @@ -25,27 +25,24 @@ public class ReplicateSecretToRegionsResult extends com.amazonaws.AmazonWebServi /** *
- * Replicate a secret based on the ReplicaRegionType
> consisting of a Region(required) and a
- * KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
+ * The ARN of the primary secret.
*
- * Describes the secret replication status as PENDING
, SUCCESS
or FAIL
.
+ * The status of replication.
*
- * Replicate a secret based on the ReplicaRegionType
> consisting of a Region(required) and a
- * KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
+ * The ARN of the primary secret.
*
ReplicaRegionType
> consisting of a Region(required) and a
- * KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
+ * The ARN of the primary secret.
*/
public void setARN(String aRN) {
@@ -54,12 +51,10 @@ public void setARN(String aRN) {
/**
*
- * Replicate a secret based on the ReplicaRegionType
> consisting of a Region(required) and a
- * KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
+ * The ARN of the primary secret.
*
ReplicaRegionType
> consisting of a Region(required) and a
- * KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
+ * @return The ARN of the primary secret.
*/
public String getARN() {
@@ -68,13 +63,11 @@ public String getARN() {
/**
*
- * Replicate a secret based on the ReplicaRegionType
> consisting of a Region(required) and a
- * KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
+ * The ARN of the primary secret.
*
ReplicaRegionType
> consisting of a Region(required) and a
- * KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
+ * The ARN of the primary secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -85,11 +78,10 @@ public ReplicateSecretToRegionsResult withARN(String aRN) {
/**
*
- * Describes the secret replication status as PENDING
, SUCCESS
or FAIL
.
+ * The status of replication.
*
PENDING
, SUCCESS
or
- * FAIL
.
+ * @return The status of replication.
*/
public java.util.List
- * Describes the secret replication status as PENDING
, SUCCESS
or FAIL
.
+ * The status of replication.
*
PENDING
, SUCCESS
or FAIL
- * .
+ * The status of replication.
*/
public void setReplicationStatus(java.util.Collection
- * Describes the secret replication status as PENDING
, SUCCESS
or FAIL
.
+ * The status of replication.
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -126,8 +117,7 @@ public void setReplicationStatus(java.util.Collection
PENDING
, SUCCESS
or FAIL
- * .
+ * The status of replication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -143,12 +133,11 @@ public ReplicateSecretToRegionsResult withReplicationStatus(ReplicationStatusTyp
/**
*
- * Describes the secret replication status as PENDING
, SUCCESS
or FAIL
.
+ * The status of replication.
*
PENDING
, SUCCESS
or FAIL
- * .
+ * The status of replication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ResourceNotFoundException.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ResourceNotFoundException.java
index 746f6bd0a137..f48b652fd69f 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ResourceNotFoundException.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ResourceNotFoundException.java
@@ -16,7 +16,7 @@
/**
* - * We can't find the resource that you asked for. + * Secrets Manager can't find the resource that you asked for. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RestoreSecretRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RestoreSecretRequest.java index 43c8be415d3d..244cd7468ed6 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RestoreSecretRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RestoreSecretRequest.java @@ -27,8 +27,7 @@ public class RestoreSecretRequest extends com.amazonaws.AmazonWebServiceRequest /** *- * Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to restore. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -38,16 +37,14 @@ public class RestoreSecretRequest extends com.amazonaws.AmazonWebServiceRequest /** *
- * Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to restore. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to restore. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -58,15 +55,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to restore. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret that you want to restore from a previously scheduled deletion. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or name of the secret to restore. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -77,16 +72,14 @@ public String getSecretId() { /** *
- * Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the - * Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to restore. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret to restore. *
* For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
* @return Returns a reference to this object so that method calls can be chained together.
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RestoreSecretResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RestoreSecretResult.java
index d37f87a83a90..67d951f1b971 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RestoreSecretResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RestoreSecretResult.java
@@ -31,7 +31,7 @@ public class RestoreSecretResult extends com.amazonaws.AmazonWebServiceResult
- * The friendly name of the secret that was restored. + * The name of the secret that was restored. *
* * @param name - * The friendly name of the secret that was restored. + * The name of the secret that was restored. */ public void setName(String name) { @@ -91,10 +91,10 @@ public void setName(String name) { /** *- * The friendly name of the secret that was restored. + * The name of the secret that was restored. *
* - * @return The friendly name of the secret that was restored. + * @return The name of the secret that was restored. */ public String getName() { @@ -103,11 +103,11 @@ public String getName() { /** *- * The friendly name of the secret that was restored. + * The name of the secret that was restored. *
* * @param name - * The friendly name of the secret that was restored. + * The name of the secret that was restored. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RotateSecretRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RotateSecretRequest.java index 3146bc6307dd..21af5b8582de 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RotateSecretRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RotateSecretRequest.java @@ -27,8 +27,7 @@ public class RotateSecretRequest extends com.amazonaws.AmazonWebServiceRequest i /** *- * Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret to rotate. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -37,7 +36,9 @@ public class RotateSecretRequest extends com.amazonaws.AmazonWebServiceRequest i private String secretId; /** *
- * (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
+ * A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this
+ * value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation.
+ * This value becomes the VersionId
of the new version.
*
* If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can @@ -47,20 +48,16 @@ public class RotateSecretRequest extends com.amazonaws.AmazonWebServiceRequest i * value in the request. *
*- * You only need to specify your own value if you implement your own retry logic and want to ensure that a given - * secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within * the specified secret. *
- *
- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures
- * and retries during the function's processing. This value becomes the VersionId
of the new version.
- *
- * (Optional) Specifies the ARN of the Lambda function that can rotate the secret. + * The ARN of the Lambda rotation function that can rotate the secret. *
*/ private String rotationLambdaARN; @@ -73,16 +70,14 @@ public class RotateSecretRequest extends com.amazonaws.AmazonWebServiceRequest i /** *- * Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret to rotate. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret to rotate. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -93,15 +88,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret to rotate. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or - * the friendly name of the secret. + * @return The ARN or name of the secret to rotate. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -112,16 +105,14 @@ public String getSecretId() { /** *
- * Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret to rotate. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the - * friendly name of the secret. + * The ARN or name of the secret to rotate. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -134,7 +125,9 @@ public RotateSecretRequest withSecretId(String secretId) { /** *
- * (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
+ * A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this
+ * value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation.
+ * This value becomes the VersionId
of the new version.
*
* If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can @@ -144,19 +137,16 @@ public RotateSecretRequest withSecretId(String secretId) { * value in the request. *
*- * You only need to specify your own value if you implement your own retry logic and want to ensure that a given - * secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within * the specified secret. *
- *
- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures
- * and retries during the function's processing. This value becomes the VersionId
of the new version.
- *
VersionId
of the new version.
* * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in @@ -165,15 +155,10 @@ public RotateSecretRequest withSecretId(String secretId) { * new versions and include that value in the request. *
*- * You only need to specify your own value if you implement your own retry logic and want to ensure that a - * given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness * within the specified secret. - *
- *
- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are
- * failures and retries during the function's processing. This value becomes the VersionId
of
- * the new version.
*/
public void setClientRequestToken(String clientRequestToken) {
@@ -182,7 +167,9 @@ public void setClientRequestToken(String clientRequestToken) {
/**
*
- * (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
+ * A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this
+ * value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation.
+ * This value becomes the VersionId
of the new version.
*
* If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can @@ -192,18 +179,15 @@ public void setClientRequestToken(String clientRequestToken) { * value in the request. *
*- * You only need to specify your own value if you implement your own retry logic and want to ensure that a given - * secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within * the specified secret. *
- *
- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures
- * and retries during the function's processing. This value becomes the VersionId
of the new version.
- *
VersionId
of the new version.
* * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in @@ -212,15 +196,10 @@ public void setClientRequestToken(String clientRequestToken) { * new versions and include that value in the request. *
*- * You only need to specify your own value if you implement your own retry logic and want to ensure that a - * given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness * within the specified secret. - *
- *
- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are
- * failures and retries during the function's processing. This value becomes the VersionId
of
- * the new version.
*/
public String getClientRequestToken() {
@@ -229,7 +208,9 @@ public String getClientRequestToken() {
/**
*
- * (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.
+ * A unique identifier for the new version of the secret that helps ensure idempotency. Secrets Manager uses this
+ * value to prevent the accidental creation of duplicate versions if there are failures and retries during rotation.
+ * This value becomes the VersionId
of the new version.
*
* If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can @@ -239,19 +220,16 @@ public String getClientRequestToken() { * value in the request. *
*- * You only need to specify your own value if you implement your own retry logic and want to ensure that a given - * secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within * the specified secret. *
- *
- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures
- * and retries during the function's processing. This value becomes the VersionId
of the new version.
- *
VersionId
of the new version.
* * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in @@ -260,15 +238,10 @@ public String getClientRequestToken() { * new versions and include that value in the request. *
*- * You only need to specify your own value if you implement your own retry logic and want to ensure that a - * given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness * within the specified secret. - *
- *
- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are
- * failures and retries during the function's processing. This value becomes the VersionId
of
- * the new version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@@ -279,11 +252,11 @@ public RotateSecretRequest withClientRequestToken(String clientRequestToken) {
/**
*
- * (Optional) Specifies the ARN of the Lambda function that can rotate the secret. + * The ARN of the Lambda rotation function that can rotate the secret. *
* * @param rotationLambdaARN - * (Optional) Specifies the ARN of the Lambda function that can rotate the secret. + * The ARN of the Lambda rotation function that can rotate the secret. */ public void setRotationLambdaARN(String rotationLambdaARN) { @@ -292,10 +265,10 @@ public void setRotationLambdaARN(String rotationLambdaARN) { /** *- * (Optional) Specifies the ARN of the Lambda function that can rotate the secret. + * The ARN of the Lambda rotation function that can rotate the secret. *
* - * @return (Optional) Specifies the ARN of the Lambda function that can rotate the secret. + * @return The ARN of the Lambda rotation function that can rotate the secret. */ public String getRotationLambdaARN() { @@ -304,11 +277,11 @@ public String getRotationLambdaARN() { /** *- * (Optional) Specifies the ARN of the Lambda function that can rotate the secret. + * The ARN of the Lambda rotation function that can rotate the secret. *
* * @param rotationLambdaARN - * (Optional) Specifies the ARN of the Lambda function that can rotate the secret. + * The ARN of the Lambda rotation function that can rotate the secret. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RotateSecretResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RotateSecretResult.java index 9b653173e335..dd611970e4f3 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RotateSecretResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/RotateSecretResult.java @@ -31,13 +31,13 @@ public class RotateSecretResult extends com.amazonaws.AmazonWebServiceResult- * The ID of the new version of the secret created by the rotation started by this request. + * The ID of the new version of the secret. *
*/ private String versionId; @@ -84,11 +84,11 @@ public RotateSecretResult withARN(String aRN) { /** *- * The friendly name of the secret. + * The name of the secret. *
* * @param name - * The friendly name of the secret. + * The name of the secret. */ public void setName(String name) { @@ -97,10 +97,10 @@ public void setName(String name) { /** *- * The friendly name of the secret. + * The name of the secret. *
* - * @return The friendly name of the secret. + * @return The name of the secret. */ public String getName() { @@ -109,11 +109,11 @@ public String getName() { /** *- * The friendly name of the secret. + * The name of the secret. *
* * @param name - * The friendly name of the secret. + * The name of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -124,11 +124,11 @@ public RotateSecretResult withName(String name) { /** *- * The ID of the new version of the secret created by the rotation started by this request. + * The ID of the new version of the secret. *
* * @param versionId - * The ID of the new version of the secret created by the rotation started by this request. + * The ID of the new version of the secret. */ public void setVersionId(String versionId) { @@ -137,10 +137,10 @@ public void setVersionId(String versionId) { /** *- * The ID of the new version of the secret created by the rotation started by this request. + * The ID of the new version of the secret. *
* - * @return The ID of the new version of the secret created by the rotation started by this request. + * @return The ID of the new version of the secret. */ public String getVersionId() { @@ -149,11 +149,11 @@ public String getVersionId() { /** *- * The ID of the new version of the secret created by the rotation started by this request. + * The ID of the new version of the secret. *
* * @param versionId - * The ID of the new version of the secret created by the rotation started by this request. + * The ID of the new version of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/SecretListEntry.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/SecretListEntry.java index a56e80a2f374..5a91aa713c84 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/SecretListEntry.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/SecretListEntry.java @@ -33,11 +33,6 @@ public class SecretListEntry implements Serializable, Cloneable, StructuredPojo ** The Amazon Resource Name (ARN) of the secret. *
- *- * For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide. - *
*/ private String aRN; /** @@ -56,10 +51,8 @@ public class SecretListEntry implements Serializable, Cloneable, StructuredPojo private String description; /** *
- * The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the
- * SecretString
and SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key
- * named awssecretsmanager
, for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the
+ * Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*
* The Amazon Resource Name (ARN) of the secret. *
- *- * For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide. - *
* * @param aRN - * The Amazon Resource Name (ARN) of the secret. - *- * For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide. + * The Amazon Resource Name (ARN) of the secret. */ public void setARN(String aRN) { @@ -176,17 +160,8 @@ public void setARN(String aRN) { *
* The Amazon Resource Name (ARN) of the secret. *
- *- * For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide. - *
* - * @return The Amazon Resource Name (ARN) of the secret. - *- * For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide. + * @return The Amazon Resource Name (ARN) of the secret. */ public String getARN() { @@ -197,18 +172,9 @@ public String getARN() { *
* The Amazon Resource Name (ARN) of the secret. *
- *- * For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide. - *
* * @param aRN - * The Amazon Resource Name (ARN) of the secret. - *- * For more information about ARNs in Secrets Manager, see Policy Resources in the Amazon Web Services Secrets Manager User Guide. + * The Amazon Resource Name (ARN) of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -311,17 +277,13 @@ public SecretListEntry withDescription(String description) { /** *
- * The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the
- * SecretString
and SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key
- * named awssecretsmanager
, for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the
+ * Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*
SecretString
and SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the
- * key named awssecretsmanager
, for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted
+ * with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*/
public void setKmsKeyId(String kmsKeyId) {
@@ -330,16 +292,12 @@ public void setKmsKeyId(String kmsKeyId) {
/**
*
- * The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the
- * SecretString
and SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key
- * named awssecretsmanager
, for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the
+ * Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*
SecretString
and SecretBinary
fields in each version of the secret. If you
- * don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS
- * CMK, the key named awssecretsmanager
, for this account.
+ * @return The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted
+ * with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*/
public String getKmsKeyId() {
@@ -348,17 +306,13 @@ public String getKmsKeyId() {
/**
*
- * The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the
- * SecretString
and SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key
- * named awssecretsmanager
, for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with the
+ * Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
*
SecretString
and SecretBinary
fields in each version of the secret. If you don't
- * provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the
- * key named awssecretsmanager
, for this account.
+ * The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted
+ * with the Amazon Web Services managed key aws/secretsmanager
, this field is omitted.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/StopReplicationToReplicaRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/StopReplicationToReplicaRequest.java
index 790e0679d99d..1d9613c45609 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/StopReplicationToReplicaRequest.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/StopReplicationToReplicaRequest.java
@@ -27,18 +27,18 @@ public class StopReplicationToReplicaRequest extends com.amazonaws.AmazonWebServ
/**
*
- * Response to StopReplicationToReplica
of a secret, based on the SecretId
.
+ * The ARN of the primary secret.
*
- * Response to StopReplicationToReplica
of a secret, based on the SecretId
.
+ * The ARN of the primary secret.
*
StopReplicationToReplica
of a secret, based on the SecretId
.
+ * The ARN of the primary secret.
*/
public void setSecretId(String secretId) {
@@ -47,10 +47,10 @@ public void setSecretId(String secretId) {
/**
*
- * Response to StopReplicationToReplica
of a secret, based on the SecretId
.
+ * The ARN of the primary secret.
*
StopReplicationToReplica
of a secret, based on the SecretId
.
+ * @return The ARN of the primary secret.
*/
public String getSecretId() {
@@ -59,11 +59,11 @@ public String getSecretId() {
/**
*
- * Response to StopReplicationToReplica
of a secret, based on the SecretId
.
+ * The ARN of the primary secret.
*
StopReplicationToReplica
of a secret, based on the SecretId
.
+ * The ARN of the primary secret.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/StopReplicationToReplicaResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/StopReplicationToReplicaResult.java
index 92a46ca1a41b..90d7f17e147e 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/StopReplicationToReplicaResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/StopReplicationToReplicaResult.java
@@ -25,18 +25,19 @@ public class StopReplicationToReplicaResult extends com.amazonaws.AmazonWebServi
/**
*
- * Response StopReplicationToReplica
of a secret, based on the ARN,
.
+ * The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
*
- * Response StopReplicationToReplica
of a secret, based on the ARN,
.
+ * The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
*
StopReplicationToReplica
of a secret, based on the ARN,
.
+ * The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is
+ * changed.
*/
public void setARN(String aRN) {
@@ -45,10 +46,11 @@ public void setARN(String aRN) {
/**
*
- * Response StopReplicationToReplica
of a secret, based on the ARN,
.
+ * The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
*
StopReplicationToReplica
of a secret, based on the ARN,
.
+ * @return The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is
+ * changed.
*/
public String getARN() {
@@ -57,11 +59,12 @@ public String getARN() {
/**
*
- * Response StopReplicationToReplica
of a secret, based on the ARN,
.
+ * The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
*
StopReplicationToReplica
of a secret, based on the ARN,
.
+ * The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is
+ * changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/TagResourceRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/TagResourceRequest.java
index 9464d12f3c92..7d87549b1909 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/TagResourceRequest.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/TagResourceRequest.java
@@ -27,8 +27,8 @@ public class TagResourceRequest extends com.amazonaws.AmazonWebServiceRequest im
/**
* - * The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the + * friendly name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -37,11 +37,8 @@ public class TagResourceRequest extends com.amazonaws.AmazonWebServiceRequest im private String secretId; /** *
- * The tags to attach to the secret. Each element in the list consists of a Key
and a
- * Value
.
- *
- * This parameter to the API requires a JSON text string argument.
+ * The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a
+ * Key
and a Value
.
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. @@ -54,16 +51,16 @@ public class TagResourceRequest extends com.amazonaws.AmazonWebServiceRequest im /** *
- * The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the + * friendly name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource - * Name (ARN) or the friendly name of the secret. + * The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or + * the friendly name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -74,15 +71,15 @@ public void setSecretId(String secretId) { /** *
- * The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the + * friendly name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource - * Name (ARN) or the friendly name of the secret. + * @return The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or + * the friendly name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -93,16 +90,16 @@ public String getSecretId() { /** *
- * The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or the + * friendly name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource - * Name (ARN) or the friendly name of the secret. + * The identifier for the secret to attach tags to. You can specify either the Amazon Resource Name (ARN) or + * the friendly name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -115,11 +112,8 @@ public TagResourceRequest withSecretId(String secretId) { /** *
- * The tags to attach to the secret. Each element in the list consists of a Key
and a
- * Value
.
- *
- * This parameter to the API requires a JSON text string argument.
+ * The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a
+ * Key
and a Value
.
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. @@ -128,11 +122,8 @@ public TagResourceRequest withSecretId(String secretId) { * the Amazon Web Services CLI
Key
and a
- * Value
.
- * - * This parameter to the API requires a JSON text string argument. - *
+ * @return The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a + *Key
and a Value
.
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value
* pairs. For more information, see getTags() {
/**
*
- * The tags to attach to the secret. Each element in the list consists of a
- * This parameter to the API requires a JSON text string argument.
+ * The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a
+ *
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs.
@@ -160,11 +148,8 @@ public java.util.ListKey
and a
- * Value
.
- * Key
and a Value
.
* Key
and a
- * Value
.
- * This parameter to the API requires a JSON text string argument. - *
+ * The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a + *Key
and a Value
.
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value
* pairs. For more information, see tags) {
/**
*
- * The tags to attach to the secret. Each element in the list consists of a
- * This parameter to the API requires a JSON text string argument.
+ * The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a
+ *
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs.
@@ -202,11 +184,8 @@ public void setTags(java.util.CollectionKey
and a
- * Value
.
- * Key
and a Value
.
* Key
and a
- * Value
.
- * This parameter to the API requires a JSON text string argument. - *
+ * The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a + *Key
and a Value
.
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value
* pairs. For more information, see
- * The tags to attach to the secret. Each element in the list consists of a Key
and a
- * Value
.
- *
- * This parameter to the API requires a JSON text string argument.
+ * The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a
+ * Key
and a Value
.
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. @@ -241,11 +217,8 @@ public TagResourceRequest withTags(Tag... tags) { *
* * @param tags - * The tags to attach to the secret. Each element in the list consists of aKey
and a
- * Value
.
- * - * This parameter to the API requires a JSON text string argument. - *
+ * The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a + *Key
and a Value
.
* * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value * pairs. For more information, see - * The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -41,7 +40,7 @@ public class UntagResourceRequest extends com.amazonaws.AmazonWebServiceRequest * value are removed. *
*- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
** For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. @@ -54,16 +53,14 @@ public class UntagResourceRequest extends com.amazonaws.AmazonWebServiceRequest /** *
- * The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * The identifier for the secret that you want to remove tags from. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -74,15 +71,13 @@ public void setSecretId(String secretId) { /** *
- * The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return The identifier for the secret that you want to remove tags from. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -93,16 +88,14 @@ public String getSecretId() { /** *
- * The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name - * (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * The identifier for the secret that you want to remove tags from. You can specify either the Amazon - * Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -119,7 +112,7 @@ public UntagResourceRequest withSecretId(String secretId) { * value are removed. *
*- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
** For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. @@ -131,7 +124,7 @@ public UntagResourceRequest withSecretId(String secretId) { * @return A list of tag key names to remove from the secret. You don't specify the value. Both the key and its * associated value are removed.
*- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value
@@ -150,7 +143,7 @@ public java.util.List
- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs.
@@ -163,7 +156,7 @@ public java.util.List
- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value
@@ -187,7 +180,7 @@ public void setTagKeys(java.util.Collection
- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
*
* For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs.
@@ -205,7 +198,7 @@ public void setTagKeys(java.util.Collection
- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
** For storing multiple values, we recommend that you use a JSON text string argument and specify key/value @@ -231,7 +224,7 @@ public UntagResourceRequest withTagKeys(String... tagKeys) { * value are removed. *
*- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
** For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. @@ -244,7 +237,7 @@ public UntagResourceRequest withTagKeys(String... tagKeys) { * A list of tag key names to remove from the secret. You don't specify the value. Both the key and its * associated value are removed.
*- * This parameter to the API requires a JSON text string argument. + * This parameter requires a JSON text string argument. *
** For storing multiple values, we recommend that you use a JSON text string argument and specify key/value diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretRequest.java index a77ddf9bba4b..0eb843a51ced 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretRequest.java @@ -27,8 +27,7 @@ public class UpdateSecretRequest extends com.amazonaws.AmazonWebServiceRequest i /** *
- * Specifies the secret that you want to modify or to which you want to add a new version. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -37,47 +36,18 @@ public class UpdateSecretRequest extends com.amazonaws.AmazonWebServiceRequest i private String secretId; /** *
- * (Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the
- * new version that helps ensure idempotency.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version
+ * for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If
- * you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you
- * must generate a ClientRequestToken
yourself for new versions and include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for
+ * this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
+ * Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version
+ * and include the value in the request.
*
- * You typically only need to interact with this value if you implement your own retry logic and want to ensure that - * a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within - * the specified secret. - *
- *- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures - * and retries during the Lambda rotation function's processing. - *
- *
- * If the ClientRequestToken
value isn't already associated with a version of the secret then a new
- * version of the secret is created.
- *
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are the same as those in the request then the request is ignored (the operation
- * is idempotent).
- *
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are different from the request then an error occurs because you cannot modify an
- * existing secret value.
- *
* This value becomes the VersionId
of the new version.
*
- * (Optional) Specifies an updated user-provided description of the secret. + * The description of the secret. *
*/ private String description; /** *
- * (Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that
- * Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing
- * versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information
- * about staging labels, see Staging
- * Labels in the Amazon Web Services Secrets Manager User Guide.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any
+ * existing versions the staging labels AWSCURRENT
, AWSPENDING
, or
+ * AWSPREVIOUS
. For more information about versions and staging labels, see Concepts:
+ * Version.
*
- * You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials
- * from the same account that owns the secret. If the secret is in a different account, then you must create a
- * custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both
- * the secret and the CMK in their respective accounts.
+ * You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation
+ * using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different
+ * account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user
+ * making the call must have permissions to both the secret and the KMS key in their respective accounts.
*
- * (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To
- * use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use
- * the appropriate technique for your tool to pass the contents of the file as a parameter. Either
- * SecretBinary
or SecretString
must have a value, but not both. They cannot both be
- * empty.
+ * The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary
+ * data in a file and then pass the contents of the file as a parameter.
*
- * This parameter is not accessible using the Secrets Manager console.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
+ *
+ * You can't access this parameter in the Secrets Manager console. *
*/ private java.nio.ByteBuffer secretBinary; /** *
- * (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret.
- * Either SecretBinary
or SecretString
must have a value, but not both. They cannot both
- * be empty.
+ * The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of
+ * key/value pairs for your secret value.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret
- * text in only the SecretString
parameter. The Secrets Manager console stores the information as a
- * JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs.
- * For more information, see Specifying parameter values for
- * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
*
- * Specifies the secret that you want to modify or to which you want to add a new version. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to modify or to which you want to add a new version. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -163,15 +121,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret that you want to modify or to which you want to add a new version. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret that you want to modify or to which you want to add a new version. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -182,16 +138,14 @@ public String getSecretId() { /** *
- * Specifies the secret that you want to modify or to which you want to add a new version. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret that you want to modify or to which you want to add a new version. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or name of the secret. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -204,93 +158,33 @@ public UpdateSecretRequest withSecretId(String secretId) { /** *
- * (Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the - * new version that helps ensure idempotency. - *
- *
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If
- * you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you
- * must generate a ClientRequestToken
yourself for new versions and include that value in the request.
- *
- * You typically only need to interact with this value if you implement your own retry logic and want to ensure that - * a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within - * the specified secret. - *
- *- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures - * and retries during the Lambda rotation function's processing. - *
- *
- * If the ClientRequestToken
value isn't already associated with a version of the secret then a new
- * version of the secret is created.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version
+ * for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are the same as those in the request then the request is ignored (the operation
- * is idempotent).
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for
+ * this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
+ * Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version
+ * and include the value in the request.
*
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are different from the request then an error occurs because you cannot modify an
- * existing secret value.
- *
* This value becomes the VersionId
of the new version.
*
SecretString
or SecretBinary
, then Secrets Manager creates a new
+ * version for the secret, and this parameter specifies the unique identifier for the new version.
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
- * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in
- * the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for new versions and
- * include that value in the request.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then
+ * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the
+ * value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request
+ * to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself
+ * for the new version and include the value in the request.
*
- * You typically only need to interact with this value if you implement your own retry logic and want to - * ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness - * within the specified secret. - *
- *- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are - * failures and retries during the Lambda rotation function's processing. - *
- *
- * If the ClientRequestToken
value isn't already associated with a version of the secret then a
- * new version of the secret is created.
- *
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are the same as those in the request then the request is ignored (the
- * operation is idempotent).
- *
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are different from the request then an error occurs because you cannot
- * modify an existing secret value.
- *
* This value becomes the VersionId
of the new version.
*/
@@ -301,92 +195,33 @@ public void setClientRequestToken(String clientRequestToken) {
/**
*
- * (Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the - * new version that helps ensure idempotency. - *
- *
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If
- * you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you
- * must generate a ClientRequestToken
yourself for new versions and include that value in the request.
- *
- * You typically only need to interact with this value if you implement your own retry logic and want to ensure that - * a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within - * the specified secret. - *
- *- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures - * and retries during the Lambda rotation function's processing. - *
- *
- * If the ClientRequestToken
value isn't already associated with a version of the secret then a new
- * version of the secret is created.
- *
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are the same as those in the request then the request is ignored (the operation
- * is idempotent).
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version
+ * for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are different from the request then an error occurs because you cannot modify an
- * existing secret value.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for
+ * this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
+ * Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version
+ * and include the value in the request.
*
* This value becomes the VersionId
of the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
- * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in
- * the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for new versions and
- * include that value in the request.
- *
- * You typically only need to interact with this value if you implement your own retry logic and want to - * ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness - * within the specified secret. - *
- *- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are - * failures and retries during the Lambda rotation function's processing. - *
- *
- * If the ClientRequestToken
value isn't already associated with a version of the secret then a
- * new version of the secret is created.
- *
SecretString
or SecretBinary
, then Secrets Manager creates a new
+ * version for the secret, and this parameter specifies the unique identifier for the new version.
+ *
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are the same as those in the request then the request is ignored (the
- * operation is idempotent).
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation,
+ * then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it
+ * as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP
+ * request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
+ * yourself for the new version and include the value in the request.
*
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are different from the request then an error occurs because you cannot
- * modify an existing secret value.
- *
* This value becomes the VersionId
of the new version.
*/
@@ -397,93 +232,33 @@ public String getClientRequestToken() {
/**
*
- * (Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the - * new version that helps ensure idempotency. - *
- *
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can
- * leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If
- * you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you
- * must generate a ClientRequestToken
yourself for new versions and include that value in the request.
- *
- * You typically only need to interact with this value if you implement your own retry logic and want to ensure that - * a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within - * the specified secret. - *
- *- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures - * and retries during the Lambda rotation function's processing. - *
- *
- * If the ClientRequestToken
value isn't already associated with a version of the secret then a new
- * version of the secret is created.
+ * If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version
+ * for the secret, and this parameter specifies the unique identifier for the new version.
*
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are the same as those in the request then the request is ignored (the operation
- * is idempotent).
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you
+ * can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for
+ * this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets
+ * Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version
+ * and include the value in the request.
*
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are different from the request then an error occurs because you cannot modify an
- * existing secret value.
- *
* This value becomes the VersionId
of the new version.
*
- * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then
- * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in
- * the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager
- * service endpoint, then you must generate a ClientRequestToken
yourself for new versions and
- * include that value in the request.
- *
- * You typically only need to interact with this value if you implement your own retry logic and want to - * ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness - * within the specified secret. - *
- *- * Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are - * failures and retries during the Lambda rotation function's processing. - *
- *
- * If the ClientRequestToken
value isn't already associated with a version of the secret then a
- * new version of the secret is created.
- *
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are the same as those in the request then the request is ignored (the
- * operation is idempotent).
- *
SecretString
or SecretBinary
, then Secrets Manager creates a new
+ * version for the secret, and this parameter specifies the unique identifier for the new version.
- * If a version with this value already exists and that version's SecretString
and
- * SecretBinary
values are different from the request then an error occurs because you cannot
- * modify an existing secret value.
+ * If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then
+ * you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the
+ * value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request
+ * to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself
+ * for the new version and include the value in the request.
*
* This value becomes the VersionId
of the new version.
* @return Returns a reference to this object so that method calls can be chained together.
@@ -496,11 +271,11 @@ public UpdateSecretRequest withClientRequestToken(String clientRequestToken) {
/**
*
- * (Optional) Specifies an updated user-provided description of the secret. + * The description of the secret. *
* * @param description - * (Optional) Specifies an updated user-provided description of the secret. + * The description of the secret. */ public void setDescription(String description) { @@ -509,10 +284,10 @@ public void setDescription(String description) { /** *- * (Optional) Specifies an updated user-provided description of the secret. + * The description of the secret. *
* - * @return (Optional) Specifies an updated user-provided description of the secret. + * @return The description of the secret. */ public String getDescription() { @@ -521,11 +296,11 @@ public String getDescription() { /** *- * (Optional) Specifies an updated user-provided description of the secret. + * The description of the secret. *
* * @param description - * (Optional) Specifies an updated user-provided description of the secret. + * The description of the secret. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -536,34 +311,33 @@ public UpdateSecretRequest withDescription(String description) { /** *
- * (Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that
- * Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing
- * versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information
- * about staging labels, see Staging
- * Labels in the Amazon Web Services Secrets Manager User Guide.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any
+ * existing versions the staging labels AWSCURRENT
, AWSPENDING
, or
+ * AWSPREVIOUS
. For more information about versions and staging labels, see Concepts:
+ * Version.
*
- * You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials
- * from the same account that owns the secret. If the secret is in a different account, then you must create a
- * custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both
- * the secret and the CMK in their respective accounts.
+ * You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation
+ * using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different
+ * account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user
+ * making the call must have permissions to both the secret and the KMS key in their respective accounts.
*
AWSCURRENT
, AWSPENDING
, or
+ * AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
- * You can only use the account's default CMK to encrypt and decrypt if you call this operation using
- * credentials from the same account that owns the secret. If the secret is in a different account, then you
- * must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have
- * permissions to both the secret and the CMK in their respective accounts.
+ * You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this
+ * operation using credentials from the same Amazon Web Services account that owns the secret. If the secret
+ * is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in
+ * this field. The user making the call must have permissions to both the secret and the KMS key in their
+ * respective accounts.
*
- * (Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that
- * Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing
- * versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information
- * about staging labels, see Staging
- * Labels in the Amazon Web Services Secrets Manager User Guide.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any
+ * existing versions the staging labels AWSCURRENT
, AWSPENDING
, or
+ * AWSPREVIOUS
. For more information about versions and staging labels, see Concepts:
+ * Version.
*
- * You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials
- * from the same account that owns the secret. If the secret is in a different account, then you must create a
- * custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both
- * the secret and the CMK in their respective accounts.
+ * You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation
+ * using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different
+ * account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user
+ * making the call must have permissions to both the secret and the KMS key in their respective accounts.
*
AWSCURRENT
, AWSPENDING
, or
+ * AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
- * You can only use the account's default CMK to encrypt and decrypt if you call this operation using
- * credentials from the same account that owns the secret. If the secret is in a different account, then you
- * must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must
- * have permissions to both the secret and the CMK in their respective accounts.
+ * You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this
+ * operation using credentials from the same Amazon Web Services account that owns the secret. If the secret
+ * is in a different account, then you must use a customer managed key and provide the ARN of that KMS key
+ * in this field. The user making the call must have permissions to both the secret and the KMS key in their
+ * respective accounts.
*
- * (Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that
- * Secrets Manager uses to encrypt the protected text in new versions of this secret as well as any existing
- * versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information
- * about staging labels, see Staging
- * Labels in the Amazon Web Services Secrets Manager User Guide.
+ * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any
+ * existing versions the staging labels AWSCURRENT
, AWSPENDING
, or
+ * AWSPREVIOUS
. For more information about versions and staging labels, see Concepts:
+ * Version.
*
- * You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials
- * from the same account that owns the secret. If the secret is in a different account, then you must create a
- * custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both
- * the secret and the CMK in their respective accounts.
+ * You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this operation
+ * using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different
+ * account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user
+ * making the call must have permissions to both the secret and the KMS key in their respective accounts.
*
AWSCURRENT
, AWSPENDING
, or
+ * AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
- * You can only use the account's default CMK to encrypt and decrypt if you call this operation using
- * credentials from the same account that owns the secret. If the secret is in a different account, then you
- * must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have
- * permissions to both the secret and the CMK in their respective accounts.
+ * You can only use the Amazon Web Services managed key aws/secretsmanager
if you call this
+ * operation using credentials from the same Amazon Web Services account that owns the secret. If the secret
+ * is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in
+ * this field. The user making the call must have permissions to both the secret and the KMS key in their
+ * respective accounts.
*
- * (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To
- * use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use
- * the appropriate technique for your tool to pass the contents of the file as a parameter. Either
- * SecretBinary
or SecretString
must have a value, but not both. They cannot both be
- * empty.
+ * The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary
+ * data in a file and then pass the contents of the file as a parameter.
*
- * This parameter is not accessible using the Secrets Manager console.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
+ *
+ * You can't access this parameter in the Secrets Manager console. *
** The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. @@ -669,13 +441,13 @@ public UpdateSecretRequest withKmsKeyId(String kmsKeyId) { *
* * @param secretBinary - * (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the - * secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a - * file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. - * EitherSecretBinary
or SecretString
must have a value, but not both. They cannot
- * both be empty.
+ * The binary data to encrypt and store in the new version of the secret. We recommend that you store your
+ * binary data in a file and then pass the contents of the file as a parameter.
+ *
+ * Either SecretBinary
or SecretString
must have a value, but not both.
+ *
- * This parameter is not accessible using the Secrets Manager console. + * You can't access this parameter in the Secrets Manager console. */ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { @@ -684,14 +456,14 @@ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { /** *
- * (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To
- * use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use
- * the appropriate technique for your tool to pass the contents of the file as a parameter. Either
- * SecretBinary
or SecretString
must have a value, but not both. They cannot both be
- * empty.
+ * The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary
+ * data in a file and then pass the contents of the file as a parameter.
+ *
+ * Either SecretBinary
or SecretString
must have a value, but not both.
*
- * This parameter is not accessible using the Secrets Manager console. + * You can't access this parameter in the Secrets Manager console. *
** {@code ByteBuffer}s are stateful. Calling their {@code get} methods changes their {@code position}. We recommend @@ -701,13 +473,13 @@ public void setSecretBinary(java.nio.ByteBuffer secretBinary) { * {@code position}. *
* - * @return (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the - * secret. To use this parameter in the command-line tools, we recommend that you store your binary data in - * a file and then use the appropriate technique for your tool to pass the contents of the file as a - * parameter. EitherSecretBinary
or SecretString
must have a value, but not both.
- * They cannot both be empty.
+ * @return The binary data to encrypt and store in the new version of the secret. We recommend that you store your
+ * binary data in a file and then pass the contents of the file as a parameter.
*
- * This parameter is not accessible using the Secrets Manager console.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
+ *
+ * You can't access this parameter in the Secrets Manager console. */ public java.nio.ByteBuffer getSecretBinary() { @@ -716,14 +488,14 @@ public java.nio.ByteBuffer getSecretBinary() { /** *
- * (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To
- * use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use
- * the appropriate technique for your tool to pass the contents of the file as a parameter. Either
- * SecretBinary
or SecretString
must have a value, but not both. They cannot both be
- * empty.
+ * The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary
+ * data in a file and then pass the contents of the file as a parameter.
+ *
+ * Either SecretBinary
or SecretString
must have a value, but not both.
*
- * This parameter is not accessible using the Secrets Manager console. + * You can't access this parameter in the Secrets Manager console. *
** The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. @@ -737,13 +509,13 @@ public java.nio.ByteBuffer getSecretBinary() { *
* * @param secretBinary - * (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the - * secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a - * file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. - * EitherSecretBinary
or SecretString
must have a value, but not both. They cannot
- * both be empty.
+ * The binary data to encrypt and store in the new version of the secret. We recommend that you store your
+ * binary data in a file and then pass the contents of the file as a parameter.
+ *
+ * Either SecretBinary
or SecretString
must have a value, but not both.
+ *
- * This parameter is not accessible using the Secrets Manager console. + * You can't access this parameter in the Secrets Manager console. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -754,37 +526,18 @@ public UpdateSecretRequest withSecretBinary(java.nio.ByteBuffer secretBinary) { /** *
- * (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret.
- * Either SecretBinary
or SecretString
must have a value, but not both. They cannot both
- * be empty.
+ * The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of
+ * key/value pairs for your secret value.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret
- * text in only the SecretString
parameter. The Secrets Manager console stores the information as a
- * JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs.
- * For more information, see Specifying parameter values for
- * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
*
SecretBinary
or SecretString
must have a value, but not both.
- * They cannot both be empty.
- *
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected
- * secret text in only the SecretString
parameter. The Secrets Manager console stores the
- * information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to
- * parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value
- * pairs. For more information, see Specifying parameter
- * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
*/
public void setSecretString(String secretString) {
@@ -793,36 +546,17 @@ public void setSecretString(String secretString) {
/**
*
- * (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret.
- * Either SecretBinary
or SecretString
must have a value, but not both. They cannot both
- * be empty.
- *
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret
- * text in only the SecretString
parameter. The Secrets Manager console stores the information as a
- * JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
+ * The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of
+ * key/value pairs for your secret value.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs.
- * For more information, see Specifying parameter values for
- * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
*
SecretBinary
or SecretString
must have a value, but not both.
- * They cannot both be empty.
+ * @return The text data to encrypt and store in the new version of the secret. We recommend you use a JSON
+ * structure of key/value pairs for your secret value.
*
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected
- * secret text in only the SecretString
parameter. The Secrets Manager console stores the
- * information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to
- * parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value
- * pairs. For more information, see Specifying parameter
- * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
*/
public String getSecretString() {
@@ -831,37 +565,18 @@ public String getSecretString() {
/**
*
- * (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret.
- * Either SecretBinary
or SecretString
must have a value, but not both. They cannot both
- * be empty.
- *
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret
- * text in only the SecretString
parameter. The Secrets Manager console stores the information as a
- * JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.
+ * The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of
+ * key/value pairs for your secret value.
*
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs.
- * For more information, see Specifying parameter values for
- * the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
*
SecretBinary
or SecretString
must have a value, but not both.
- * They cannot both be empty.
- *
- * If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected
- * secret text in only the SecretString
parameter. The Secrets Manager console stores the
- * information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to
- * parse.
- *
- * For storing multiple values, we recommend that you use a JSON text string argument and specify key/value
- * pairs. For more information, see Specifying parameter
- * values for the Amazon Web Services CLI in the Amazon Web Services CLI User Guide.
+ * Either SecretBinary
or SecretString
must have a value, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretResult.java
index a5f0e2e737d9..b3cd628292f1 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretResult.java
@@ -27,26 +27,18 @@ public class UpdateSecretResult extends com.amazonaws.AmazonWebServiceResult
- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. - *
- *- * The friendly name of the secret that was updated. + * The name of the secret that was updated. *
*/ private String name; /** *
- * If a new version of the secret was created by this operation, then VersionId
contains the unique
- * identifier of the new version.
+ * If Secrets Manager created a new version of the secret during this operation, then VersionId
+ * contains the unique identifier of the new version.
*
- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs are - * different. - *
+ * The ARN of the secret that was updated. */ public void setARN(String aRN) { @@ -83,23 +60,8 @@ public void setARN(String aRN) { ** The ARN of the secret that was updated. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs - * are different. - *
+ * @return The ARN of the secret that was updated. */ public String getARN() { @@ -110,24 +72,9 @@ public String getARN() { ** The ARN of the secret that was updated. *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially - * create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a - * new secret with the same name as an old secret that you previously deleted, then users with access to the old - * secret don't automatically get access to the new secret because the ARNs are different. - *
- *- * Secrets Manager automatically adds several random characters to the name at the end of the ARN when you - * initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that - * if you create a new secret with the same name as an old secret that you previously deleted, then users - * with access to the old secret don't automatically get access to the new secret because the ARNs are - * different. - *
+ * The ARN of the secret that was updated. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -138,11 +85,11 @@ public UpdateSecretResult withARN(String aRN) { /** *- * The friendly name of the secret that was updated. + * The name of the secret that was updated. *
* * @param name - * The friendly name of the secret that was updated. + * The name of the secret that was updated. */ public void setName(String name) { @@ -151,10 +98,10 @@ public void setName(String name) { /** *- * The friendly name of the secret that was updated. + * The name of the secret that was updated. *
* - * @return The friendly name of the secret that was updated. + * @return The name of the secret that was updated. */ public String getName() { @@ -163,11 +110,11 @@ public String getName() { /** *- * The friendly name of the secret that was updated. + * The name of the secret that was updated. *
* * @param name - * The friendly name of the secret that was updated. + * The name of the secret that was updated. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -178,13 +125,13 @@ public UpdateSecretResult withName(String name) { /** *
- * If a new version of the secret was created by this operation, then VersionId
contains the unique
- * identifier of the new version.
+ * If Secrets Manager created a new version of the secret during this operation, then VersionId
+ * contains the unique identifier of the new version.
*
VersionId
contains the
- * unique identifier of the new version.
+ * If Secrets Manager created a new version of the secret during this operation, then VersionId
+ * contains the unique identifier of the new version.
*/
public void setVersionId(String versionId) {
@@ -193,12 +140,12 @@ public void setVersionId(String versionId) {
/**
*
- * If a new version of the secret was created by this operation, then VersionId
contains the unique
- * identifier of the new version.
+ * If Secrets Manager created a new version of the secret during this operation, then VersionId
+ * contains the unique identifier of the new version.
*
VersionId
contains the
- * unique identifier of the new version.
+ * @return If Secrets Manager created a new version of the secret during this operation, then VersionId
+ * contains the unique identifier of the new version.
*/
public String getVersionId() {
@@ -207,13 +154,13 @@ public String getVersionId() {
/**
*
- * If a new version of the secret was created by this operation, then VersionId
contains the unique
- * identifier of the new version.
+ * If Secrets Manager created a new version of the secret during this operation, then VersionId
+ * contains the unique identifier of the new version.
*
VersionId
contains the
- * unique identifier of the new version.
+ * If Secrets Manager created a new version of the secret during this operation, then VersionId
+ * contains the unique identifier of the new version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretVersionStageRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretVersionStageRequest.java
index aa8976dcc07a..cd14c93a81bd 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretVersionStageRequest.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretVersionStageRequest.java
@@ -27,8 +27,7 @@ public class UpdateSecretVersionStageRequest extends com.amazonaws.AmazonWebServ
/**
* - * Specifies the secret with the version with the list of staging labels you want to modify. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or the name of the secret with the version and staging labelsto modify. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. @@ -43,17 +42,17 @@ public class UpdateSecretVersionStageRequest extends com.amazonaws.AmazonWebServ private String versionStage; /** *
- * Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label - * you are trying to attach to one version is already attached to a different version, then you must include this - * parameter and specify the version that the label is to be removed from. If the label is attached and you either - * do not specify this parameter, or the version ID does not match, then the operation fails. + * The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach + * to one version is already attached to a different version, then you must include this parameter and specify the + * version that the label is to be removed from. If the label is attached and you either do not specify this + * parameter, or the version ID does not match, then the operation fails. *
*/ private String removeFromVersionId; /** *- * (Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a - * version, then do not specify this parameter. + * The ID of the version to add the staging label to. To remove a label from a version, then do not specify this + * parameter. *
** If the staging label is already attached to a different version of the secret, then you must also specify the @@ -64,16 +63,14 @@ public class UpdateSecretVersionStageRequest extends com.amazonaws.AmazonWebServ /** *
- * Specifies the secret with the version with the list of staging labels you want to modify. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or the name of the secret with the version and staging labelsto modify. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret with the version with the list of staging labels you want to modify. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or the name of the secret with the version and staging labelsto modify. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -84,15 +81,13 @@ public void setSecretId(String secretId) { /** *
- * Specifies the secret with the version with the list of staging labels you want to modify. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or the name of the secret with the version and staging labelsto modify. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* - * @return Specifies the secret with the version with the list of staging labels you want to modify. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * @return The ARN or the name of the secret with the version and staging labelsto modify. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. */ @@ -103,16 +98,14 @@ public String getSecretId() { /** *
- * Specifies the secret with the version with the list of staging labels you want to modify. You can specify either - * the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or the name of the secret with the version and staging labelsto modify. *
** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. *
* * @param secretId - * Specifies the secret with the version with the list of staging labels you want to modify. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. + * The ARN or the name of the secret with the version and staging labelsto modify. ** For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. * @return Returns a reference to this object so that method calls can be chained together. @@ -165,18 +158,17 @@ public UpdateSecretVersionStageRequest withVersionStage(String versionStage) { /** *
- * Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label - * you are trying to attach to one version is already attached to a different version, then you must include this - * parameter and specify the version that the label is to be removed from. If the label is attached and you either - * do not specify this parameter, or the version ID does not match, then the operation fails. + * The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach + * to one version is already attached to a different version, then you must include this parameter and specify the + * version that the label is to be removed from. If the label is attached and you either do not specify this + * parameter, or the version ID does not match, then the operation fails. *
* * @param removeFromVersionId - * Specifies the secret version ID of the version that the staging label is to be removed from. If the - * staging label you are trying to attach to one version is already attached to a different version, then you - * must include this parameter and specify the version that the label is to be removed from. If the label is - * attached and you either do not specify this parameter, or the version ID does not match, then the - * operation fails. + * The ID of the version that the staging label is to be removed from. If the staging label you are trying to + * attach to one version is already attached to a different version, then you must include this parameter and + * specify the version that the label is to be removed from. If the label is attached and you either do not + * specify this parameter, or the version ID does not match, then the operation fails. */ public void setRemoveFromVersionId(String removeFromVersionId) { @@ -185,17 +177,16 @@ public void setRemoveFromVersionId(String removeFromVersionId) { /** *- * Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label - * you are trying to attach to one version is already attached to a different version, then you must include this - * parameter and specify the version that the label is to be removed from. If the label is attached and you either - * do not specify this parameter, or the version ID does not match, then the operation fails. + * The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach + * to one version is already attached to a different version, then you must include this parameter and specify the + * version that the label is to be removed from. If the label is attached and you either do not specify this + * parameter, or the version ID does not match, then the operation fails. *
* - * @return Specifies the secret version ID of the version that the staging label is to be removed from. If the - * staging label you are trying to attach to one version is already attached to a different version, then - * you must include this parameter and specify the version that the label is to be removed from. If the - * label is attached and you either do not specify this parameter, or the version ID does not match, then - * the operation fails. + * @return The ID of the version that the staging label is to be removed from. If the staging label you are trying + * to attach to one version is already attached to a different version, then you must include this parameter + * and specify the version that the label is to be removed from. If the label is attached and you either do + * not specify this parameter, or the version ID does not match, then the operation fails. */ public String getRemoveFromVersionId() { @@ -204,18 +195,17 @@ public String getRemoveFromVersionId() { /** *- * Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label - * you are trying to attach to one version is already attached to a different version, then you must include this - * parameter and specify the version that the label is to be removed from. If the label is attached and you either - * do not specify this parameter, or the version ID does not match, then the operation fails. + * The ID of the version that the staging label is to be removed from. If the staging label you are trying to attach + * to one version is already attached to a different version, then you must include this parameter and specify the + * version that the label is to be removed from. If the label is attached and you either do not specify this + * parameter, or the version ID does not match, then the operation fails. *
* * @param removeFromVersionId - * Specifies the secret version ID of the version that the staging label is to be removed from. If the - * staging label you are trying to attach to one version is already attached to a different version, then you - * must include this parameter and specify the version that the label is to be removed from. If the label is - * attached and you either do not specify this parameter, or the version ID does not match, then the - * operation fails. + * The ID of the version that the staging label is to be removed from. If the staging label you are trying to + * attach to one version is already attached to a different version, then you must include this parameter and + * specify the version that the label is to be removed from. If the label is attached and you either do not + * specify this parameter, or the version ID does not match, then the operation fails. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -226,8 +216,8 @@ public UpdateSecretVersionStageRequest withRemoveFromVersionId(String removeFrom /** *- * (Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a - * version, then do not specify this parameter. + * The ID of the version to add the staging label to. To remove a label from a version, then do not specify this + * parameter. *
** If the staging label is already attached to a different version of the secret, then you must also specify the @@ -235,8 +225,8 @@ public UpdateSecretVersionStageRequest withRemoveFromVersionId(String removeFrom *
* * @param moveToVersionId - * (Optional) The secret version ID that you want to add the staging label. If you want to remove a label - * from a version, then do not specify this parameter. + * The ID of the version to add the staging label to. To remove a label from a version, then do not specify + * this parameter. *
* If the staging label is already attached to a different version of the secret, then you must also specify
* the RemoveFromVersionId
parameter.
@@ -248,16 +238,16 @@ public void setMoveToVersionId(String moveToVersionId) {
/**
*
- * (Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a - * version, then do not specify this parameter. + * The ID of the version to add the staging label to. To remove a label from a version, then do not specify this + * parameter. *
*
* If the staging label is already attached to a different version of the secret, then you must also specify the
* RemoveFromVersionId
parameter.
*
* If the staging label is already attached to a different version of the secret, then you must also specify
* the RemoveFromVersionId
parameter.
@@ -269,8 +259,8 @@ public String getMoveToVersionId() {
/**
*
- * (Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a - * version, then do not specify this parameter. + * The ID of the version to add the staging label to. To remove a label from a version, then do not specify this + * parameter. *
** If the staging label is already attached to a different version of the secret, then you must also specify the @@ -278,8 +268,8 @@ public String getMoveToVersionId() { *
* * @param moveToVersionId - * (Optional) The secret version ID that you want to add the staging label. If you want to remove a label - * from a version, then do not specify this parameter. + * The ID of the version to add the staging label to. To remove a label from a version, then do not specify + * this parameter. *
* If the staging label is already attached to a different version of the secret, then you must also specify
* the RemoveFromVersionId
parameter.
diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretVersionStageResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretVersionStageResult.java
index 74cce933b86d..59d2136f8a07 100644
--- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretVersionStageResult.java
+++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/UpdateSecretVersionStageResult.java
@@ -25,24 +25,24 @@ public class UpdateSecretVersionStageResult extends com.amazonaws.AmazonWebServi
/**
*
- * The ARN of the secret with the modified staging label. + * The ARN of the secret that was updated. *
*/ private String aRN; /** *- * The friendly name of the secret with the modified staging label. + * The name of the secret that was updated. *
*/ private String name; /** *- * The ARN of the secret with the modified staging label. + * The ARN of the secret that was updated. *
* * @param aRN - * The ARN of the secret with the modified staging label. + * The ARN of the secret that was updated. */ public void setARN(String aRN) { @@ -51,10 +51,10 @@ public void setARN(String aRN) { /** *- * The ARN of the secret with the modified staging label. + * The ARN of the secret that was updated. *
* - * @return The ARN of the secret with the modified staging label. + * @return The ARN of the secret that was updated. */ public String getARN() { @@ -63,11 +63,11 @@ public String getARN() { /** *- * The ARN of the secret with the modified staging label. + * The ARN of the secret that was updated. *
* * @param aRN - * The ARN of the secret with the modified staging label. + * The ARN of the secret that was updated. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -78,11 +78,11 @@ public UpdateSecretVersionStageResult withARN(String aRN) { /** *- * The friendly name of the secret with the modified staging label. + * The name of the secret that was updated. *
* * @param name - * The friendly name of the secret with the modified staging label. + * The name of the secret that was updated. */ public void setName(String name) { @@ -91,10 +91,10 @@ public void setName(String name) { /** *- * The friendly name of the secret with the modified staging label. + * The name of the secret that was updated. *
* - * @return The friendly name of the secret with the modified staging label. + * @return The name of the secret that was updated. */ public String getName() { @@ -103,11 +103,11 @@ public String getName() { /** *- * The friendly name of the secret with the modified staging label. + * The name of the secret that was updated. *
* * @param name - * The friendly name of the secret with the modified staging label. + * The name of the secret that was updated. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ValidateResourcePolicyRequest.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ValidateResourcePolicyRequest.java index 5e27e965d56f..534c3595d0eb 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ValidateResourcePolicyRequest.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ValidateResourcePolicyRequest.java @@ -27,39 +27,27 @@ public class ValidateResourcePolicyRequest extends com.amazonaws.AmazonWebServic /** *- * (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. - *
- *- * For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + * This field is reserved for internal use. *
*/ private String secretId; /** *- * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based - * policy. The policy in the string identifies who can access or manage this secret and its versions. For - * information on how to format a JSON parameter for the various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide.publi + * A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string + * identifies who can access or manage this secret and its versions. For example policies, see Permissions + * policy examples. *
*/ private String resourcePolicy; /** *- * (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. - *
- *- * For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + * This field is reserved for internal use. *
* * @param secretId - * (Optional) The identifier of the secret with the resource-based policy you want to validate. You can - * specify either the Amazon Resource Name (ARN) or the friendly name of the secret. - *- * For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + * This field is reserved for internal use. */ public void setSecretId(String secretId) { @@ -68,17 +56,10 @@ public void setSecretId(String secretId) { /** *
- * (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. - *
- *- * For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + * This field is reserved for internal use. *
* - * @return (Optional) The identifier of the secret with the resource-based policy you want to validate. You can - * specify either the Amazon Resource Name (ARN) or the friendly name of the secret. - *- * For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + * @return This field is reserved for internal use. */ public String getSecretId() { @@ -87,18 +68,11 @@ public String getSecretId() { /** *
- * (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify - * either the Amazon Resource Name (ARN) or the friendly name of the secret. - *
- *- * For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + * This field is reserved for internal use. *
* * @param secretId - * (Optional) The identifier of the secret with the resource-based policy you want to validate. You can - * specify either the Amazon Resource Name (ARN) or the friendly name of the secret. - *- * For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. + * This field is reserved for internal use. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -109,20 +83,18 @@ public ValidateResourcePolicyRequest withSecretId(String secretId) { /** *
- * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based - * policy. The policy in the string identifies who can access or manage this secret and its versions. For - * information on how to format a JSON parameter for the various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide.publi + * A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string + * identifies who can access or manage this secret and its versions. For example policies, see Permissions + * policy examples. *
* * @param resourcePolicy - * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services - * resource-based policy. The policy in the string identifies who can access or manage this secret and its - * versions. For information on how to format a JSON parameter for the various command line tool - * environments, see Using - * JSON for Parameters in the CLI User Guide.publi + * A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the + * string identifies who can access or manage this secret and its versions. For example policies, see Permissions + * policy examples. */ public void setResourcePolicy(String resourcePolicy) { @@ -131,19 +103,17 @@ public void setResourcePolicy(String resourcePolicy) { /** *- * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based - * policy. The policy in the string identifies who can access or manage this secret and its versions. For - * information on how to format a JSON parameter for the various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide.publi + * A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string + * identifies who can access or manage this secret and its versions. For example policies, see Permissions + * policy examples. *
* - * @return A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services - * resource-based policy. The policy in the string identifies who can access or manage this secret and its - * versions. For information on how to format a JSON parameter for the various command line tool - * environments, see Using - * JSON for Parameters in the CLI User Guide.publi + * @return A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the + * string identifies who can access or manage this secret and its versions. For example policies, see Permissions + * policy examples. */ public String getResourcePolicy() { @@ -152,20 +122,18 @@ public String getResourcePolicy() { /** *- * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services resource-based - * policy. The policy in the string identifies who can access or manage this secret and its versions. For - * information on how to format a JSON parameter for the various command line tool environments, see Using JSON for - * Parameters in the CLI User Guide.publi + * A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the string + * identifies who can access or manage this secret and its versions. For example policies, see Permissions + * policy examples. *
* * @param resourcePolicy - * A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services - * resource-based policy. The policy in the string identifies who can access or manage this secret and its - * versions. For information on how to format a JSON parameter for the various command line tool - * environments, see Using - * JSON for Parameters in the CLI User Guide.publi + * A JSON-formatted string that contains an Amazon Web Services resource-based policy. The policy in the + * string identifies who can access or manage this secret and its versions. For example policies, see Permissions + * policy examples. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ValidateResourcePolicyResult.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ValidateResourcePolicyResult.java index f20c998f6523..45ba87d4bd54 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ValidateResourcePolicyResult.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/model/ValidateResourcePolicyResult.java @@ -25,24 +25,24 @@ public class ValidateResourcePolicyResult extends com.amazonaws.AmazonWebService /** *- * Returns a message stating that your Reource Policy passed validation. + * True if your policy passes validation, otherwise false. *
*/ private Boolean policyValidationPassed; /** *- * Returns an error message if your policy doesn't pass validatation. + * Validation errors if your policy didn't pass validation. *
*/ private java.util.List- * Returns a message stating that your Reource Policy passed validation. + * True if your policy passes validation, otherwise false. *
* * @param policyValidationPassed - * Returns a message stating that your Reource Policy passed validation. + * True if your policy passes validation, otherwise false. */ public void setPolicyValidationPassed(Boolean policyValidationPassed) { @@ -51,10 +51,10 @@ public void setPolicyValidationPassed(Boolean policyValidationPassed) { /** *- * Returns a message stating that your Reource Policy passed validation. + * True if your policy passes validation, otherwise false. *
* - * @return Returns a message stating that your Reource Policy passed validation. + * @return True if your policy passes validation, otherwise false. */ public Boolean getPolicyValidationPassed() { @@ -63,11 +63,11 @@ public Boolean getPolicyValidationPassed() { /** *- * Returns a message stating that your Reource Policy passed validation. + * True if your policy passes validation, otherwise false. *
* * @param policyValidationPassed - * Returns a message stating that your Reource Policy passed validation. + * True if your policy passes validation, otherwise false. * @return Returns a reference to this object so that method calls can be chained together. */ @@ -78,10 +78,10 @@ public ValidateResourcePolicyResult withPolicyValidationPassed(Boolean policyVal /** *- * Returns a message stating that your Reource Policy passed validation. + * True if your policy passes validation, otherwise false. *
* - * @return Returns a message stating that your Reource Policy passed validation. + * @return True if your policy passes validation, otherwise false. */ public Boolean isPolicyValidationPassed() { @@ -90,10 +90,10 @@ public Boolean isPolicyValidationPassed() { /** *- * Returns an error message if your policy doesn't pass validatation. + * Validation errors if your policy didn't pass validation. *
* - * @return Returns an error message if your policy doesn't pass validatation. + * @return Validation errors if your policy didn't pass validation. */ public java.util.List- * Returns an error message if your policy doesn't pass validatation. + * Validation errors if your policy didn't pass validation. *
* * @param validationErrors - * Returns an error message if your policy doesn't pass validatation. + * Validation errors if your policy didn't pass validation. */ public void setValidationErrors(java.util.Collection- * Returns an error message if your policy doesn't pass validatation. + * Validation errors if your policy didn't pass validation. *
*
* NOTE: This method appends the values to the existing list (if any). Use
@@ -129,7 +129,7 @@ public void setValidationErrors(java.util.Collection
- * Returns an error message if your policy doesn't pass validatation. + * Validation errors if your policy didn't pass validation. *
* * @param validationErrors - * Returns an error message if your policy doesn't pass validatation. + * Validation errors if your policy didn't pass validation. * @return Returns a reference to this object so that method calls can be chained together. */ diff --git a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/package-info.java b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/package-info.java index dd8f0d64012e..41b6ba6bc32d 100644 --- a/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/package-info.java +++ b/aws-java-sdk-secretsmanager/src/main/java/com/amazonaws/services/secretsmanager/package-info.java @@ -78,7 +78,7 @@ * information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to * Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets * Manager and support for Amazon Web Services CloudTrail, see Logging + * href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/monitoring.html#monitoring_cloudtrail">Logging * Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services * Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see * the Amazon diff --git a/aws-java-sdk-securityhub/pom.xml b/aws-java-sdk-securityhub/pom.xml index 849827019780..9cfcf5555cbb 100644 --- a/aws-java-sdk-securityhub/pom.xml +++ b/aws-java-sdk-securityhub/pom.xml @@ -5,7 +5,7 @@