Class SecretProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.secretsmanager.SecretProps.Jsii$Proxy
All Implemented Interfaces:
SecretProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
SecretProps

@Stability(Stable) @Internal public static final class SecretProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements SecretProps
An implementation for SecretProps
  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.
    • Jsii$Proxy

      protected Jsii$Proxy(SecretProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the SecretProps.Builder.
  • Method Details

    • getDescription

      public final String getDescription()
      Description copied from interface: SecretProps
      An optional, human-friendly description of the secret.

      Default: - No description.

      Specified by:
      getDescription in interface SecretProps
    • getEncryptionKey

      public final IKey getEncryptionKey()
      Description copied from interface: SecretProps
      The customer-managed encryption key to use for encrypting the secret value.

      Default: - A default KMS key for the account and region is used.

      Specified by:
      getEncryptionKey in interface SecretProps
    • getGenerateSecretString

      public final SecretStringGenerator getGenerateSecretString()
      Description copied from interface: SecretProps
      Configuration for how to generate a secret value.

      Only one of secretString and generateSecretString can be provided.

      Default: - 32 characters with upper-case letters, lower-case letters, punctuation and numbers (at least one from each category), per the default values of ``SecretStringGenerator``.

      Specified by:
      getGenerateSecretString in interface SecretProps
    • getRemovalPolicy

      public final RemovalPolicy getRemovalPolicy()
      Description copied from interface: SecretProps
      Policy to apply when the secret is removed from this stack.

      Default: - Not set.

      Specified by:
      getRemovalPolicy in interface SecretProps
    • getReplicaRegions

      public final List<ReplicaRegion> getReplicaRegions()
      Description copied from interface: SecretProps
      A list of regions where to replicate this secret.

      Default: - Secret is not replicated

      Specified by:
      getReplicaRegions in interface SecretProps
    • getSecretName

      public final String getSecretName()
      Description copied from interface: SecretProps
      A name for the secret.

      Note that deleting secrets from SecretsManager does not happen immediately, but after a 7 to 30 days blackout period. During that period, it is not possible to create another secret that shares the same name.

      Default: - A name is generated by CloudFormation.

      Specified by:
      getSecretName in interface SecretProps
    • getSecretObjectValue

      public final Map<String,SecretValue> getSecretObjectValue()
      Description copied from interface: SecretProps
      Initial value for a JSON secret.

      NOTE: *It is highly encouraged to leave this field undefined and allow SecretsManager to create the secret value. The secret object -- if provided -- will be included in the output of the cdk as part of synthesis, and will appear in the CloudFormation template in the console. This can be secure(-ish) if that value is merely reference to another resource (or one of its attributes), but if the value is a plaintext string, it will be visible to anyone with access to the CloudFormation template (via the AWS Console, SDKs, or CLI).

      Specifies a JSON object that you want to encrypt and store in this new version of the secret. To specify a simple string value instead, use SecretProps.secretStringValue

      Only one of secretStringBeta1, secretStringValue, 'secretObjectValue', and generateSecretString can be provided.

      Default: - SecretsManager generates a new secret value.

      Example:

       User user;
       AccessKey accessKey;
       Stack stack;
       Secret.Builder.create(stack, "JSONSecret")
               .secretObjectValue(Map.of(
                       "username", SecretValue.unsafePlainText(user.getUserName()),  // intrinsic reference, not exposed as plaintext
                       "database", SecretValue.unsafePlainText("foo"),  // rendered as plain text, but not a secret
                       "password", accessKey.getSecretAccessKey()))
               .build();
       
      Specified by:
      getSecretObjectValue in interface SecretProps
    • getSecretStringBeta1

      public final SecretStringValueBeta1 getSecretStringBeta1()
      Description copied from interface: SecretProps
      (deprecated) Initial value for the secret.

      NOTE: *It is highly encouraged to leave this field undefined and allow SecretsManager to create the secret value. The secret string -- if provided -- will be included in the output of the cdk as part of synthesis, and will appear in the CloudFormation template in the console. This can be secure(-ish) if that value is merely reference to another resource (or one of its attributes), but if the value is a plaintext string, it will be visible to anyone with access to the CloudFormation template (via the AWS Console, SDKs, or CLI).

      Specifies text data that you want to encrypt and store in this new version of the secret. May be a simple string value, or a string representation of a JSON structure.

      Only one of secretStringBeta1, secretStringValue, and generateSecretString can be provided.

      Default: - SecretsManager generates a new secret value.

      Specified by:
      getSecretStringBeta1 in interface SecretProps
    • getSecretStringValue

      public final SecretValue getSecretStringValue()
      Description copied from interface: SecretProps
      Initial value for the secret.

      NOTE: *It is highly encouraged to leave this field undefined and allow SecretsManager to create the secret value. The secret string -- if provided -- will be included in the output of the cdk as part of synthesis, and will appear in the CloudFormation template in the console. This can be secure(-ish) if that value is merely reference to another resource (or one of its attributes), but if the value is a plaintext string, it will be visible to anyone with access to the CloudFormation template (via the AWS Console, SDKs, or CLI).

      Specifies text data that you want to encrypt and store in this new version of the secret. May be a simple string value. To provide a string representation of JSON structure, use SecretProps.secretObjectValue instead.

      Only one of secretStringBeta1, secretStringValue, 'secretObjectValue', and generateSecretString can be provided.

      Default: - SecretsManager generates a new secret value.

      Specified by:
      getSecretStringValue in interface SecretProps
    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object