Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.268Z") @Stability(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 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();

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

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

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

    • setSecretId

      @Stability(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(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.

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