Package software.amazon.awscdk.services.bedrock.alpha

Class GuardrailBase

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.bedrock.alpha.GuardrailBase

All Implemented Interfaces:

IResource, IGuardrail, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

Guardrail

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:42.808Z")
@Stability(Experimental)
public abstract class GuardrailBase
extends Resource
implements IGuardrail

(experimental) Abstract base class for a Guardrail.

Contains methods and attributes valid for Guardrails either created with CDK or imported.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.bedrock.alpha.IGuardrail

IGuardrail.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GuardrailBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GuardrailBase(software.amazon.jsii.JsiiObjectRef objRef)
protected	GuardrailBase(software.constructs.Construct scope, String id)
protected	GuardrailBase(software.constructs.Construct scope, String id, ResourceProps props)

Method Summary

Modifier and Type	Method	Description
abstract String	getGuardrailArn()	(experimental) The ARN of the guardrail.
abstract String	getGuardrailId()	(experimental) The ID of the guardrail.
String	getGuardrailVersion()	(experimental) The version of the guardrail.
abstract IKey	getKmsKey()	(experimental) Optional KMS encryption key associated with this guardrail.
abstract String	getLastUpdated()	(experimental) When this guardrail was last updated.
Grant	grant(IGrantable grantee, String... actions)	(experimental) Grant the given principal identity permissions to perform actions on this guardrail.
Grant	grantApply(IGrantable grantee)	(experimental) Grant the given identity permissions to apply the guardrail.
Metric	metric(String metricName)	(experimental) Return the given named metric for this guardrail.
Metric	metric(String metricName, MetricOptions props)	(experimental) Return the given named metric for this guardrail.
static Metric	metricAll(String metricName)	(experimental) Return the given named metric for all guardrails.
static Metric	metricAll(String metricName, MetricOptions props)	(experimental) Return the given named metric for all guardrails.
static Metric	metricAllInvocationLatency()	(experimental) Return the invocation latency metric for all guardrails.
static Metric	metricAllInvocationLatency(MetricOptions props)	(experimental) Return the invocation latency metric for all guardrails.
static Metric	metricAllInvocations()	(experimental) Return the invocations metric for all guardrails.
static Metric	metricAllInvocations(MetricOptions props)	(experimental) Return the invocations metric for all guardrails.
static Metric	metricAllInvocationsIntervened()	(experimental) Return the invocations intervened metric for all guardrails.
static Metric	metricAllInvocationsIntervened(MetricOptions props)	(experimental) Return the invocations intervened metric for all guardrails.
static Metric	metricAllTextUnitCount()	(experimental) Return the text unit count metric for all guardrails.
static Metric	metricAllTextUnitCount(MetricOptions props)	(experimental) Return the text unit count metric for all guardrails.
Metric	metricInvocationClientErrors()	(experimental) Return the invocation client errors metric for this guardrail.
Metric	metricInvocationClientErrors(MetricOptions props)	(experimental) Return the invocation client errors metric for this guardrail.
Metric	metricInvocationLatency()	(experimental) Return the invocation latency metric for this guardrail.
Metric	metricInvocationLatency(MetricOptions props)	(experimental) Return the invocation latency metric for this guardrail.
Metric	metricInvocations()	(experimental) Return the invocations metric for this guardrail.
Metric	metricInvocations(MetricOptions props)	(experimental) Return the invocations metric for this guardrail.
Metric	metricInvocationServerErrors()	(experimental) Return the invocation server errors metric for this guardrail.
Metric	metricInvocationServerErrors(MetricOptions props)	(experimental) Return the invocation server errors metric for this guardrail.
Metric	metricInvocationsIntervened()	(experimental) Return the invocations intervened metric for this guardrail.
Metric	metricInvocationsIntervened(MetricOptions props)	(experimental) Return the invocations intervened metric for this guardrail.
Metric	metricInvocationThrottles()	(experimental) Return the invocation throttles metric for this guardrail.
Metric	metricInvocationThrottles(MetricOptions props)	(experimental) Return the invocation throttles metric for this guardrail.
Metric	metricTextUnitCount()	(experimental) Return the text unit count metric for this guardrail.
Metric	metricTextUnitCount(MetricOptions props)	(experimental) Return the text unit count metric for this guardrail.
protected void	updateVersion(String version)

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

