software.amazon.awscdk.services.secretsmanager

Class CfnSecret

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.secretsmanager.CfnSecret

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.893Z")
 @Stability(value=Stable)
public class CfnSecret
extends CfnResource
implements IInspectable

A CloudFormation `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.*;
 CfnSecret cfnSecret = CfnSecret.Builder.create(this, "MyCfnSecret")
         .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	Class and Description
static class	CfnSecret.Builder A fluent builder for CfnSecret.
static interface	CfnSecret.GenerateSecretStringProperty Example:
static interface	CfnSecret.ReplicaRegionProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSecret(software.constructs.Construct scope, String id) Create a new `AWS::SecretsManager::Secret`.
	CfnSecret(software.constructs.Construct scope, String id, CfnSecretProps props) Create a new `AWS::SecretsManager::Secret`.
protected	CfnSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecret(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getDescription() `AWS::SecretsManager::Secret.Description`.
Object	getGenerateSecretString() `AWS::SecretsManager::Secret.GenerateSecretString`.
String	getKmsKeyId() `AWS::SecretsManager::Secret.KmsKeyId`.
String	getName() `AWS::SecretsManager::Secret.Name`.
Object	getReplicaRegions() `AWS::SecretsManager::Secret.ReplicaRegions`.
String	getSecretString() `AWS::SecretsManager::Secret.SecretString`.
TagManager	getTags() `AWS::SecretsManager::Secret.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) `AWS::SecretsManager::Secret.Description`.
void	setGenerateSecretString(CfnSecret.GenerateSecretStringProperty value) `AWS::SecretsManager::Secret.GenerateSecretString`.
void	setGenerateSecretString(IResolvable value) `AWS::SecretsManager::Secret.GenerateSecretString`.
void	setKmsKeyId(String value) `AWS::SecretsManager::Secret.KmsKeyId`.
void	setName(String value) `AWS::SecretsManager::Secret.Name`.
void	setReplicaRegions(IResolvable value) `AWS::SecretsManager::Secret.ReplicaRegions`.
void	setReplicaRegions(List<Object> value) `AWS::SecretsManager::Secret.ReplicaRegions`.
void	setSecretString(String value) `AWS::SecretsManager::Secret.SecretString`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSecret

protected CfnSecret(software.amazon.jsii.JsiiObjectRef objRef)

CfnSecret

protected CfnSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSecret

@Stability(value=Stable)
public CfnSecret(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @Nullable
                                          CfnSecretProps props)

Create a new `AWS::SecretsManager::Secret`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnSecret

@Stability(value=Stable)
public CfnSecret(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id)

Create a new `AWS::SecretsManager::Secret`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDescription

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

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

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

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

getGenerateSecretString

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

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

setGenerateSecretString

@Stability(value=Stable)
public void setGenerateSecretString(@Nullable
                                                             CfnSecret.GenerateSecretStringProperty value)

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

setGenerateSecretString

@Stability(value=Stable)
public void setGenerateSecretString(@Nullable
                                                             IResolvable value)

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

getKmsKeyId

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

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

setKmsKeyId

@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)

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

getName

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

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

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

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

getReplicaRegions

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

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

setReplicaRegions

@Stability(value=Stable)
public void setReplicaRegions(@Nullable
                                                       IResolvable value)

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

setReplicaRegions

@Stability(value=Stable)
public void setReplicaRegions(@Nullable
                                                       List<Object> value)

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

getSecretString

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

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

setSecretString

@Stability(value=Stable)
public void setSecretString(@Nullable
                                                     String value)

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

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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