@Stability(value=Stable) @Internal public static final class CfnSecretProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnSecretProps
CfnSecretPropssoftware.amazon.jsii.JsiiObject.InitializationModeCfnSecretProps.Builder, CfnSecretProps.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnSecretProps.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnSecretProps.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
String |
getDescription()
The description of the secret.
|
Object |
getGenerateSecretString()
A structure that specifies how to generate a password to encrypt and store in the secret.
|
String |
getKmsKeyId()
The ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret.
|
String |
getName()
The name of the new secret.
|
Object |
getReplicaRegions()
A custom type that specifies a `Region` and the `KmsKeyId` for a replica secret.
|
String |
getSecretString()
The text to encrypt and store in the secret.
|
List<CfnTag> |
getTags()
A list of tags to attach to the secret.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnSecretProps.Builder builder)
CfnSecretProps.Builder.public final String getDescription()
CfnSecretPropsgetDescription in interface CfnSecretPropspublic final Object getGenerateSecretString()
CfnSecretProps
Either GenerateSecretString or SecretString must have a value, but not both. They cannot both be empty.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
getGenerateSecretString in interface CfnSecretPropspublic final String getKmsKeyId()
CfnSecretPropsTo use a AWS KMS key in a different account, use the key ARN or the alias ARN.
If you don't specify this value, then Secrets Manager uses the key aws/secretsmanager . If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value.
If the secret is in a different AWS account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed AWS KMS key.
getKmsKeyId in interface CfnSecretPropspublic final String getName()
CfnSecretPropsThe secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
getName in interface CfnSecretPropspublic final Object getReplicaRegions()
CfnSecretPropsgetReplicaRegions in interface CfnSecretPropspublic final String getSecretString()
CfnSecretPropsWe recommend you use a JSON structure of key/value pairs for your secret value.
Either GenerateSecretString or SecretString must have a value, but not both. They cannot both be empty. We recommend that you use the GenerateSecretString property to generate a random password.
getSecretString in interface CfnSecretPropspublic final List<CfnTag> getTags()
CfnSecretPropsEach tag is a key and value pair of strings in a JSON text string, for example:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc".
If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an Access Denied error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags .
For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters . If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
The following restrictions apply to tags:
aws: prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.getTags in interface CfnSecretProps@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.