class ResourcePolicy (construct)
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.SecretsManager.ResourcePolicy |
 Java | software.amazon.awscdk.services.secretsmanager.ResourcePolicy |
 Python | aws_cdk.aws_secretsmanager.ResourcePolicy |
 TypeScript (source) | @aws-cdk/aws-secretsmanager » ResourcePolicy |
Implements
IConstruct, IConstruct, IDependable, IResource
Resource Policy for SecretsManager Secrets.
Policies define the operations that are allowed on this resource.
You almost never need to define this construct directly.
All AWS resources that support resource policies have a method called
addToResourcePolicy(), which will automatically create a new resource
policy if one doesn't exist yet, otherwise it will add to the existing
policy.
Prefer to use addToResourcePolicy() instead.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as secretsmanager from '@aws-cdk/aws-secretsmanager';
declare const secret: secretsmanager.Secret;
const resourcePolicy = new secretsmanager.ResourcePolicy(this, 'MyResourcePolicy', {
secret: secret,
});
Initializer
new ResourcePolicy(scope: Construct, id: string, props: ResourcePolicyProps)
Parameters
- scope
Construct - id
string - props
ResourcePolicy Props
Construct Props
| Name | Type | Description |
|---|---|---|
| secret | ISecret | The secret to attach a resource-based permissions policy. |
secret
Type:
ISecret
The secret to attach a resource-based permissions policy.
Properties
| Name | Type | Description |
|---|---|---|
| document | Policy | The IAM policy document for this policy. |
| env | Resource | The environment this resource belongs to. |
| node | Construct | The construct tree node associated with this construct. |
| stack | Stack | The stack in which this resource is defined. |
document
Type:
Policy
The IAM policy document for this policy.
env
Type:
Resource
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:
Construct
The construct tree node associated with this construct.
stack
Type:
Stack
The stack in which this resource is defined.
Methods
| Name | Description |
|---|---|
| apply | Apply the given removal policy to this resource. |
| to | Returns a string representation of this construct. |
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).
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.