GuardrailBase

protected GuardrailBase(software.amazon.jsii.JsiiObjectRef objRef)

GuardrailBase

protected GuardrailBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GuardrailBase

@Stability(Stable)
protected GuardrailBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 ResourceProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

GuardrailBase

@Stability(Stable)
protected GuardrailBase(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

metricAll

@Stability(Experimental)
@NotNull
public static Metric metricAll(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

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

Parameters:

metricName - This parameter is required.

props -

metricAll

@Stability(Experimental)
@NotNull
public static Metric metricAll(@NotNull
 String metricName)

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

Parameters:

metricName - This parameter is required.

metricAllInvocationLatency

@Stability(Experimental)
@NotNull
public static Metric metricAllInvocationLatency(@Nullable
 MetricOptions props)

(experimental) Return the invocation latency metric for all guardrails.

Parameters:

props -

metricAllInvocationLatency

@Stability(Experimental)
@NotNull
public static Metric metricAllInvocationLatency()

(experimental) Return the invocation latency metric for all guardrails.

metricAllInvocations

@Stability(Experimental)
@NotNull
public static Metric metricAllInvocations(@Nullable
 MetricOptions props)

(experimental) Return the invocations metric for all guardrails.

Parameters:

props -

metricAllInvocations

@Stability(Experimental)
@NotNull
public static Metric metricAllInvocations()

(experimental) Return the invocations metric for all guardrails.

metricAllInvocationsIntervened

@Stability(Experimental)
@NotNull
public static Metric metricAllInvocationsIntervened(@Nullable
 MetricOptions props)

(experimental) Return the invocations intervened metric for all guardrails.

Parameters:

props -

metricAllInvocationsIntervened

@Stability(Experimental)
@NotNull
public static Metric metricAllInvocationsIntervened()

(experimental) Return the invocations intervened metric for all guardrails.

metricAllTextUnitCount

@Stability(Experimental)
@NotNull
public static Metric metricAllTextUnitCount(@Nullable
 MetricOptions props)

(experimental) Return the text unit count metric for all guardrails.

Parameters:

props -

metricAllTextUnitCount

@Stability(Experimental)
@NotNull
public static Metric metricAllTextUnitCount()

(experimental) Return the text unit count metric for all guardrails.

grant

@Stability(Experimental)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

(experimental) Grant the given principal identity permissions to perform actions on this guardrail.

Specified by:

grant in interface IGuardrail

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantApply

@Stability(Experimental)
@NotNull
public Grant grantApply(@NotNull
 IGrantable grantee)

(experimental) Grant the given identity permissions to apply the guardrail.

Specified by:

grantApply in interface IGuardrail

Parameters:

grantee - This parameter is required.

metric

@Stability(Experimental)
@NotNull
public Metric metric(@NotNull
 String metricName,
 @Nullable
 MetricOptions props)

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

Specified by:

metric in interface IGuardrail

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(Experimental)
@NotNull
public Metric metric(@NotNull
 String metricName)

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

Specified by:

metric in interface IGuardrail

Parameters:

metricName - This parameter is required.

metricInvocationClientErrors

@Stability(Experimental)
@NotNull
public Metric metricInvocationClientErrors(@Nullable
 MetricOptions props)

(experimental) Return the invocation client errors metric for this guardrail.

Specified by:

metricInvocationClientErrors in interface IGuardrail

Parameters:

props -

metricInvocationClientErrors

@Stability(Experimental)
@NotNull
public Metric metricInvocationClientErrors()

(experimental) Return the invocation client errors metric for this guardrail.

Specified by:

metricInvocationClientErrors in interface IGuardrail

metricInvocationLatency

@Stability(Experimental)
@NotNull
public Metric metricInvocationLatency(@Nullable
 MetricOptions props)

(experimental) Return the invocation latency metric for this guardrail.

Specified by:

metricInvocationLatency in interface IGuardrail

Parameters:

props -

metricInvocationLatency

@Stability(Experimental)
@NotNull
public Metric metricInvocationLatency()

(experimental) Return the invocation latency metric for this guardrail.

Specified by:

metricInvocationLatency in interface IGuardrail

metricInvocations

@Stability(Experimental)
@NotNull
public Metric metricInvocations(@Nullable
 MetricOptions props)

(experimental) Return the invocations metric for this guardrail.

Specified by:

metricInvocations in interface IGuardrail

Parameters:

props -

metricInvocations

@Stability(Experimental)
@NotNull
public Metric metricInvocations()

(experimental) Return the invocations metric for this guardrail.

Specified by:

metricInvocations in interface IGuardrail

metricInvocationServerErrors

@Stability(Experimental)
@NotNull
public Metric metricInvocationServerErrors(@Nullable
 MetricOptions props)

(experimental) Return the invocation server errors metric for this guardrail.

Specified by:

metricInvocationServerErrors in interface IGuardrail

Parameters:

props -

metricInvocationServerErrors

@Stability(Experimental)
@NotNull
public Metric metricInvocationServerErrors()

(experimental) Return the invocation server errors metric for this guardrail.

Specified by:

metricInvocationServerErrors in interface IGuardrail

metricInvocationsIntervened

@Stability(Experimental)
@NotNull
public Metric metricInvocationsIntervened(@Nullable
 MetricOptions props)

(experimental) Return the invocations intervened metric for this guardrail.

Specified by:

metricInvocationsIntervened in interface IGuardrail

Parameters:

props -

metricInvocationsIntervened

@Stability(Experimental)
@NotNull
public Metric metricInvocationsIntervened()

(experimental) Return the invocations intervened metric for this guardrail.

Specified by:

metricInvocationsIntervened in interface IGuardrail

metricInvocationThrottles

@Stability(Experimental)
@NotNull
public Metric metricInvocationThrottles(@Nullable
 MetricOptions props)

(experimental) Return the invocation throttles metric for this guardrail.

Specified by:

metricInvocationThrottles in interface IGuardrail

Parameters:

props -

metricInvocationThrottles

@Stability(Experimental)
@NotNull
public Metric metricInvocationThrottles()

(experimental) Return the invocation throttles metric for this guardrail.

Specified by:

metricInvocationThrottles in interface IGuardrail

metricTextUnitCount

@Stability(Experimental)
@NotNull
public Metric metricTextUnitCount(@Nullable
 MetricOptions props)

(experimental) Return the text unit count metric for this guardrail.

Specified by:

metricTextUnitCount in interface IGuardrail

Parameters:

props -

metricTextUnitCount

@Stability(Experimental)
@NotNull
public Metric metricTextUnitCount()

(experimental) Return the text unit count metric for this guardrail.

Specified by:

metricTextUnitCount in interface IGuardrail

updateVersion

@Stability(Experimental)
protected void updateVersion(@NotNull
 String version)

Parameters:

version - This parameter is required.

getGuardrailArn

@Stability(Experimental)
@NotNull
public abstract String getGuardrailArn()

(experimental) The ARN of the guardrail.

Specified by:

getGuardrailArn in interface IGuardrail

getGuardrailId

@Stability(Experimental)
@NotNull
public abstract String getGuardrailId()

(experimental) The ID of the guardrail.

Specified by:

getGuardrailId in interface IGuardrail

getGuardrailVersion

@Stability(Experimental)
@NotNull
public String getGuardrailVersion()

(experimental) The version of the guardrail.

Specified by:

getGuardrailVersion in interface IGuardrail

getKmsKey

@Stability(Experimental)
@Nullable
public abstract IKey getKmsKey()

(experimental) Optional KMS encryption key associated with this guardrail.

Specified by:

getKmsKey in interface IGuardrail

getLastUpdated

@Stability(Experimental)
@Nullable
public abstract String getLastUpdated()

(experimental) When this guardrail was last updated.

Specified by:

getLastUpdated in interface IGuardrail