@cdklabs/generative-ai-cdk-constructs • Docs
@cdklabs/generative-ai-cdk-constructs / bedrock / IGuardrail
Represents a Guardrail, either created with CDK or imported.
IResource
readonlyenv: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.
IResource.env
readonlyguardrailArn:string
The ARN of the guardrail.
"arn:aws:bedrock:us-east-1:123456789012:guardrail/yympzo398ipq"
readonlyguardrailId:string
The ID of the guardrail.
"yympzo398ipq"
guardrailVersion:
string
The version of the guardrail. If no explicit version is created, this will default to “DRAFT”
readonlyoptionalkmsKey:IKey
Optional KMS encryption key associated with this guardrail
readonlynode:Node
The tree node.
IResource.node
readonlystack:Stack
The stack in which this resource is defined.
IResource.stack
applyRemovalPolicy(
policy):void
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).
• policy: RemovalPolicy
void
IResource.applyRemovalPolicy
grantApply(
grantee):Grant
Grant the given identity permissions to apply the guardrail.
• grantee: IGrantable
Grant