interface ISecret

Language	Type name
.NET	Amazon.CDK.AWS.SecretsManager.ISecret
Go	github.com/aws/aws-cdk-go/awscdk/v2/awssecretsmanager#ISecret
Java	software.amazon.awscdk.services.secretsmanager.ISecret
Python	aws_cdk.aws_secretsmanager.ISecret
TypeScript (source)	aws-cdk-lib » aws_secretsmanager » ISecret

Implemented by DatabaseSecret, DatabaseSecret, Secret, SecretTargetAttachment, DatabaseSecret

Obtainable from Secret.fromSecretAttributes(), Secret.fromSecretCompleteArn(), Secret.fromSecretNameV2(), Secret.fromSecretPartialArn(), Secret.attach(), SecretTargetAttachment.attach()

A secret in AWS Secrets Manager.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
secretArn	string	The ARN of the secret in AWS Secrets Manager.
secretName	string	The name of the secret.
secretValue	SecretValue	Retrieve the value of the stored secret as a SecretValue.
stack	Stack	The stack in which this resource is defined.
encryptionKey?	IKey	The customer-managed encryption key that is used to encrypt this secret, if any.
secretFullArn?	string	The full ARN of the secret in AWS Secrets Manager, which is the ARN including the Secrets Manager-supplied 6-character suffix.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

secretArn

Type: string

The ARN of the secret in AWS Secrets Manager.

Will return the full ARN if available, otherwise a partial arn. For secrets imported by the deprecated fromSecretName, it will return the secretName.

---

secretName

Type: string

The name of the secret.

For "owned" secrets, this will be the full resource name (secret name + suffix), unless the '@aws-cdk/aws-secretsmanager:parseOwnedSecretName' feature flag is set.

---

secretValue

Type: SecretValue

Retrieve the value of the stored secret as a SecretValue.

---

stack

Type: Stack

The stack in which this resource is defined.

---

encryptionKey?

Type: IKey (optional)

The customer-managed encryption key that is used to encrypt this secret, if any.

When not specified, the default KMS key for the account and region is being used.

---

secretFullArn?

Type: string (optional)

The full ARN of the secret in AWS Secrets Manager, which is the ARN including the Secrets Manager-supplied 6-character suffix.

This is equal to secretArn in most cases, but is undefined when a full ARN is not available (e.g., secrets imported by name).

Methods

Name	Description
addRotationSchedule(id, options)	Adds a rotation schedule to the secret.
addToResourcePolicy(statement)	Adds a statement to the IAM resource policy associated with this secret.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
attach(target)	Attach a target to this secret.
denyAccountRootDelete()	Denies the DeleteSecret action to all principals within the current account.
grantRead(grantee, versionStages?)	Grants reading the secret value to some role.
grantWrite(grantee)	Grants writing and updating the secret value to some role.
secretValueFromJson(key)	Interpret the secret as a JSON object and return a field's value from it as a SecretValue.

---

addRotationSchedule(id, options)

public addRotationSchedule(id: string, options: RotationScheduleOptions): RotationSchedule

Parameters

• id string
• options RotationScheduleOptions

Returns

• RotationSchedule

Adds a rotation schedule to the secret.

---

addToResourcePolicy(statement)

public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult

Parameters

• statement PolicyStatement

Returns

• AddToResourcePolicyResult

Adds a statement to the IAM resource policy associated with this secret.

If this secret was created in this stack, a resource policy will be automatically created upon the first call to addToResourcePolicy. If the secret is imported, then this is a no-op.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

attach(target)

public attach(target: ISecretAttachmentTarget): ISecret

Parameters

• target ISecretAttachmentTarget — The target to attach.

Returns

• ISecret

Attach a target to this secret.

---

denyAccountRootDelete()

public denyAccountRootDelete(): void

Denies the DeleteSecret action to all principals within the current account.

---

grantRead(grantee, versionStages?)

public grantRead(grantee: IGrantable, versionStages?: string[]): Grant

Parameters

• grantee IGrantable — the principal being granted permission.
• versionStages string[] — the version stages the grant is limited to.

Returns

• Grant

Grants reading the secret value to some role.

---

grantWrite(grantee)

public grantWrite(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — the principal being granted permission.

Returns

• Grant

Grants writing and updating the secret value to some role.

---

secretValueFromJson(key)

public secretValueFromJson(key: string): SecretValue

Parameters

• key string

Returns

• SecretValue

Interpret the secret as a JSON object and return a field's value from it as a SecretValue.