Struct aws_sdk_secretsmanager::client::fluent_builders::UpdateSecret [−][src]
pub struct UpdateSecret<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to UpdateSecret
.
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue
.
To change the rotation configuration of a secret, use RotateSecret
instead.
We recommend you avoid calling UpdateSecret
at a sustained rate of more than once every 10 minutes. When you call UpdateSecret
to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If you include SecretString
or SecretBinary
to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT
to the new version.
If you call this operation with a VersionId
that matches an existing version's ClientRequestToken
, the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage
.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager
. If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager
. Creating aws/secretsmanager
can result in a one-time significant delay in returning the result.
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 key.
To run this command, you must have secretsmanager:UpdateSecret
permissions. If you use a customer managed key, you must also have kms:GenerateDataKey
and kms:Decrypt
permissions .
Implementations
impl<C, M, R> UpdateSecret<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> UpdateSecret<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<UpdateSecretOutput, SdkError<UpdateSecretError>> where
R::Policy: SmithyRetryPolicy<UpdateSecretInputOperationOutputAlias, UpdateSecretOutput, UpdateSecretError, UpdateSecretInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<UpdateSecretOutput, SdkError<UpdateSecretError>> where
R::Policy: SmithyRetryPolicy<UpdateSecretInputOperationOutputAlias, UpdateSecretOutput, UpdateSecretError, UpdateSecretInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN.
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
If you include SecretString
or SecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
yourself for the new version and include the value in the request.
This value becomes the VersionId
of the new version.
The description of the secret.
The description of the secret.
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 the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
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.
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 the staging labels AWSCURRENT
, AWSPENDING
, or AWSPREVIOUS
. For more information about versions and staging labels, see Concepts: Version.
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.
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either SecretBinary
or SecretString
must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either SecretBinary
or SecretString
must have a value, but not both.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for UpdateSecret<C, M, R>
impl<C, M, R> Unpin for UpdateSecret<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for UpdateSecret<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more