Interface CfnSecret.GenerateSecretStringProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnSecret.GenerateSecretStringProperty.Jsii$Proxy
- Enclosing class:
CfnSecret
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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnSecret.GenerateSecretStringProperty
static final class
An implementation forCfnSecret.GenerateSecretStringProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
A string of the characters that you don't want in the password.default Object
Specifies whether to exclude lowercase letters from the password.default Object
Specifies whether to exclude numbers from the password.default Object
Specifies whether to exclude the following punctuation characters from the password: `!default Object
Specifies whether to exclude uppercase letters from the password.default String
The JSON key name for the key/value pair, where the value is the generated password.default Object
Specifies whether to include the space character.default Number
The length of the password.default Object
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.default String
A template that the generated string must match.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getExcludeCharacters
A string of the characters that you don't want in the password.- See Also:
-
getExcludeLowercase
Specifies whether to exclude lowercase letters from the password.If you don't include this switch, the password can contain lowercase letters.
- See Also:
-
getExcludeNumbers
Specifies whether to exclude numbers from the password.If you don't include this switch, the password can contain numbers.
- See Also:
-
getExcludePunctuation
Specifies whether to exclude the following punctuation characters from the password: `!" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _
{ | } ~
. If you don't include this switch, the password can contain punctuation.- See Also:
-
getExcludeUppercase
Specifies whether to exclude uppercase letters from the password.If you don't include this switch, the password can contain uppercase letters.
- See Also:
-
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 specifySecretStringTemplate
.- See Also:
-
getIncludeSpace
Specifies whether to include the space character.If you include this switch, the password can contain space characters.
- See Also:
-
getPasswordLength
The length of the password.If you don't include this parameter, the default length is 32 characters.
- See Also:
-
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.
- See Also:
-
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:
-
builder
-