Package software.amazon.awscdk.services.secretsmanager

Class CfnSecretTargetAttachment

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:13.762Z")
@Stability(Stable)
public class CfnSecretTargetAttachment
extends CfnResource
implements IInspectable

The AWS::SecretsManager::SecretTargetAttachment resource completes the final link between a Secrets Manager secret and the associated database by adding the database connection information to the secret JSON.

If you want to turn on automatic rotation for a database credential secret, the secret must contain the database connection information. For more information, see JSON structure of Secrets Manager database credential secrets .

For Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secrettargetattachment.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSecretTargetAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecretTargetAttachment(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSecretTargetAttachment(software.constructs.Construct scope, String id, CfnSecretTargetAttachmentProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getSecretId()	The ARN or name of the secret.
String	getTargetId()	The ID 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 ID 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.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSecretTargetAttachment

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

CfnSecretTargetAttachment

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

CfnSecretTargetAttachment

@Stability(Stable)
public CfnSecretTargetAttachment(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSecretTargetAttachmentProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getSecretId

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

The ARN or name of the secret.

setSecretId

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

The ARN or name of the secret.

getTargetId

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

The ID of the database or cluster.

setTargetId

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

The ID of the database or cluster.

getTargetType

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

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

setTargetType

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

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