software.amazon.awscdk.services.secretsmanager

Class CfnSecretTargetAttachment

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.secretsmanager.CfnSecretTargetAttachment

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:14.756Z")
 @Stability(value=Stable)
public class CfnSecretTargetAttachment
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SecretsManager::SecretTargetAttachment`.

The AWS::SecretsManager::SecretTargetAttachment resource completes the final link between a Secrets Manager secret and the associated database. This is required because each has a dependency on the other. No matter which one you create first, the other doesn't exist yet. To resolve this, you must create the resources in the following order:

• Define the secret without referencing the service or database. You can't reference the service or database because it doesn't exist yet. The secret must contain a user name and password.
• Next, define the service or database. Include the reference to the secret to use stored credentials to define the database admin user and password.
• Finally, define a SecretTargetAttachment resource type to finish configuring the secret with the required database engine type and the connection details of the service or database. The rotation function requires the details, if you attach one later by defining a AWS::SecretsManager::RotationSchedule resource type.

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.*;
 CfnSecretTargetAttachment cfnSecretTargetAttachment = CfnSecretTargetAttachment.Builder.create(this, "MyCfnSecretTargetAttachment")
         .secretId("secretId")
         .targetId("targetId")
         .targetType("targetType")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSecretTargetAttachment.Builder A fluent builder for CfnSecretTargetAttachment.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnSecretTargetAttachment(Construct scope, String id, CfnSecretTargetAttachmentProps props) Create a new `AWS::SecretsManager::SecretTargetAttachment`.
protected	CfnSecretTargetAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecretTargetAttachment(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getSecretId() The ARN or name of the secret.
String	getTargetId() The ARN of the database or cluster.
String	getTargetType() A string that defines the type of service or database associated with the secret.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setSecretId(String value) The ARN or name of the secret.
void	setTargetId(String value) The ARN of the database or cluster.
void	setTargetType(String value) A string that defines the type of service or database associated with the secret.

Methods inherited from class software.amazon.awscdk.core.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.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

CfnSecretTargetAttachment

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

CfnSecretTargetAttachment

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

CfnSecretTargetAttachment

@Stability(value=Stable)
public CfnSecretTargetAttachment(@NotNull
                                                          Construct scope,
                                                          @NotNull
                                                          String id,
                                                          @NotNull
                                                          CfnSecretTargetAttachmentProps props)

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

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. 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

getSecretId

@Stability(value=Stable)
 @NotNull
public String getSecretId()

The ARN or name of the secret.

To reference a secret also created in this template, use the see Ref function with the secret's logical ID.

setSecretId

@Stability(value=Stable)
public void setSecretId(@NotNull
                                                 String value)

The ARN or name of the secret.

To reference a secret also created in this template, use the see Ref function with the secret's logical ID.

getTargetId

@Stability(value=Stable)
 @NotNull
public String getTargetId()

The ARN of the database or cluster.

setTargetId

@Stability(value=Stable)
public void setTargetId(@NotNull
                                                 String value)

The ARN of the database or cluster.

getTargetType

@Stability(value=Stable)
 @NotNull
public String getTargetType()

A string that defines the type of service or database associated with the secret.

This value instructs Secrets Manager how to update the secret with the details of the service or database. This value must be one of the following:

• AWS::RDS::DBInstance
• AWS::RDS::DBCluster
• AWS::Redshift::Cluster
• AWS::DocDB::DBInstance
• AWS::DocDB::DBCluster

setTargetType

@Stability(value=Stable)
public void setTargetType(@NotNull
                                                   String value)

A string that defines the type of service or database associated with the secret.

This value instructs Secrets Manager how to update the secret with the details of the service or database. This value must be one of the following:

• AWS::RDS::DBInstance
• AWS::RDS::DBCluster
• AWS::Redshift::Cluster
• AWS::DocDB::DBInstance
• AWS::DocDB::DBCluster