Skip to main content

ISecretsManagerUpdateSecretRequest

Interface in AWS.SecretsManager

Interface for UpdateSecret requests.

Ancestors

Properties

ClientRequestToken

property ClientRequestToken: string

Specify a token as a unique identifier for the initial version of the secret.

If ClientRequestToken is not specified a UUID will be automatically generated.

Description

property Description: string

Specify a description for the secret.

KmsKeyId

property KmsKeyId: string

Specify an Amazon Resource Name (ARN), key ID, or alias of an AWS KMS key that Secrets Manager should use to encrypt the secret value.

Any existing versions with the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS will be encrypted with the new key. NOTE: When specifying an alias, an alias must always be prefixed with alias.

SecretBinary

property SecretBinary: TStream

Specify binary data to encrypt and store in the new version of the secret.

SecretBinary should have a minimum length of 0 and a maximum length of 65536 bytes.

SecretId

property SecretId: string

Specify the Amazon Resource Name (ARN) or name of the secret to update.

SecretString

property SecretString: string

Specify text data to encrypt and store in the new version of the secret.

SecretString should have a minimum length of 0 and a maximum length of 65536.