@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PutSecretValueRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
PutSecretValueRequest() |
Modifier and Type | Method and Description |
---|---|
PutSecretValueRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getClientRequestToken()
A unique identifier for the new version of the secret.
|
String |
getRotationToken()
A unique identifier that indicates the source of the request.
|
ByteBuffer |
getSecretBinary()
The binary data to encrypt and store in the new version of the secret.
|
String |
getSecretId()
The ARN or name of the secret to add a new version to.
|
String |
getSecretString()
The text to encrypt and store in the new version of the secret.
|
List<String> |
getVersionStages()
A list of staging labels to attach to this version of the secret.
|
int |
hashCode() |
void |
setClientRequestToken(String clientRequestToken)
A unique identifier for the new version of the secret.
|
void |
setRotationToken(String rotationToken)
A unique identifier that indicates the source of the request.
|
void |
setSecretBinary(ByteBuffer secretBinary)
The binary data to encrypt and store in the new version of the secret.
|
void |
setSecretId(String secretId)
The ARN or name of the secret to add a new version to.
|
void |
setSecretString(String secretString)
The text to encrypt and store in the new version of the secret.
|
void |
setVersionStages(Collection<String> versionStages)
A list of staging labels to attach to this version of the secret.
|
String |
toString()
Returns a string representation of this object.
|
PutSecretValueRequest |
withClientRequestToken(String clientRequestToken)
A unique identifier for the new version of the secret.
|
PutSecretValueRequest |
withRotationToken(String rotationToken)
A unique identifier that indicates the source of the request.
|
PutSecretValueRequest |
withSecretBinary(ByteBuffer secretBinary)
The binary data to encrypt and store in the new version of the secret.
|
PutSecretValueRequest |
withSecretId(String secretId)
The ARN or name of the secret to add a new version to.
|
PutSecretValueRequest |
withSecretString(String secretString)
The text to encrypt and store in the new version of the secret.
|
PutSecretValueRequest |
withVersionStages(Collection<String> versionStages)
A list of staging labels to attach to this version of the secret.
|
PutSecretValueRequest |
withVersionStages(String... versionStages)
A list of staging labels to attach to this 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)
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.
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.
public String getSecretId()
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.
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.
public PutSecretValueRequest withSecretId(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.
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.
public void setClientRequestToken(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. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
and include it 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 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.
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. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
and include it 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 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.
public String getClientRequestToken()
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. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
and include it 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 that version's SecretString
or
SecretBinary
values are the same as those in the request then the request is ignored. The operation
is idempotent.
If a version with this value already exists and the version of the SecretString
and
SecretBinary
values are different from those in the request, then the request fails because you
can't modify a secret version. You can only create new versions to store new secret values.
This value becomes the VersionId
of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
and include it 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 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.
public PutSecretValueRequest withClientRequestToken(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. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
and include it 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 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.
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. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
and include it 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 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.
public void setSecretBinary(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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
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. 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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public ByteBuffer getSecretBinary()
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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
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
.
You must include SecretBinary
or SecretString
, but not both.
You can't access this value from the Secrets Manager console.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public PutSecretValueRequest withSecretBinary(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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
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. 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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public void setSecretString(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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public String getSecretString()
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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public PutSecretValueRequest withSecretString(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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
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.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public List<String> getVersionStages()
A list of staging labels to attach to this version of the secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
If you specify a staging label that's already associated with a different version of the same secret, then
Secrets Manager removes the label from the other version and attaches it to this version. If you specify
AWSCURRENT
, and it is already attached to another version, then Secrets Manager also moves the
staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging label
AWSCURRENT
to this version.
If you specify a staging label that's already associated with a different version of the same secret,
then Secrets Manager removes the label from the other version and attaches it to this version. If you
specify AWSCURRENT
, and it is already attached to another version, then Secrets Manager also
moves the staging label AWSPREVIOUS
to the version that AWSCURRENT
was removed
from.
If you don't include VersionStages
, then Secrets Manager automatically moves the staging
label AWSCURRENT
to this version.
public void setVersionStages(Collection<String> 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.
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.
public PutSecretValueRequest withVersionStages(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setVersionStages(java.util.Collection)
or withVersionStages(java.util.Collection)
if you want
to override the existing values.
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.
public PutSecretValueRequest withVersionStages(Collection<String> 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.
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.
public void setRotationToken(String rotationToken)
A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
rotationToken
- A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate
a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation
function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the
rotation token. For more information, see How rotation
works.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public String getRotationToken()
A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public PutSecretValueRequest withRotationToken(String rotationToken)
A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the rotation token. For more information, see How rotation works.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
rotationToken
- A unique identifier that indicates the source of the request. For cross-account rotation (when you rotate
a secret in one account by using a Lambda rotation function in another account) and the Lambda rotation
function assumes an IAM role to call Secrets Manager, Secrets Manager validates the identity with the
rotation token. For more information, see How rotation
works.
Sensitive: This field contains sensitive information, so the service does not include it in CloudTrail log entries. If you create your own log entries, you must also avoid logging the information in this field.
public String toString()
toString
in class Object
Object.toString()
public PutSecretValueRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()