Abstract Class: GuardrailBase

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns

ResourceEnvironment

The environment this resource belongs to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Implementation of

IGuardrail.env

Inherited from

Resource.env

physicalName

Get Signature

get protected 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:

a concrete value (e.g. "my-awesome-bucket")
undefined, when a name should be generated by CloudFormation
a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns

string

Inherited from

Resource.physicalName

stack

Get Signature

get stack(): Stack

The stack in which this resource is defined.

Returns

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

grant()

grant(grantee, ...actions): Grant

Grant the given principal identity permissions to perform actions on this agent alias.

Parameters

grantee

IGrantable

actions

...string[]

Returns

Grant

Implementation of

IGuardrail.grant

grantApply()

grantApply(grantee): Grant

Grant the given identity permissions to apply the guardrail.

Parameters

grantee

IGrantable

Returns

Grant

Implementation of

IGuardrail.grantApply

metric()

metric(metricName, props?): Metric

Return the given named metric for this guardrail.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

Parameters

metricName

string

props?

MetricOptions

Returns

Metric

Implementation of

IGuardrail.metric

metricInvocationClientErrors()

metricInvocationClientErrors(props?): Metric

Return the invocation client errors metric for this guardrail.

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

IGuardrail.metricInvocationClientErrors

metricInvocationLatency()

metricInvocationLatency(props?): Metric

Return the invocation latency metric for this guardrail.

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

IGuardrail.metricInvocationLatency

metricInvocations()

metricInvocations(props?): Metric

Return the invocations metric for this guardrail.

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

IGuardrail.metricInvocations

metricInvocationServerErrors()

metricInvocationServerErrors(props?): Metric

Return the invocation server errors metric for this guardrail.

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

IGuardrail.metricInvocationServerErrors

metricInvocationsIntervened()

metricInvocationsIntervened(props?): Metric

Return the invocations intervened metric for this guardrail.

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

IGuardrail.metricInvocationsIntervened

metricInvocationThrottles()

metricInvocationThrottles(props?): Metric

Return the invocation throttles metric for this guardrail.

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

IGuardrail.metricInvocationThrottles

metricTextUnitCount()

metricTextUnitCount(props?): Metric

Return the text unit count metric for this guardrail.

Parameters

props?

MetricOptions

Returns

Metric

Implementation of

IGuardrail.metricTextUnitCount

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

Resource.toString

with()

with(...mixins): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters

mixins

...IMixin[]

The mixins to apply

Returns

IConstruct

This construct for chaining

Implementation of

IGuardrail.with

Inherited from

Resource.with

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.

static isOwnedResource(construct): boolean

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

static isResource(construct): construct is Resource

Check whether the given construct is a Resource

static metricAll(metricName, props?): Metric

Return the given named metric for all guardrails.

By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

static metricAllInvocationLatency(props?): Metric

Return the invocation latency metric for all guardrails.

static metricAllInvocations(props?): Metric

Return the invocations metric for all guardrails.

static metricAllInvocationsIntervened(props?): Metric

Return the invocations intervened metric for all guardrails.

static metricAllTextUnitCount(props?): Metric

Return the text unit count metric for all guardrails.