String secretId
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
String aRN
The ARN of the secret.
String name
The name of the secret.
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. 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.
String 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.
String clientRequestToken
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.
String description
The description of the secret.
String kmsKeyId
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An
alias is always prefixed by alias/, for example alias/aws/secretsmanager. For more
information, see About
aliases.
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.
ByteBuffer 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.
String secretString
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.
List<E> 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: + - = . _ : / @.
List<E> addReplicaRegions
A list of Regions and KMS keys to replicate secrets.
Boolean forceOverwriteReplicaSecret
Specifies whether to overwrite a secret with the same name in the destination Region.
String 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.
String name
The name of the new secret.
String versionId
The unique identifier associated with the version of the new secret.
List<E> 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.
String 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. See Finding a secret from a partial ARN.
String 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. See Finding a secret from a partial ARN.
Long recoveryWindowInDays
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.
Boolean forceDeleteWithoutRecovery
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.
String aRN
The ARN of the secret.
String name
The name of the secret.
Date deletionDate
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.
String secretId
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
String aRN
The ARN of the secret.
String name
The name of the secret.
String description
The description of the secret.
String kmsKeyId
The key ID or alias 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.
Secrets created using the console use an KMS key ID.
Boolean rotationEnabled
Specifies whether automatic rotation is turned on for this secret.
To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
String rotationLambdaARN
The ARN of the Lambda function that Secrets Manager invokes to rotate the secret.
RotationRulesType 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.
Date lastRotatedDate
The last date and time that Secrets Manager rotated the secret. If the secret isn't configured for rotation, Secrets Manager returns null.
Date lastChangedDate
The last date and time that this secret was modified in any way.
Date lastAccessedDate
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
Date 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.
List<E> tags
The list of tags attached to the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
Map<K,V> 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.
String owningService
The ID of the service that created this secret. For more information, see Secrets managed by other Amazon Web Services services.
Date createdDate
The date the secret was created.
String primaryRegion
The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in
ReplicationStatus.
List<E> 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.
String 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.
List<E> values
The keyword to filter for.
You can prefix your search value with an exclamation mark (!) in order to perform negation filters.
Long passwordLength
The length of the password. If you don't include this parameter, the default length is 32 characters.
String excludeCharacters
A string of the characters that you don't want in the password.
Boolean excludeNumbers
Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.
Boolean excludePunctuation
Specifies whether to exclude the following punctuation characters from the password:
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~. If you don't include this
switch, the password can contain punctuation.
Boolean excludeUppercase
Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.
Boolean excludeLowercase
Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.
Boolean includeSpace
Specifies whether to include the space character. If you include this switch, the password can contain space characters.
Boolean 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.
String randomPassword
A string with the password.
String 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. See Finding a secret from a partial ARN.
String aRN
The ARN of the secret that the resource-based policy was retrieved for.
String name
The name of the secret that the resource-based policy was retrieved for.
String 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.
String 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. See Finding a secret from a partial ARN.
String versionId
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.
String versionStage
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.
String aRN
The ARN of the secret.
String name
The friendly name of the secret.
String versionId
The unique identifier of this version of the secret.
ByteBuffer 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.
String 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.
List<E> versionStages
A list of all of the staging labels currently attached to this version of the secret.
Date createdDate
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.
Integer maxResults
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.
String nextToken
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.
List<E> filters
The filters to apply to the list of secrets.
String sortOrder
Lists secrets in the requested order.
List<E> secretList
A list of the secrets in the account.
String nextToken
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.
String 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. See Finding a secret from a partial ARN.
Integer maxResults
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.
String nextToken
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.
Boolean 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.
List<E> versions
A list of the versions of the secret.
String nextToken
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.
String aRN
The ARN of the secret.
String name
The name of the secret.
String 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. See Finding a secret from a partial ARN.
String resourcePolicy
A JSON-formatted string for an Amazon Web Services resource-based policy. For example policies, see Permissions policy examples.
Boolean blockPublicPolicy
Specifies whether to block resource-based policies that allow broad access to the secret, for example those that use a wildcard for the principal.
String secretId
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. See Finding a secret from a partial ARN.
If the secret doesn't already exist, use CreateSecret instead.
String clientRequestToken
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.
ByteBuffer 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.
String 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.
List<E> 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 VersionStages, then Secrets Manager automatically moves the staging label
AWSCURRENT to this version.
String aRN
The ARN of the secret.
String name
The name of the secret.
String versionId
The unique identifier of the version of the secret.
List<E> versionStages
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.
String region
A Region code. For a list of Region codes, see Name and code of Regions.
String kmsKeyId
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.
String secretId
The ARN or name of the secret to replicate.
List<E> addReplicaRegions
A list of Regions in which to replicate the secret.
Boolean forceOverwriteReplicaSecret
Specifies whether to overwrite a secret with the same name in the destination Region.
String region
The Region where replication occurs.
String kmsKeyId
Can be an ARN, Key ID, or Alias.
String status
The status can be InProgress, Failed, or InSync.
String statusMessage
Status message such as "Secret with this name already exists in this region".
Date lastAccessedDate
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
String 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. See Finding a secret from a partial ARN.
String 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. See Finding a secret from a partial ARN.
String 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 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.
String rotationLambdaARN
The ARN of the Lambda rotation function that can rotate the secret.
RotationRulesType rotationRules
A structure that defines the rotation configuration for this secret.
Boolean rotateImmediately
Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.
If you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the
testSecret step of the Lambda rotation function. The test creates an AWSPENDING
version of the secret and then removes it.
If you don't specify this value, then by default, Secrets Manager rotates the secret immediately.
Long automaticallyAfterDays
The number of days between automatic scheduled rotations of the secret. You can use this value to check that your secret meets your compliance guidelines for how often secrets must be rotated.
In DescribeSecret and ListSecrets, this value is calculated from the rotation schedule
after every successful rotation. In RotateSecret, you can set the rotation schedule in
RotationRules with AutomaticallyAfterDays or ScheduleExpression, but not
both.
String duration
The length of the rotation window in hours, for example 3h for a three hour window. Secrets Manager
rotates your secret at any time during this window. The window must not go into the next UTC day. If you don't
specify this value, the window automatically ends at the end of the UTC day. The window begins according to the
ScheduleExpression. For more information, including examples, see Schedule
expressions in Secrets Manager rotation.
String scheduleExpression
A cron() or rate() expression that defines the schedule for rotating your secret.
Secrets Manager rotation schedules use UTC time zone.
Secrets Manager rate() expressions represent the interval in days that you want to rotate your
secret, for example rate(10 days). If you use a rate() expression, the rotation window
opens at midnight, and Secrets Manager rotates your secret any time that day after midnight. You can set a
Duration to shorten the rotation window.
You can use a cron() expression to create rotation schedules that are more detailed than a rotation
interval. For more information, including examples, see Schedule
expressions in Secrets Manager rotation. If you use a cron() expression, Secrets Manager rotates
your secret any time during that day after the window opens. For example, cron(0 8 1 * ? *)
represents a rotation window that occurs on the first day of every month beginning at 8:00 AM UTC. Secrets
Manager rotates the secret any time that day after 8:00 AM. You can set a Duration to shorten the
rotation window.
String aRN
The Amazon Resource Name (ARN) of the secret.
String name
The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For
example, /prod/databases/dbserver1 could represent the secret for a server named
dbserver1 in the folder databases in the folder prod.
String description
The user-provided description of the secret.
String kmsKeyId
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.
Boolean rotationEnabled
Indicates whether automatic, scheduled rotation is enabled for this secret.
String rotationLambdaARN
The ARN of an Amazon Web Services Lambda function invoked by Secrets Manager to rotate and expire the secret
either automatically per the schedule or manually by a call to
RotateSecret .
RotationRulesType rotationRules
A structure that defines the rotation configuration for the secret.
Date lastRotatedDate
The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.
Date lastChangedDate
The last date and time that this secret was modified in any way.
Date lastAccessedDate
The date that the secret was last accessed in the Region. This field is omitted if the secret has never been retrieved in the Region.
Date deletedDate
The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered
until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays
parameter of the
DeleteSecret operation.
List<E> tags
The list of user-defined tags associated with the secret. To add tags to a secret, use
TagResource . To remove tags, use
UntagResource .
Map<K,V> secretVersionsToStages
A list of all of the currently assigned SecretVersionStage staging labels and the
SecretVersionId attached to each one. Staging labels are used to keep track of the different
versions during the rotation process.
A version that does not have any SecretVersionStage is considered deprecated and subject to
deletion. Such versions are not included in this list.
String owningService
Returns the name of the service that created the secret.
Date createdDate
The date and time when a secret was created.
String primaryRegion
The Region where Secrets Manager originated the secret.
String versionId
The unique version identifier of this version of the secret.
List<E> versionStages
An array of staging labels that are currently associated with this version of the secret.
Date lastAccessedDate
The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.
Date createdDate
The date and time this version of the secret was created.
List<E> kmsKeyIds
The KMS keys used to encrypt the secret version.
String secretId
The ARN of the primary secret.
String aRN
The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
String 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. See Finding a secret from a partial ARN.
List<E> tags
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.
String secretId
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
List<E> 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.
String secretId
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
String clientRequestToken
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.
String description
The description of the secret.
String kmsKeyId
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 with the staging labels AWSCURRENT, AWSPENDING, or
AWSPREVIOUS. For more information about versions and staging labels, see Concepts:
Version.
A key alias is always prefixed by alias/, for example alias/aws/secretsmanager. For
more information, see About
aliases.
If you set this to an empty string, 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.
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.
ByteBuffer 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.
String secretString
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.
String 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. See Finding a secret from a partial ARN.
String versionStage
The staging label to add to this version.
String 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.
String moveToVersionId
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.
String secretId
This field is reserved for internal use.
String 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.
Copyright © 2022. All rights reserved.