generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / bedrock / GuardrailBase

Class: abstract GuardrailBase

Abstract base class for a Guardrail. Contains methods and attributes valid for Guardrails either created with CDK or imported.

Extends

Extended by

Implements

Constructors

new GuardrailBase()

new GuardrailBase(scope, id, props?): GuardrailBase

Parameters

scope

Construct

id

string

props?

ResourceProps

Returns

GuardrailBase

Inherited from

Resource.constructor

Properties

env

readonly env: 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.

Implementation of

IGuardrail.env

Inherited from

Resource.env

guardrailArn

abstract readonly guardrailArn: string

The ARN of the guardrail.

Implementation of

IGuardrail.guardrailArn

guardrailId

abstract readonly guardrailId: string

The ID of the guardrail.

Implementation of

IGuardrail.guardrailId

guardrailVersion

abstract guardrailVersion: string

The ID of the guardrail.

Implementation of

IGuardrail.guardrailVersion

kmsKey?

abstract readonly optional kmsKey: IKey

The KMS key of the guardrail if custom encryption is configured.

Implementation of

IGuardrail.kmsKey

node

readonly node: Node

The tree node.

Implementation of

IGuardrail.node

Inherited from

Resource.node

physicalName

protected readonly physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

Inherited from

Resource.physicalName

stack

readonly stack: Stack

The stack in which this resource is defined.

Implementation of

IGuardrail.stack

Inherited from

Resource.stack

Methods

_enableCrossEnvironment()

_enableCrossEnvironment(): void

Internal

Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

Returns

void

Inherited from

Resource._enableCrossEnvironment

applyRemovalPolicy()

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).

Parameters

policy

RemovalPolicy

Returns

void

Implementation of

IGuardrail.applyRemovalPolicy

Inherited from

Resource.applyRemovalPolicy

generatePhysicalName()

protected generatePhysicalName(): string

Returns

string

Inherited from

Resource.generatePhysicalName

getResourceArnAttribute()

protected getResourceArnAttribute(arnAttr, arnComponents): string

Returns an environment-sensitive token that should be used for the resource’s “ARN” attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource’s physical name. Make sure to reference this.physicalName in arnComponents.

Parameters

arnAttr

string

The CFN attribute which resolves to the ARN of the resource. Commonly it will be called “Arn” (e.g. resource.attrArn), but sometimes it’s the CFN resource’s ref.

arnComponents

ArnComponents

The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

Returns

string

Inherited from

Resource.getResourceArnAttribute

getResourceNameAttribute()

protected getResourceNameAttribute(nameAttr): string

Returns an environment-sensitive token that should be used for the resource’s “name” attribute (e.g. bucket.bucketName).

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters

nameAttr

string

The CFN attribute which resolves to the resource’s name. Commonly this is the resource’s ref.

Returns

string

Inherited from

Resource.getResourceNameAttribute

grantApply()

grantApply(grantee): Grant

Grant the given identity permissions to apply the guardrail.

Parameters

grantee

IGrantable

Returns

Grant

Implementation of

IGuardrail.grantApply

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

Resource.toString

isConstruct()

static isConstruct(x): x is Construct

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x

any

Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

Resource.isConstruct

isOwnedResource()

static isOwnedResource(construct): boolean

Returns true if the construct was created by CDK, and false otherwise

Parameters

construct

IConstruct

Returns

boolean

Inherited from

Resource.isOwnedResource

isResource()

static isResource(construct): construct is Resource

Check whether the given construct is a Resource

Parameters

construct

IConstruct

Returns

construct is Resource

Inherited from

Resource.isResource

This site is open source. Improve this page.