software.amazon.awscdk.services.secretsmanager

Interface CfnSecretProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecretProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.894Z")
 @Stability(value=Stable)
public interface CfnSecretProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::SecretsManager::Secret`.

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.*;
 CfnSecretProps cfnSecretProps = CfnSecretProps.builder()
         .description("description")
         .generateSecretString(GenerateSecretStringProperty.builder()
                 .excludeCharacters("excludeCharacters")
                 .excludeLowercase(false)
                 .excludeNumbers(false)
                 .excludePunctuation(false)
                 .excludeUppercase(false)
                 .generateStringKey("generateStringKey")
                 .includeSpace(false)
                 .passwordLength(123)
                 .requireEachIncludedType(false)
                 .secretStringTemplate("secretStringTemplate")
                 .build())
         .kmsKeyId("kmsKeyId")
         .name("name")
         .replicaRegions(List.of(ReplicaRegionProperty.builder()
                 .region("region")
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build()))
         .secretString("secretString")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSecretProps.Builder A builder for CfnSecretProps
static class	CfnSecretProps.Jsii$Proxy An implementation for CfnSecretProps

Method Summary

Modifier and Type	Method and Description
static CfnSecretProps.Builder	builder()
default String	getDescription() `AWS::SecretsManager::Secret.Description`.
default Object	getGenerateSecretString() `AWS::SecretsManager::Secret.GenerateSecretString`.
default String	getKmsKeyId() `AWS::SecretsManager::Secret.KmsKeyId`.
default String	getName() `AWS::SecretsManager::Secret.Name`.
default Object	getReplicaRegions() `AWS::SecretsManager::Secret.ReplicaRegions`.
default String	getSecretString() `AWS::SecretsManager::Secret.SecretString`.
default List<CfnTag>	getTags() `AWS::SecretsManager::Secret.Tags`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::SecretsManager::Secret.Description`.

getGenerateSecretString

@Stability(value=Stable)
 @Nullable
default Object getGenerateSecretString()

`AWS::SecretsManager::Secret.GenerateSecretString`.

getKmsKeyId

@Stability(value=Stable)
 @Nullable
default String getKmsKeyId()

`AWS::SecretsManager::Secret.KmsKeyId`.

getName

@Stability(value=Stable)
 @Nullable
default String getName()

`AWS::SecretsManager::Secret.Name`.

getReplicaRegions

@Stability(value=Stable)
 @Nullable
default Object getReplicaRegions()

`AWS::SecretsManager::Secret.ReplicaRegions`.

getSecretString

@Stability(value=Stable)
 @Nullable
default String getSecretString()

`AWS::SecretsManager::Secret.SecretString`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::SecretsManager::Secret.Tags`.

builder

@Stability(value=Stable)
static CfnSecretProps.Builder builder()

Returns:

a CfnSecretProps.Builder of CfnSecretProps