Skip to main content

ISecretsManagerCreateSecretRequest

Interface in AWS.SecretsManager

Interface for CreateSecret requests.

Ancestors

Properties

AddReplicaRegions

property AddReplicaRegions: TList<ISecretsManagerReplicaRegionType>

Type: ISecretsManagerReplicaRegionType

Specify a list of regions and AWS KMS keys to replicate secrets.

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.

ForceOverwriteReplicaSecret

property ForceOverwriteReplicaSecret: TOptional<Boolean>

Specify whether to overwrite a secret with the same name in the same region.

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.

NOTE: When specifying an alias, an alias must always be prefixed with alias.

Name

property Name: string

Specify a name for the new secret.

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.

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.

Tags

property Tags: IAWSTags

Specify a list of tags to attach to the secret.

Methods

AddReplicaRegion

function AddReplicaRegion(const AReplicaRegion: ISecretsManagerReplicaRegionType): Integer;

ISecretsManagerReplicaRegionType

Add a replica region to the AddReplicaRegions list.

Parameters

NameDescription
AReplicRegionSpecify a replica region instance to add to the AddReplicaRegions list.

Returns

Returns the index of the item added to AddReplicaRegions list.

AddTag

function AddTag(const AKey, AValue: string): Integer;

Add a tag to Tags.

Parameters

NameDescription
AKeySpecify a key for the tag.
AValueSpecify a value for the tag.

Returns

Returns the index of the tag added to Tags.