Class CfnSecretPropsMixin.GenerateSecretStringProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.secretsmanager.CfnSecretPropsMixin.GenerateSecretStringProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSecretPropsMixin.GenerateSecretStringProperty>
- Enclosing interface:
CfnSecretPropsMixin.GenerateSecretStringProperty
@Stability(Stable)
public static final class CfnSecretPropsMixin.GenerateSecretStringProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSecretPropsMixin.GenerateSecretStringProperty>
A builder for
CfnSecretPropsMixin.GenerateSecretStringProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.excludeCharacters(String excludeCharacters) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludeCharacters()excludeLowercase(Boolean excludeLowercase) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludeLowercase()excludeLowercase(IResolvable excludeLowercase) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludeLowercase()excludeNumbers(Boolean excludeNumbers) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludeNumbers()excludeNumbers(IResolvable excludeNumbers) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludeNumbers()excludePunctuation(Boolean excludePunctuation) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludePunctuation()excludePunctuation(IResolvable excludePunctuation) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludePunctuation()excludeUppercase(Boolean excludeUppercase) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludeUppercase()excludeUppercase(IResolvable excludeUppercase) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludeUppercase()generateStringKey(String generateStringKey) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getGenerateStringKey()includeSpace(Boolean includeSpace) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getIncludeSpace()includeSpace(IResolvable includeSpace) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getIncludeSpace()passwordLength(Number passwordLength) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getPasswordLength()requireEachIncludedType(Boolean requireEachIncludedType) requireEachIncludedType(IResolvable requireEachIncludedType) secretStringTemplate(String secretStringTemplate)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
excludeCharacters
@Stability(Stable) public CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludeCharacters(String excludeCharacters) Sets the value ofCfnSecretPropsMixin.GenerateSecretStringProperty.getExcludeCharacters()- Parameters:
excludeCharacters- A string of the characters that you don't want in the password.- Returns:
this
-
excludeLowercase
@Stability(Stable) public CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludeLowercase(Boolean excludeLowercase) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludeLowercase(IResolvable excludeLowercase) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludeNumbers(Boolean excludeNumbers) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludeNumbers(IResolvable excludeNumbers) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludePunctuation(Boolean excludePunctuation) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludePunctuation(IResolvable excludePunctuation) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludeUppercase(Boolean excludeUppercase) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder excludeUppercase(IResolvable excludeUppercase) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder generateStringKey(String generateStringKey) Sets the value ofCfnSecretPropsMixin.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 theSecretStringTemplateparameter. If you specify this parameter, then you must also specifySecretStringTemplate.- Returns:
this
-
includeSpace
@Stability(Stable) public CfnSecretPropsMixin.GenerateSecretStringProperty.Builder includeSpace(Boolean includeSpace) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder includeSpace(IResolvable includeSpace) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder passwordLength(Number passwordLength) Sets the value ofCfnSecretPropsMixin.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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder requireEachIncludedType(Boolean requireEachIncludedType) - 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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder requireEachIncludedType(IResolvable requireEachIncludedType) - 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 CfnSecretPropsMixin.GenerateSecretStringProperty.Builder secretStringTemplate(String secretStringTemplate) - 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
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnSecretPropsMixin.GenerateSecretStringProperty>- Returns:
- a new instance of
CfnSecretPropsMixin.GenerateSecretStringProperty - Throws:
NullPointerException- if any required attribute was not provided
-