Class UpdateSecretRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateSecretRequest.Builder,
UpdateSecretRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UpdateSecretRequest.Builder
builder()
final String
If you includeSecretString
orSecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.final String
The description of the secret.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
kmsKeyId()
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labelsAWSCURRENT
,AWSPENDING
, orAWSPREVIOUS
.final SdkBytes
The binary data to encrypt and store in the new version of the secret.final String
secretId()
The ARN or name of the secret.final String
The text data to encrypt and store in the new version of the secret.static Class
<? extends UpdateSecretRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
secretId
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
- Returns:
- The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
-
clientRequestToken
If you include
SecretString
orSecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you 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.
- Returns:
- If you include
SecretString
orSecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you 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.
-
description
The description of the secret.
- Returns:
- The description of the secret.
-
kmsKeyId
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels
AWSCURRENT
,AWSPENDING
, orAWSPREVIOUS
. If you don't havekms:Encrypt
permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.A key alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases.If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key
aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to useaws/secretsmanager
. Creatingaws/secretsmanager
can result in a one-time significant delay in returning the result.You can only use the Amazon Web Services managed key
aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.- Returns:
- The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well
as any existing versions with the staging labels
AWSCURRENT
,AWSPENDING
, orAWSPREVIOUS
. If you don't havekms:Encrypt
permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.A key alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases.If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key
aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to useaws/secretsmanager
. Creatingaws/secretsmanager
can result in a one-time significant delay in returning the result.You can only use the Amazon Web Services managed key
aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.
-
secretBinary
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either
SecretBinary
orSecretString
must have a value, but not both.You can't access this parameter in the Secrets Manager console.
- Returns:
- The binary data to encrypt and store in the new version of the secret. We recommend that you store your
binary data in a file and then pass the contents of the file as a parameter.
Either
SecretBinary
orSecretString
must have a value, but not both.You can't access this parameter in the Secrets Manager console.
-
secretString
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either
SecretBinary
orSecretString
must have a value, but not both.- Returns:
- The text data to encrypt and store in the new version of the secret. We recommend you use a JSON
structure of key/value pairs for your secret value.
Either
SecretBinary
orSecretString
must have a value, but not both.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateSecretRequest.Builder,
UpdateSecretRequest> - Specified by:
toBuilder
in classSecretsManagerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-