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

Class Guardrail

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.bedrock.alpha.GuardrailBase
software.amazon.awscdk.services.bedrock.alpha.Guardrail
All Implemented Interfaces:
IResource, IGuardrail, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-09-02T11:25:42.806Z") @Stability(Experimental) public class Guardrail extends GuardrailBase
(experimental) Class to create a Guardrail with CDK.

Example: 

 Guardrail guardrail = Guardrail.Builder.create(this, "bedrockGuardrails")
         .guardrailName("my-BedrockGuardrails")
         .build();
 // Add regex filter with input/output actions
 guardrail.addRegexFilter(RegexFilter.builder()
         .name("TestRegexFilter")
         .pattern("test-pattern")
         .action(GuardrailAction.ANONYMIZE)
         // below props are optional
         .description("This is a test regex filter")
         .inputAction(GuardrailAction.BLOCK)
         .inputEnabled(true)
         .outputAction(GuardrailAction.ANONYMIZE)
         .outputEnabled(true)
         .build());

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • Guardrail

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

    • Guardrail

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

    • Guardrail

      @Stability(Experimental) public Guardrail(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull GuardrailProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromCfnGuardrail

      @Stability(Experimental) @NotNull public static IGuardrail fromCfnGuardrail(@NotNull CfnGuardrail cfnGuardrail)
      (experimental) Import a low-level L1 Cfn Guardrail.

      Parameters:
      cfnGuardrail - This parameter is required.

    • fromGuardrailAttributes

      @Stability(Experimental) @NotNull public static IGuardrail fromGuardrailAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull GuardrailAttributes attrs)
      (experimental) Import a guardrail given its attributes.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • addContentFilter

      @Stability(Experimental) public void addContentFilter(@NotNull ContentFilter filter)
      (experimental) Adds a content filter to the guardrail.

      Parameters:
      filter - The content filter to add. This parameter is required.

    • addContextualGroundingFilter

      @Stability(Experimental) public void addContextualGroundingFilter(@NotNull ContextualGroundingFilter filter)
      (experimental) Adds a contextual grounding filter to the guardrail.

      Parameters:
      filter - The contextual grounding filter to add. This parameter is required.

    • addDeniedTopicFilter

      @Stability(Experimental) public void addDeniedTopicFilter(@NotNull Topic filter)
      (experimental) Adds a denied topic filter to the guardrail.

      Parameters:
      filter - The denied topic filter to add. This parameter is required.

    • addManagedWordListFilter

      @Stability(Experimental) public void addManagedWordListFilter(@NotNull ManagedWordFilter filter)
      (experimental) Adds a managed word list filter to the guardrail.

      Parameters:
      filter - The managed word list filter to add. This parameter is required.

    • addPIIFilter

      @Stability(Experimental) public void addPIIFilter(@NotNull PIIFilter filter)
      (experimental) Adds a PII filter to the guardrail.

      Parameters:
      filter - The PII filter to add. This parameter is required.

    • addRegexFilter

      @Stability(Experimental) public void addRegexFilter(@NotNull RegexFilter filter)
      (experimental) Adds a regex filter to the guardrail.

      Parameters:
      filter - The regex filter to add. This parameter is required.

    • addWordFilter

      @Stability(Experimental) public void addWordFilter(@NotNull WordFilter filter)
      (experimental) Adds a word filter to the guardrail.

      Parameters:
      filter - The word filter to add. This parameter is required.

    • addWordFilterFromFile

      @Stability(Experimental) public void addWordFilterFromFile(@NotNull String filePath, @Nullable GuardrailAction inputAction, @Nullable GuardrailAction outputAction, @Nullable Boolean inputEnabled, @Nullable Boolean outputEnabled)
      (experimental) Adds a word filter to the guardrail.

      Parameters:
      filePath - The location of the word filter file. This parameter is required.
      inputAction -
      outputAction -
      inputEnabled -
      outputEnabled -

    • addWordFilterFromFile

      @Stability(Experimental) public void addWordFilterFromFile(@NotNull String filePath, @Nullable GuardrailAction inputAction, @Nullable GuardrailAction outputAction, @Nullable Boolean inputEnabled)
      (experimental) Adds a word filter to the guardrail.

      Parameters:
      filePath - The location of the word filter file. This parameter is required.
      inputAction -
      outputAction -
      inputEnabled -

    • addWordFilterFromFile

      @Stability(Experimental) public void addWordFilterFromFile(@NotNull String filePath, @Nullable GuardrailAction inputAction, @Nullable GuardrailAction outputAction)
      (experimental) Adds a word filter to the guardrail.

      Parameters:
      filePath - The location of the word filter file. This parameter is required.
      inputAction -
      outputAction -

    • addWordFilterFromFile

      @Stability(Experimental) public void addWordFilterFromFile(@NotNull String filePath, @Nullable GuardrailAction inputAction)
      (experimental) Adds a word filter to the guardrail.

      Parameters:
      filePath - The location of the word filter file. This parameter is required.
      inputAction -

    • addWordFilterFromFile

      @Stability(Experimental) public void addWordFilterFromFile(@NotNull String filePath)
      (experimental) Adds a word filter to the guardrail.

      Parameters:
      filePath - The location of the word filter file. This parameter is required.

    • createVersion

      @Stability(Experimental) @NotNull public String createVersion(@Nullable String description)
      (experimental) Create a version for the guardrail.

      Parameters:
      description - The description of the version.
      Returns:
      The guardrail version.

    • createVersion

      @Stability(Experimental) @NotNull public String createVersion()
      (experimental) Create a version for the guardrail.

      Returns:
      The guardrail version.

    • getBlockedInputMessaging

      @Stability(Experimental) @NotNull public String getBlockedInputMessaging()
      (experimental) The message to return when the guardrail blocks a prompt.

      Default: "Sorry, your query violates our usage policy."

    • getBlockedOutputsMessaging

      @Stability(Experimental) @NotNull public String getBlockedOutputsMessaging()
      (experimental) The message to return when the guardrail blocks a model response.

      Default: "Sorry, I am unable to answer your question because of our usage policy."

    • getContentFilters

      @Stability(Experimental) @NotNull public List<ContentFilter> getContentFilters()
      (experimental) The content filters applied by the guardrail.

    • getContentFiltersTierConfig

      @Stability(Experimental) @NotNull public TierConfig getContentFiltersTierConfig()
      (experimental) The tier that your guardrail uses for content filters.

      Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows.

      Default: filters.TierConfig.CLASSIC

    • getContextualGroundingFilters

      @Stability(Experimental) @NotNull public List<ContextualGroundingFilter> getContextualGroundingFilters()
      (experimental) The contextual grounding filters applied by the guardrail.

    • getDeniedTopics

      @Stability(Experimental) @NotNull public List<Topic> getDeniedTopics()
      (experimental) The denied topic filters applied by the guardrail.

    • getGuardrailArn

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

    • getGuardrailId

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

    • getHash

      @Stability(Experimental) @NotNull public String getHash()
      (experimental) The computed hash of the guardrail properties.

    • getManagedWordListFilters

      @Stability(Experimental) @NotNull public List<ManagedWordFilter> getManagedWordListFilters()
      (experimental) The managed word list filters applied by the guardrail.

    • getName

      @Stability(Experimental) @NotNull public String getName()
      (experimental) The name of the guardrail.

    • getPiiFilters

      @Stability(Experimental) @NotNull public List<PIIFilter> getPiiFilters()
      (experimental) The PII filters applied by the guardrail.

    • getRegexFilters

      @Stability(Experimental) @NotNull public List<RegexFilter> getRegexFilters()
      (experimental) The regex filters applied by the guardrail.

    • getTopicsTierConfig

      @Stability(Experimental) @NotNull public TierConfig getTopicsTierConfig()
      (experimental) The tier that your guardrail uses for denied topic filters.

      Default: filters.TierConfig.CLASSIC

    • getWordFilters

      @Stability(Experimental) @NotNull public List<WordFilter> getWordFilters()
      (experimental) The word filters applied by the guardrail.

    • getCrossRegionConfig

      @Stability(Experimental) @Nullable public GuardrailCrossRegionConfigProperty getCrossRegionConfig()
      (experimental) The cross-region configuration for the guardrail.

    • getKmsKey

      @Stability(Experimental) @Nullable public IKey getKmsKey()
      (experimental) The KMS key used to encrypt data.

      Default: undefined - "Data is encrypted by default with a key that AWS owns and manages for you"

      Specified by:
      getKmsKey in interface IGuardrail
      Specified by:
      getKmsKey in class GuardrailBase

    • getLastUpdated

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