public static interface CfnSecret.GenerateSecretStringProperty
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();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnSecret.GenerateSecretStringProperty.Builder
A builder for
CfnSecret.GenerateSecretStringProperty |
static class |
CfnSecret.GenerateSecretStringProperty.Jsii$Proxy
An implementation for
CfnSecret.GenerateSecretStringProperty |
| Modifier and Type | Method and Description |
|---|---|
static CfnSecret.GenerateSecretStringProperty.Builder |
builder() |
default java.lang.String |
getExcludeCharacters()
A string of the characters that you don't want in the password.
|
default java.lang.Object |
getExcludeLowercase()
Specifies whether to exclude lowercase letters from the password.
|
default java.lang.Object |
getExcludeNumbers()
Specifies whether to exclude numbers from the password.
|
default java.lang.Object |
getExcludePunctuation()
Specifies whether to exclude the following punctuation characters from the password: `!
|
default java.lang.Object |
getExcludeUppercase()
Specifies whether to exclude uppercase letters from the password.
|
default java.lang.String |
getGenerateStringKey()
The JSON key name for the key/value pair, where the value is the generated password.
|
default java.lang.Object |
getIncludeSpace()
Specifies whether to include the space character.
|
default java.lang.Number |
getPasswordLength()
The length of the password.
|
default java.lang.Object |
getRequireEachIncludedType()
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
|
default java.lang.String |
getSecretStringTemplate()
A template that the generated string must match.
|
default java.lang.String getExcludeCharacters()
default java.lang.Object getExcludeLowercase()
If you don't include this switch, the password can contain lowercase letters.
default java.lang.Object getExcludeNumbers()
If you don't include this switch, the password can contain numbers.
default java.lang.Object getExcludePunctuation()
" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~ . If you don't include this switch, the password can contain punctuation.
default java.lang.Object getExcludeUppercase()
If you don't include this switch, the password can contain uppercase letters.
default java.lang.String getGenerateStringKey()
This pair is added to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate .
default java.lang.Object getIncludeSpace()
If you include this switch, the password can contain space characters.
default java.lang.Number getPasswordLength()
If you don't include this parameter, the default length is 32 characters.
default java.lang.Object getRequireEachIncludedType()
If you don't include this switch, the password contains at least one of every character type.
default java.lang.String getSecretStringTemplate()
When you make a change to this property, a new secret version is created.
static CfnSecret.GenerateSecretStringProperty.Builder builder()