aws-cdk-lib.aws_secretsmanager.CfnSecret.GenerateSecretStringProperty

GenerateSecretStringProperty Struct

Generates a random password.

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

Required permissions: secretsmanager:GetRandomPassword . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager .

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';
const generateSecretStringProperty: secretsmanager.CfnSecret.GenerateSecretStringProperty = {
  excludeCharacters: 'excludeCharacters',
  excludeLowercase: false,
  excludeNumbers: false,
  excludePunctuation: false,
  excludeUppercase: false,
  generateStringKey: 'generateStringKey',
  includeSpace: false,
  passwordLength: 123,
  requireEachIncludedType: false,
  secretStringTemplate: 'secretStringTemplate',
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_secretsmanager as secretsmanager

generate_secret_string_property = secretsmanager.CfnSecret.GenerateSecretStringProperty(
    exclude_characters="excludeCharacters",
    exclude_lowercase=False,
    exclude_numbers=False,
    exclude_punctuation=False,
    exclude_uppercase=False,
    generate_string_key="generateStringKey",
    include_space=False,
    password_length=123,
    require_each_included_type=False,
    secret_string_template="secretStringTemplate"
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.secretsmanager.*;

GenerateSecretStringProperty generateSecretStringProperty = GenerateSecretStringProperty.builder()
        .excludeCharacters("excludeCharacters")
        .excludeLowercase(false)
        .excludeNumbers(false)
        .excludePunctuation(false)
        .excludeUppercase(false)
        .generateStringKey("generateStringKey")
        .includeSpace(false)
        .passwordLength(123)
        .requireEachIncludedType(false)
        .secretStringTemplate("secretStringTemplate")
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecretsManager;

var generateSecretStringProperty = new GenerateSecretStringProperty {
    ExcludeCharacters = "excludeCharacters",
    ExcludeLowercase = false,
    ExcludeNumbers = false,
    ExcludePunctuation = false,
    ExcludeUppercase = false,
    GenerateStringKey = "generateStringKey",
    IncludeSpace = false,
    PasswordLength = 123,
    RequireEachIncludedType = false,
    SecretStringTemplate = "secretStringTemplate"
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

generateSecretStringProperty := &GenerateSecretStringProperty{
	ExcludeCharacters: jsii.String("excludeCharacters"),
	ExcludeLowercase: jsii.Boolean(false),
	ExcludeNumbers: jsii.Boolean(false),
	ExcludePunctuation: jsii.Boolean(false),
	ExcludeUppercase: jsii.Boolean(false),
	GenerateStringKey: jsii.String("generateStringKey"),
	IncludeSpace: jsii.Boolean(false),
	PasswordLength: jsii.Number(123),
	RequireEachIncludedType: jsii.Boolean(false),
	SecretStringTemplate: jsii.String("secretStringTemplate"),
}

Properties

excludeCharacters?optionalstringexclude_characters?optionalstrexcludeCharacters?optionalStringExcludeCharacters?optionalstringExcludeCharacters?optional*string#

A string of the characters that you don't want in the password.

excludeLowercase?optionalboolean | IResolvableexclude_lowercase?optionaltyping.Union[bool, IResolvable]excludeLowercase?optionalBooleanExcludeLowercase?optionalboolExcludeLowercase?optionalinterface{}#

Specifies whether to exclude lowercase letters from the password.

If you don't include this switch, the password can contain lowercase letters.

excludeNumbers?optionalboolean | IResolvableexclude_numbers?optionaltyping.Union[bool, IResolvable]excludeNumbers?optionalBooleanExcludeNumbers?optionalboolExcludeNumbers?optionalinterface{}#

Specifies whether to exclude numbers from the password.

If you don't include this switch, the password can contain numbers.

excludePunctuation?optionalboolean | IResolvableexclude_punctuation?optionaltyping.Union[bool, IResolvable]excludePunctuation?optionalBooleanExcludePunctuation?optionalboolExcludePunctuation?optionalinterface{}#

Specifies whether to exclude the following punctuation characters from the password: `!

" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~ . If you don't include this switch, the password can contain punctuation.

excludeUppercase?optionalboolean | IResolvableexclude_uppercase?optionaltyping.Union[bool, IResolvable]excludeUppercase?optionalBooleanExcludeUppercase?optionalboolExcludeUppercase?optionalinterface{}#

Specifies whether to exclude uppercase letters from the password.

If you don't include this switch, the password can contain uppercase letters.

generateStringKey?optionalstringgenerate_string_key?optionalstrgenerateStringKey?optionalStringGenerateStringKey?optionalstringGenerateStringKey?optional*string#

The JSON key name for the key/value pair, where the value is the generated password.

This pair is added to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate .

includeSpace?optionalboolean | IResolvableinclude_space?optionaltyping.Union[bool, IResolvable]includeSpace?optionalBooleanIncludeSpace?optionalboolIncludeSpace?optionalinterface{}#

Specifies whether to include the space character.

If you include this switch, the password can contain space characters.

passwordLength?optionalnumberpassword_length?optionalint | floatpasswordLength?optionalNumberPasswordLength?optionaldoublePasswordLength?optional*float64#

The length of the password.

If you don't include this parameter, the default length is 32 characters.

requireEachIncludedType?optionalboolean | IResolvablerequire_each_included_type?optionaltyping.Union[bool, IResolvable]requireEachIncludedType?optionalBooleanRequireEachIncludedType?optionalboolRequireEachIncludedType?optionalinterface{}#

Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.

If you don't include this switch, the password contains at least one of every character type.

secretStringTemplate?optionalstringsecret_string_template?optionalstrsecretStringTemplate?optionalStringSecretStringTemplate?optionalstringSecretStringTemplate?optional*string#

A template that the generated string must match.

When you make a change to this property, a new secret version is created.