1.204.0

interface CfnSecretProps

LanguageType name
.NETAmazon.CDK.AWS.SecretsManager.CfnSecretProps
Javasoftware.amazon.awscdk.services.secretsmanager.CfnSecretProps
Pythonaws_cdk.aws_secretsmanager.CfnSecretProps
TypeScript @aws-cdk/aws-secretsmanager » CfnSecretProps

Properties for defining a CfnSecret.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as secretsmanager from '@aws-cdk/aws-secretsmanager';
const cfnSecretProps: secretsmanager.CfnSecretProps = {
  description: 'description',
  generateSecretString: {
    excludeCharacters: 'excludeCharacters',
    excludeLowercase: false,
    excludeNumbers: false,
    excludePunctuation: false,
    excludeUppercase: false,
    generateStringKey: 'generateStringKey',
    includeSpace: false,
    passwordLength: 123,
    requireEachIncludedType: false,
    secretStringTemplate: 'secretStringTemplate',
  },
  kmsKeyId: 'kmsKeyId',
  name: 'name',
  replicaRegions: [{
    region: 'region',

    // the properties below are optional
    kmsKeyId: 'kmsKeyId',
  }],
  secretString: 'secretString',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
description?stringThe description of the secret.
generateSecretString?IResolvable | GenerateSecretStringPropertyA structure that specifies how to generate a password to encrypt and store in the secret.
kmsKeyId?stringThe ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret.
name?stringThe name of the new secret.
replicaRegions?IResolvable | IResolvable | ReplicaRegionProperty[]A custom type that specifies a Region and the KmsKeyId for a replica secret.
secretString?stringThe text to encrypt and store in the secret.
tags?CfnTag[]A list of tags to attach to the secret.

description?

Type: string (optional)

The description of the secret.

generateSecretString?

Type: IResolvable | GenerateSecretStringProperty (optional)

A structure that specifies how to generate a password to encrypt and store in the secret.

To include a specific string in the secret, use SecretString instead. If you omit both GenerateSecretString and SecretString , you create an empty secret. When you make a change to this property, a new secret version is created.

We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

kmsKeyId?

Type: string (optional)

The ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret.

An alias is always prefixed by alias/ , for example alias/aws/secretsmanager . For more information, see About aliases .

To use a AWS KMS key in a different account, use the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager . If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.

If the secret is in a different AWS 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 AWS KMS key.

name?

Type: string (optional)

The name of the new secret.

The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-

Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.

replicaRegions?

Type: IResolvable | IResolvable | ReplicaRegionProperty[] (optional)

A custom type that specifies a Region and the KmsKeyId for a replica secret.

secretString?

Type: string (optional)

The text to encrypt and store in the secret.

We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use GenerateSecretString instead. If you omit both GenerateSecretString and SecretString , you create an empty secret. When you make a change to this property, a new secret version is created.

tags?

Type: CfnTag[] (optional)

A list of tags to attach to the secret.

Each tag is a key and value pair of strings in a JSON text string, for example:

[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]

Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".

If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags .

For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters . If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

The following restrictions apply to tags:

  • Maximum number of tags per secret: 50
  • Maximum key length: 127 Unicode characters in UTF-8
  • Maximum value length: 255 Unicode characters in UTF-8
  • Tag keys and values are case sensitive.
  • Do not use the aws: prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
  • If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
← PreviousNext →