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

Interface IGuardrail.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IGuardrail, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IGuardrail.Jsii$Proxy
Enclosing interface:
IGuardrail
@Internal public static interface IGuardrail.Jsii$Default extends IGuardrail, IResource.Jsii$Default
Internal default implementation for IGuardrail.

  • Method Details

    • getGuardrailArn

      @Stability(Experimental) @NotNull default String getGuardrailArn()
      (experimental) The ARN of the guardrail.
      Specified by:
      getGuardrailArn in interface IGuardrail

    • getGuardrailId

      @Stability(Experimental) @NotNull default String getGuardrailId()
      (experimental) The ID of the guardrail.
      Specified by:
      getGuardrailId in interface IGuardrail

    • getGuardrailVersion

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

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

      Specified by:
      getGuardrailVersion in interface IGuardrail

    • getKmsKey

      @Stability(Experimental) @Nullable default IKey getKmsKey()
      (experimental) Optional KMS encryption key associated with this guardrail.
      Specified by:
      getKmsKey in interface IGuardrail

    • getLastUpdated

      @Stability(Experimental) @Nullable default String getLastUpdated()
      (experimental) When this guardrail was last updated.
      Specified by:
      getLastUpdated in interface IGuardrail

    • grant

      @Stability(Experimental) @NotNull default 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 default 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 default Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      (experimental) Return the given named metric for this guardrail.

      Specified by:
      metric in interface IGuardrail
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Specified by:
      metric in interface IGuardrail
      Parameters:
      metricName - This parameter is required.

    • metricInvocationClientErrors

      @Stability(Experimental) @NotNull default 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 default Metric metricInvocationClientErrors()
      (experimental) Return the invocation client errors metric for this guardrail.
      Specified by:
      metricInvocationClientErrors in interface IGuardrail

    • metricInvocationLatency

      @Stability(Experimental) @NotNull default 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 default Metric metricInvocationLatency()
      (experimental) Return the invocation latency metric for this guardrail.
      Specified by:
      metricInvocationLatency in interface IGuardrail

    • metricInvocations

      @Stability(Experimental) @NotNull default 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 default Metric metricInvocations()
      (experimental) Return the invocations metric for this guardrail.
      Specified by:
      metricInvocations in interface IGuardrail

    • metricInvocationServerErrors

      @Stability(Experimental) @NotNull default 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 default Metric metricInvocationServerErrors()
      (experimental) Return the invocation server errors metric for this guardrail.
      Specified by:
      metricInvocationServerErrors in interface IGuardrail

    • metricInvocationsIntervened

      @Stability(Experimental) @NotNull default 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 default Metric metricInvocationsIntervened()
      (experimental) Return the invocations intervened metric for this guardrail.
      Specified by:
      metricInvocationsIntervened in interface IGuardrail

    • metricInvocationThrottles

      @Stability(Experimental) @NotNull default 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 default Metric metricInvocationThrottles()
      (experimental) Return the invocation throttles metric for this guardrail.
      Specified by:
      metricInvocationThrottles in interface IGuardrail

    • metricTextUnitCount

      @Stability(Experimental) @NotNull default 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 default Metric metricTextUnitCount()
      (experimental) Return the text unit count metric for this guardrail.
      Specified by:
      metricTextUnitCount in interface IGuardrail