Package software.amazon.awscdk.services.secretsmanager

Class CfnSecret.GenerateSecretStringProperty.Builder

java.lang.Object

software.amazon.awscdk.services.secretsmanager.CfnSecret.GenerateSecretStringProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSecret.GenerateSecretStringProperty>

Enclosing interface:

CfnSecret.GenerateSecretStringProperty

@Stability(Stable)
public static final class CfnSecret.GenerateSecretStringProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSecret.GenerateSecretStringProperty>

A builder for CfnSecret.GenerateSecretStringProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnSecret.GenerateSecretStringProperty	build()	Builds the configured instance.
CfnSecret.GenerateSecretStringProperty.Builder	excludeCharacters(String excludeCharacters)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeCharacters()
CfnSecret.GenerateSecretStringProperty.Builder	excludeLowercase(Boolean excludeLowercase)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeLowercase()
CfnSecret.GenerateSecretStringProperty.Builder	excludeLowercase(IResolvable excludeLowercase)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeLowercase()
CfnSecret.GenerateSecretStringProperty.Builder	excludeNumbers(Boolean excludeNumbers)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeNumbers()
CfnSecret.GenerateSecretStringProperty.Builder	excludeNumbers(IResolvable excludeNumbers)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeNumbers()
CfnSecret.GenerateSecretStringProperty.Builder	excludePunctuation(Boolean excludePunctuation)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludePunctuation()
CfnSecret.GenerateSecretStringProperty.Builder	excludePunctuation(IResolvable excludePunctuation)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludePunctuation()
CfnSecret.GenerateSecretStringProperty.Builder	excludeUppercase(Boolean excludeUppercase)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeUppercase()
CfnSecret.GenerateSecretStringProperty.Builder	excludeUppercase(IResolvable excludeUppercase)	Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeUppercase()
CfnSecret.GenerateSecretStringProperty.Builder	generateStringKey(String generateStringKey)	Sets the value of CfnSecret.GenerateSecretStringProperty.getGenerateStringKey()
CfnSecret.GenerateSecretStringProperty.Builder	includeSpace(Boolean includeSpace)	Sets the value of CfnSecret.GenerateSecretStringProperty.getIncludeSpace()
CfnSecret.GenerateSecretStringProperty.Builder	includeSpace(IResolvable includeSpace)	Sets the value of CfnSecret.GenerateSecretStringProperty.getIncludeSpace()
CfnSecret.GenerateSecretStringProperty.Builder	passwordLength(Number passwordLength)	Sets the value of CfnSecret.GenerateSecretStringProperty.getPasswordLength()
CfnSecret.GenerateSecretStringProperty.Builder	requireEachIncludedType(Boolean requireEachIncludedType)	Sets the value of CfnSecret.GenerateSecretStringProperty.getRequireEachIncludedType()
CfnSecret.GenerateSecretStringProperty.Builder	requireEachIncludedType(IResolvable requireEachIncludedType)	Sets the value of CfnSecret.GenerateSecretStringProperty.getRequireEachIncludedType()
CfnSecret.GenerateSecretStringProperty.Builder	secretStringTemplate(String secretStringTemplate)	Sets the value of CfnSecret.GenerateSecretStringProperty.getSecretStringTemplate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

excludeCharacters

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludeCharacters(String excludeCharacters)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeCharacters()

Parameters:

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

Returns:

this

excludeLowercase

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludeLowercase(Boolean excludeLowercase)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeLowercase()

Parameters:

excludeLowercase - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

Returns:

this

excludeLowercase

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludeLowercase(IResolvable excludeLowercase)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeLowercase()

Parameters:

excludeLowercase - Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters.

Returns:

this

excludeNumbers

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludeNumbers(Boolean excludeNumbers)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeNumbers()

Parameters:

excludeNumbers - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

Returns:

this

excludeNumbers

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludeNumbers(IResolvable excludeNumbers)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeNumbers()

Parameters:

excludeNumbers - Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers.

Returns:

this

excludePunctuation

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludePunctuation(Boolean excludePunctuation)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludePunctuation()

Parameters:

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

Returns:

this

excludePunctuation

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludePunctuation(IResolvable excludePunctuation)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludePunctuation()

Parameters:

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

Returns:

this

excludeUppercase

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludeUppercase(Boolean excludeUppercase)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeUppercase()

Parameters:

excludeUppercase - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

Returns:

this

excludeUppercase

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder excludeUppercase(IResolvable excludeUppercase)

Sets the value of CfnSecret.GenerateSecretStringProperty.getExcludeUppercase()

Parameters:

excludeUppercase - Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters.

Returns:

this

generateStringKey

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder generateStringKey(String generateStringKey)

Sets the value of CfnSecret.GenerateSecretStringProperty.getGenerateStringKey()

Parameters:

generateStringKey - 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 .

Returns:

this

includeSpace

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder includeSpace(Boolean includeSpace)

Sets the value of CfnSecret.GenerateSecretStringProperty.getIncludeSpace()

Parameters:

includeSpace - Specifies whether to include the space character. If you include this switch, the password can contain space characters.

Returns:

this

includeSpace

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder includeSpace(IResolvable includeSpace)

Sets the value of CfnSecret.GenerateSecretStringProperty.getIncludeSpace()

Parameters:

includeSpace - Specifies whether to include the space character. If you include this switch, the password can contain space characters.

Returns:

this

passwordLength

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder passwordLength(Number passwordLength)

Sets the value of CfnSecret.GenerateSecretStringProperty.getPasswordLength()

Parameters:

passwordLength - The length of the password. If you don't include this parameter, the default length is 32 characters.

Returns:

this

requireEachIncludedType

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder requireEachIncludedType(Boolean requireEachIncludedType)

Sets the value of CfnSecret.GenerateSecretStringProperty.getRequireEachIncludedType()

Parameters:

requireEachIncludedType - 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:

this

requireEachIncludedType

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder requireEachIncludedType(IResolvable requireEachIncludedType)

Sets the value of CfnSecret.GenerateSecretStringProperty.getRequireEachIncludedType()

Parameters:

requireEachIncludedType - 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:

this

secretStringTemplate

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty.Builder secretStringTemplate(String secretStringTemplate)

Sets the value of CfnSecret.GenerateSecretStringProperty.getSecretStringTemplate()

Parameters:

secretStringTemplate - A template that the generated string must match. When you make a change to this property, a new secret version is created.

Returns:

this

build

@Stability(Stable)
public CfnSecret.GenerateSecretStringProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnSecret.GenerateSecretStringProperty>

Returns:

a new instance of CfnSecret.GenerateSecretStringProperty

Throws:

NullPointerException - if any required attribute was not provided