@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateSecretRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
CreateSecretRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateSecretRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<ReplicaRegionType> |
getAddReplicaRegions()
A list of Regions and KMS keys to replicate secrets.
|
String |
getClientRequestToken()
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. |
String |
getDescription()
The description of the secret.
|
Boolean |
getForceOverwriteReplicaSecret()
Specifies whether to overwrite a secret with the same name in the destination Region.
|
String |
getKmsKeyId()
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
|
String |
getName()
The name of the new secret.
|
ByteBuffer |
getSecretBinary()
The binary data to encrypt and store in the new version of the secret.
|
String |
getSecretString()
The text data to encrypt and store in this new version of the secret.
|
List<Tag> |
getTags()
A list of tags to attach to the secret.
|
int |
hashCode() |
Boolean |
isForceOverwriteReplicaSecret()
Specifies whether to overwrite a secret with the same name in the destination Region.
|
void |
setAddReplicaRegions(Collection<ReplicaRegionType> addReplicaRegions)
A list of Regions and KMS keys to replicate secrets.
|
void |
setClientRequestToken(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. |
void |
setDescription(String description)
The description of the secret.
|
void |
setForceOverwriteReplicaSecret(Boolean forceOverwriteReplicaSecret)
Specifies whether to overwrite a secret with the same name in the destination Region.
|
void |
setKmsKeyId(String kmsKeyId)
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
|
void |
setName(String name)
The name of the new secret.
|
void |
setSecretBinary(ByteBuffer secretBinary)
The binary data to encrypt and store in the new version of the secret.
|
void |
setSecretString(String secretString)
The text data to encrypt and store in this new version of the secret.
|
void |
setTags(Collection<Tag> tags)
A list of tags to attach to the secret.
|
String |
toString()
Returns a string representation of this object.
|
CreateSecretRequest |
withAddReplicaRegions(Collection<ReplicaRegionType> addReplicaRegions)
A list of Regions and KMS keys to replicate secrets.
|
CreateSecretRequest |
withAddReplicaRegions(ReplicaRegionType... addReplicaRegions)
A list of Regions and KMS keys to replicate secrets.
|
CreateSecretRequest |
withClientRequestToken(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. |
CreateSecretRequest |
withDescription(String description)
The description of the secret.
|
CreateSecretRequest |
withForceOverwriteReplicaSecret(Boolean forceOverwriteReplicaSecret)
Specifies whether to overwrite a secret with the same name in the destination Region.
|
CreateSecretRequest |
withKmsKeyId(String kmsKeyId)
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret.
|
CreateSecretRequest |
withName(String name)
The name of the new secret.
|
CreateSecretRequest |
withSecretBinary(ByteBuffer secretBinary)
The binary data to encrypt and store in the new version of the secret.
|
CreateSecretRequest |
withSecretString(String secretString)
The text data to encrypt and store in this new version of the secret.
|
CreateSecretRequest |
withTags(Collection<Tag> tags)
A list of tags to attach to the secret.
|
CreateSecretRequest |
withTags(Tag... tags)
A list of tags to attach to the secret.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setName(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.
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.
public String getName()
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.
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.
public CreateSecretRequest withName(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.
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.
public void setClientRequestToken(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.
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.
public String getClientRequestToken()
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.
public CreateSecretRequest withClientRequestToken(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.
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.
public void setDescription(String description)
The description of the secret.
description - The description of the secret.public String getDescription()
The description of the secret.
public CreateSecretRequest withDescription(String description)
The description of the secret.
description - The description of the secret.public void setKmsKeyId(String kmsKeyId)
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.
kmsKeyId - 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.
public String getKmsKeyId()
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.
public CreateSecretRequest withKmsKeyId(String kmsKeyId)
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.
kmsKeyId - 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.
public void setSecretBinary(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.
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.
Warning: 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.
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.
public ByteBuffer getSecretBinary()
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.
ByteBuffers are stateful. Calling their get methods changes their position. We recommend
using ByteBuffer.asReadOnlyBuffer() to create a read-only view of the buffer with an independent
position, and calling get methods on this rather than directly on the returned ByteBuffer.
Doing so will ensure that anyone else using the ByteBuffer will not be affected by changes to the
position.
Either SecretString or SecretBinary must have a value, but not both.
This parameter is not available in the Secrets Manager console.
public CreateSecretRequest withSecretBinary(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.
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.
Warning: 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.
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.
public void setSecretString(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.
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.
public String getSecretString()
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.
public CreateSecretRequest withSecretString(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.
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.
public List<Tag> getTags()
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: + - = . _ : / @.
public void setTags(Collection<Tag> 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: + - = . _ : / @.
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: + - = . _ : / @.
public CreateSecretRequest withTags(Tag... 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: + - = . _ : / @.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
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: + - = . _ : / @.
public CreateSecretRequest withTags(Collection<Tag> 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: + - = . _ : / @.
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: + - = . _ : / @.
public List<ReplicaRegionType> getAddReplicaRegions()
A list of Regions and KMS keys to replicate secrets.
public void setAddReplicaRegions(Collection<ReplicaRegionType> addReplicaRegions)
A list of Regions and KMS keys to replicate secrets.
addReplicaRegions - A list of Regions and KMS keys to replicate secrets.public CreateSecretRequest withAddReplicaRegions(ReplicaRegionType... addReplicaRegions)
A list of Regions and KMS keys to replicate secrets.
NOTE: This method appends the values to the existing list (if any). Use
setAddReplicaRegions(java.util.Collection) or withAddReplicaRegions(java.util.Collection) if
you want to override the existing values.
addReplicaRegions - A list of Regions and KMS keys to replicate secrets.public CreateSecretRequest withAddReplicaRegions(Collection<ReplicaRegionType> addReplicaRegions)
A list of Regions and KMS keys to replicate secrets.
addReplicaRegions - A list of Regions and KMS keys to replicate secrets.public void setForceOverwriteReplicaSecret(Boolean forceOverwriteReplicaSecret)
Specifies whether to overwrite a secret with the same name in the destination Region.
forceOverwriteReplicaSecret - Specifies whether to overwrite a secret with the same name in the destination Region.public Boolean getForceOverwriteReplicaSecret()
Specifies whether to overwrite a secret with the same name in the destination Region.
public CreateSecretRequest withForceOverwriteReplicaSecret(Boolean forceOverwriteReplicaSecret)
Specifies whether to overwrite a secret with the same name in the destination Region.
forceOverwriteReplicaSecret - Specifies whether to overwrite a secret with the same name in the destination Region.public Boolean isForceOverwriteReplicaSecret()
Specifies whether to overwrite a secret with the same name in the destination Region.
public String toString()
toString in class ObjectObject.toString()public CreateSecretRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()