Class CfnSecretTargetAttachment
A CloudFormation AWS::SecretsManager::SecretTargetAttachment
.
Inherited Members
Namespace: Amazon.CDK.AWS.SecretsManager
Assembly: Amazon.CDK.AWS.SecretsManager.dll
Syntax (csharp)
public class CfnSecretTargetAttachment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSecretTargetAttachment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::SecretsManager::SecretTargetAttachment
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecretsManager;
var cfnSecretTargetAttachment = new CfnSecretTargetAttachment(this, "MyCfnSecretTargetAttachment", new CfnSecretTargetAttachmentProps {
SecretId = "secretId",
TargetId = "targetId",
TargetType = "targetType"
});
Synopsis
Constructors
CfnSecretTargetAttachment(Construct, String, ICfnSecretTargetAttachmentProps) | Create a new |
CfnSecretTargetAttachment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSecretTargetAttachment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
SecretId | The ARN or name of the secret. |
TargetId | The ID of the database or cluster. |
TargetType | A string that defines the type of service or database associated with the secret. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSecretTargetAttachment(Construct, String, ICfnSecretTargetAttachmentProps)
Create a new AWS::SecretsManager::SecretTargetAttachment
.
public CfnSecretTargetAttachment(Construct scope, string id, ICfnSecretTargetAttachmentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSecretTargetAttachmentProps
- resource properties.
CfnSecretTargetAttachment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSecretTargetAttachment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSecretTargetAttachment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSecretTargetAttachment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
SecretId
The ARN or name of the secret.
public virtual string SecretId { get; set; }
Property Value
System.String
Remarks
To reference a secret also created in this template, use the see Ref function with the secret's logical ID.
TargetId
The ID of the database or cluster.
public virtual string TargetId { get; set; }
Property Value
System.String
Remarks
TargetType
A string that defines the type of service or database associated with the secret.
public virtual string TargetType { get; set; }
Property Value
System.String
Remarks
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:
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>