CfnSecretTargetAttachmentProps

class aws_cdk.aws_secretsmanager.CfnSecretTargetAttachmentProps(*, secret_id, target_id, target_type)

Bases: object

Properties for defining a CfnSecretTargetAttachment.

Parameters:

  • secret_id (str) – 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. This field is unique for each target attachment definition.

  • target_id (str) – The ID of the database or cluster.

  • target_type (str) – 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::RedshiftServerless::Namespace - AWS::DocDB::DBInstance - AWS::DocDB::DBCluster - AWS::DocDBElastic::Cluster

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_secretsmanager as secretsmanager

cfn_secret_target_attachment_props = secretsmanager.CfnSecretTargetAttachmentProps(
    secret_id="secretId",
    target_id="targetId",
    target_type="targetType"
)

Attributes

secret_id

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. This field is unique for each target attachment definition.

See:

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

target_id

The ID of the database or cluster.

See:

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

target_type

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::RedshiftServerless::Namespace

  • AWS::DocDB::DBInstance

  • AWS::DocDB::DBCluster

  • AWS::DocDBElastic::Cluster

See:

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