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, IEnvironmentAware, ISecretTargetAttachmentRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:45.396Z") @Stability(Stable) public class CfnSecretTargetAttachment extends CfnResource implements IInspectable, ISecretTargetAttachmentRef
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 .

A single secret resource can only have one target attached to it.

When you remove a SecretTargetAttachment from a stack, Secrets Manager removes the database connection information from the secret with a PutSecretValue call.

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

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

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:

  • 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)
      Create a new AWS::SecretsManager::SecretTargetAttachment.

      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

    • isCfnSecretTargetAttachment

      @Stability(Stable) @NotNull public static Boolean isCfnSecretTargetAttachment(@NotNull Object x)
      Checks whether the given object is a CfnSecretTargetAttachment.

      Parameters:
      x - This parameter is required.

    • 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

    • getSecretTargetAttachmentRef

      @Stability(Stable) @NotNull public SecretTargetAttachmentReference getSecretTargetAttachmentRef()
      A reference to a SecretTargetAttachment resource.
      Specified by:
      getSecretTargetAttachmentRef in interface ISecretTargetAttachmentRef

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