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

Interface IGuardrail

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IGuardrail.Jsii$Default
All Known Implementing Classes:
Guardrail, GuardrailBase, IGuardrail.Jsii$Proxy
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-09-02T11:25:42.814Z") @Stability(Experimental) public interface IGuardrail extends software.amazon.jsii.JsiiSerializable, IResource
(experimental) Represents a Guardrail, either created with CDK or imported.

  • Method Details

    • getGuardrailArn

      @Stability(Experimental) @NotNull String getGuardrailArn()
      (experimental) The ARN of the guardrail.

    • getGuardrailId

      @Stability(Experimental) @NotNull String getGuardrailId()
      (experimental) The ID of the guardrail.

    • getGuardrailVersion

      @Stability(Experimental) @NotNull String getGuardrailVersion()
      (experimental) The version of the guardrail.

      If no explicit version is created, this will default to "DRAFT"

    • getKmsKey

      @Stability(Experimental) @Nullable default IKey getKmsKey()
      (experimental) Optional KMS encryption key associated with this guardrail.

    • getLastUpdated

      @Stability(Experimental) @Nullable default String getLastUpdated()
      (experimental) When this guardrail was last updated.

    • grant

      @Stability(Experimental) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      (experimental) Grant the given principal identity permissions to perform actions on this guardrail.

      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantApply

      @Stability(Experimental) @NotNull Grant grantApply(@NotNull IGrantable grantee)
      (experimental) Grant the given identity permissions to apply the guardrail.

      Parameters:
      grantee - This parameter is required.

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Return the given named metric for this guardrail.

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName)
      (experimental) Return the given named metric for this guardrail.

      Parameters:
      metricName - This parameter is required.

    • metricInvocationClientErrors

      @Stability(Experimental) @NotNull Metric metricInvocationClientErrors(@Nullable MetricOptions props)
      (experimental) Return the invocation client errors metric for this guardrail.

      Parameters:
      props -

    • metricInvocationClientErrors

      @Stability(Experimental) @NotNull Metric metricInvocationClientErrors()
      (experimental) Return the invocation client errors metric for this guardrail.

    • metricInvocationLatency

      @Stability(Experimental) @NotNull Metric metricInvocationLatency(@Nullable MetricOptions props)
      (experimental) Return the invocation latency metric for this guardrail.

      Parameters:
      props -

    • metricInvocationLatency

      @Stability(Experimental) @NotNull Metric metricInvocationLatency()
      (experimental) Return the invocation latency metric for this guardrail.

    • metricInvocations

      @Stability(Experimental) @NotNull Metric metricInvocations(@Nullable MetricOptions props)
      (experimental) Return the invocations metric for this guardrail.

      Parameters:
      props -

    • metricInvocations

      @Stability(Experimental) @NotNull Metric metricInvocations()
      (experimental) Return the invocations metric for this guardrail.

    • metricInvocationServerErrors

      @Stability(Experimental) @NotNull Metric metricInvocationServerErrors(@Nullable MetricOptions props)
      (experimental) Return the invocation server errors metric for this guardrail.

      Parameters:
      props -

    • metricInvocationServerErrors

      @Stability(Experimental) @NotNull Metric metricInvocationServerErrors()
      (experimental) Return the invocation server errors metric for this guardrail.

    • metricInvocationsIntervened

      @Stability(Experimental) @NotNull Metric metricInvocationsIntervened(@Nullable MetricOptions props)
      (experimental) Return the invocations intervened metric for this guardrail.

      Parameters:
      props -

    • metricInvocationsIntervened

      @Stability(Experimental) @NotNull Metric metricInvocationsIntervened()
      (experimental) Return the invocations intervened metric for this guardrail.

    • metricInvocationThrottles

      @Stability(Experimental) @NotNull Metric metricInvocationThrottles(@Nullable MetricOptions props)
      (experimental) Return the invocation throttles metric for this guardrail.

      Parameters:
      props -

    • metricInvocationThrottles

      @Stability(Experimental) @NotNull Metric metricInvocationThrottles()
      (experimental) Return the invocation throttles metric for this guardrail.

    • metricTextUnitCount

      @Stability(Experimental) @NotNull Metric metricTextUnitCount(@Nullable MetricOptions props)
      (experimental) Return the text unit count metric for this guardrail.

      Parameters:
      props -

    • metricTextUnitCount

      @Stability(Experimental) @NotNull Metric metricTextUnitCount()
      (experimental) Return the text unit count metric for this guardrail.