@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateSecretRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateSecretRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateSecretRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
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.
|
String |
getDescription()
(Optional) Specifies a user-provided description of the secret.
|
String |
getKmsKeyId()
(Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the protected
text in the versions of this secret.
|
ByteBuffer |
getSecretBinary()
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret.
|
String |
getSecretId()
Specifies the secret that you want to update or to which you want to add a new version.
|
String |
getSecretString()
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
|
int |
hashCode() |
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.
|
void |
setDescription(String description)
(Optional) Specifies a user-provided description of the secret.
|
void |
setKmsKeyId(String kmsKeyId)
(Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the protected
text in the versions of this secret.
|
void |
setSecretBinary(ByteBuffer secretBinary)
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret.
|
void |
setSecretId(String secretId)
Specifies the secret that you want to update or to which you want to add a new version.
|
void |
setSecretString(String secretString)
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
UpdateSecretRequest |
withClientRequestToken(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.
|
UpdateSecretRequest |
withDescription(String description)
(Optional) Specifies a user-provided description of the secret.
|
UpdateSecretRequest |
withKmsKeyId(String kmsKeyId)
(Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the protected
text in the versions of this secret.
|
UpdateSecretRequest |
withSecretBinary(ByteBuffer secretBinary)
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret.
|
UpdateSecretRequest |
withSecretId(String secretId)
Specifies the secret that you want to update or to which you want to add a new version.
|
UpdateSecretRequest |
withSecretString(String secretString)
(Optional) Specifies text data that you want to encrypt and store in this new version of 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, withSdkRequestTimeout
public void setSecretId(String secretId)
Specifies the secret that you want to update 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.
secretId
- Specifies the secret that you want to update 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.public String getSecretId()
Specifies the secret that you want to update 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.
public UpdateSecretRequest withSecretId(String secretId)
Specifies the secret that you want to update 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.
secretId
- Specifies the secret that you want to update 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.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 AWS CLI or one of the AWS 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 SecretVersionId
of the new version.
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 AWS CLI or one of the AWS 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 SecretVersionId
of the new version.
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 AWS CLI or one of the AWS 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 SecretVersionId
of the new version.
If you use the AWS CLI or one of the AWS 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 SecretVersionId
of the new version.
public UpdateSecretRequest withClientRequestToken(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 AWS CLI or one of the AWS 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 SecretVersionId
of the new version.
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 AWS CLI or one of the AWS 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 SecretVersionId
of the new version.
public void setDescription(String description)
(Optional) Specifies a user-provided description of the secret.
description
- (Optional) Specifies a user-provided description of the secret.public String getDescription()
(Optional) Specifies a user-provided description of the secret.
public UpdateSecretRequest withDescription(String description)
(Optional) Specifies a user-provided description of the secret.
description
- (Optional) Specifies a user-provided description of the secret.public void setKmsKeyId(String kmsKeyId)
(Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the protected text in the versions of this secret.
If you don't specify this value, then Secrets Manager defaults to using the default CMK in the account (the one
named aws/secretsmanager
). If a KMS CMK with that name doesn't exist, then Secrets Manager creates
it for you automatically the first time it needs to encrypt a version's Plaintext
or
PlaintextString
fields.
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 in this field.
kmsKeyId
- (Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the
protected text in the versions of this secret.
If you don't specify this value, then Secrets Manager defaults to using the default CMK in the account
(the one named aws/secretsmanager
). If a KMS CMK with that name doesn't exist, then Secrets
Manager creates it for you automatically the first time it needs to encrypt a version's
Plaintext
or PlaintextString
fields.
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 in this field.
public String getKmsKeyId()
(Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the protected text in the versions of this secret.
If you don't specify this value, then Secrets Manager defaults to using the default CMK in the account (the one
named aws/secretsmanager
). If a KMS CMK with that name doesn't exist, then Secrets Manager creates
it for you automatically the first time it needs to encrypt a version's Plaintext
or
PlaintextString
fields.
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 in this field.
If you don't specify this value, then Secrets Manager defaults to using the default CMK in the account
(the one named aws/secretsmanager
). If a KMS CMK with that name doesn't exist, then Secrets
Manager creates it for you automatically the first time it needs to encrypt a version's
Plaintext
or PlaintextString
fields.
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 in this field.
public UpdateSecretRequest withKmsKeyId(String kmsKeyId)
(Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the protected text in the versions of this secret.
If you don't specify this value, then Secrets Manager defaults to using the default CMK in the account (the one
named aws/secretsmanager
). If a KMS CMK with that name doesn't exist, then Secrets Manager creates
it for you automatically the first time it needs to encrypt a version's Plaintext
or
PlaintextString
fields.
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 in this field.
kmsKeyId
- (Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the
protected text in the versions of this secret.
If you don't specify this value, then Secrets Manager defaults to using the default CMK in the account
(the one named aws/secretsmanager
). If a KMS CMK with that name doesn't exist, then Secrets
Manager creates it for you automatically the first time it needs to encrypt a version's
Plaintext
or PlaintextString
fields.
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 in this field.
public void setSecretBinary(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.
This parameter is not accessible using 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
- (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 using the Secrets Manager console.
public 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.
This parameter is not accessible using the Secrets Manager console.
ByteBuffer
s 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
.
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.
public UpdateSecretRequest withSecretBinary(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.
This parameter is not accessible using 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
- (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 using the Secrets Manager console.
public void setSecretString(String secretString)
(Optional) Specifies 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 information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
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.
secretString
- (Optional) Specifies 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 information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
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.
public String getSecretString()
(Optional) Specifies 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 information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
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.
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 information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
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.
public UpdateSecretRequest withSecretString(String secretString)
(Optional) Specifies 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 information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
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.
secretString
- (Optional) Specifies 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 information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
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.
public String toString()
toString
in class Object
Object.toString()
public UpdateSecretRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.