Package software.amazon.awscdk.services.secretsmanager

Interface CfnSecret.GenerateSecretStringProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecret.GenerateSecretStringProperty.Jsii$Proxy

Enclosing class:

CfnSecret

@Stability(Stable)
public static interface CfnSecret.GenerateSecretStringProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSecret.GenerateSecretStringProperty.Builder	A builder for CfnSecret.GenerateSecretStringProperty
static final class	CfnSecret.GenerateSecretStringProperty.Jsii$Proxy	An implementation for CfnSecret.GenerateSecretStringProperty

Method Summary

Modifier and Type	Method	Description
static CfnSecret.GenerateSecretStringProperty.Builder	builder()
default String	getExcludeCharacters()	A string of the characters that you don't want in the password.
default Object	getExcludeLowercase()	Specifies whether to exclude lowercase letters from the password.
default Object	getExcludeNumbers()	Specifies whether to exclude numbers from the password.
default Object	getExcludePunctuation()	Specifies whether to exclude the following punctuation characters from the password: `!
default Object	getExcludeUppercase()	Specifies whether to exclude uppercase letters from the password.
default String	getGenerateStringKey()	The JSON key name for the key/value pair, where the value is the generated password.
default Object	getIncludeSpace()	Specifies whether to include the space character.
default Number	getPasswordLength()	The length of the password.
default Object	getRequireEachIncludedType()	Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
default String	getSecretStringTemplate()	A template that the generated string must match.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExcludeCharacters

@Stability(Stable)
@Nullable
default String getExcludeCharacters()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludecharacters

getExcludeLowercase

@Stability(Stable)
@Nullable
default Object getExcludeLowercase()

Specifies whether to exclude lowercase letters from the password.

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludelowercase

getExcludeNumbers

@Stability(Stable)
@Nullable
default Object getExcludeNumbers()

Specifies whether to exclude numbers from the password.

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludenumbers

getExcludePunctuation

@Stability(Stable)
@Nullable
default Object getExcludePunctuation()

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

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludepunctuation

getExcludeUppercase

@Stability(Stable)
@Nullable
default Object getExcludeUppercase()

Specifies whether to exclude uppercase letters from the password.

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludeuppercase

getGenerateStringKey

@Stability(Stable)
@Nullable
default String getGenerateStringKey()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-generatestringkey

getIncludeSpace

@Stability(Stable)
@Nullable
default Object getIncludeSpace()

Specifies whether to include the space character.

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

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-includespace

getPasswordLength

@Stability(Stable)
@Nullable
default Number getPasswordLength()

The length of the password.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-passwordlength

getRequireEachIncludedType

@Stability(Stable)
@Nullable
default Object getRequireEachIncludedType()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-requireeachincludedtype

getSecretStringTemplate

@Stability(Stable)
@Nullable
default String getSecretStringTemplate()

A template that the generated string must match.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-secretstringtemplate

builder

@Stability(Stable)
static CfnSecret.GenerateSecretStringProperty.Builder builder()

Returns:

a CfnSecret.GenerateSecretStringProperty.Builder of CfnSecret.GenerateSecretStringProperty