Package software.amazon.awscdk.services.bedrock

Interface CfnGuardrailProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGuardrailProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-15T14:51:52.957Z")
@Stability(Stable)
public interface CfnGuardrailProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGuardrail.

Example:

 import software.amazon.awscdk.services.bedrock.*;
 // Import a guardrail created through the L1 CDK CfnGuardrail construct
 CfnGuardrail l1guardrail = CfnGuardrail.Builder.create(this, "MyCfnGuardrail")
         .blockedInputMessaging("blockedInputMessaging")
         .blockedOutputsMessaging("blockedOutputsMessaging")
         .name("namemycfnguardrails")
         .wordPolicyConfig(WordPolicyConfigProperty.builder()
                 .wordsConfig(List.of(WordConfigProperty.builder()
                         .text("drugs")
                         .build()))
                 .build())
         .build();
 IGuardrail importedGuardrail = Guardrail.fromCfnGuardrail(l1guardrail);
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGuardrailProps.Builder	A builder for CfnGuardrailProps
static final class	CfnGuardrailProps.Jsii$Proxy	An implementation for CfnGuardrailProps

Method Summary

Modifier and Type	Method	Description
static CfnGuardrailProps.Builder	builder()
String	getBlockedInputMessaging()	The message to return when the guardrail blocks a prompt.
String	getBlockedOutputsMessaging()	The message to return when the guardrail blocks a model response.
default Object	getContentPolicyConfig()	The content filter policies to configure for the guardrail.
default Object	getContextualGroundingPolicyConfig()	Contextual grounding policy config for a guardrail.
default Object	getCrossRegionConfig()	The system-defined guardrail profile that you're using with your guardrail.
default String	getDescription()	A description of the guardrail.
default String	getKmsKeyArn()	The ARN of the AWS KMS key that you use to encrypt the guardrail.
String	getName()	The name of the guardrail.
default Object	getSensitiveInformationPolicyConfig()	The sensitive information policy to configure for the guardrail.
default List<CfnTag>	getTags()	The tags that you want to attach to the guardrail.
default Object	getTopicPolicyConfig()	The topic policies to configure for the guardrail.
default Object	getWordPolicyConfig()	The word policy you configure for the guardrail.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBlockedInputMessaging

@Stability(Stable)
@NotNull
String getBlockedInputMessaging()

The message to return when the guardrail blocks a prompt.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedinputmessaging

getBlockedOutputsMessaging

@Stability(Stable)
@NotNull
String getBlockedOutputsMessaging()

The message to return when the guardrail blocks a model response.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedoutputsmessaging

getName

@Stability(Stable)
@NotNull
String getName()

The name of the guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-name

getContentPolicyConfig

@Stability(Stable)
@Nullable
default Object getContentPolicyConfig()

The content filter policies to configure for the guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contentpolicyconfig

getContextualGroundingPolicyConfig

@Stability(Stable)
@Nullable
default Object getContextualGroundingPolicyConfig()

Contextual grounding policy config for a guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contextualgroundingpolicyconfig

getCrossRegionConfig

@Stability(Stable)
@Nullable
default Object getCrossRegionConfig()

The system-defined guardrail profile that you're using with your guardrail.

Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.

For more information, see the Amazon Bedrock User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-crossregionconfig

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-description

getKmsKeyArn

@Stability(Stable)
@Nullable
default String getKmsKeyArn()

The ARN of the AWS KMS key that you use to encrypt the guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-kmskeyarn

getSensitiveInformationPolicyConfig

@Stability(Stable)
@Nullable
default Object getSensitiveInformationPolicyConfig()

The sensitive information policy to configure for the guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags that you want to attach to the guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-tags

getTopicPolicyConfig

@Stability(Stable)
@Nullable
default Object getTopicPolicyConfig()

The topic policies to configure for the guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-topicpolicyconfig

getWordPolicyConfig

@Stability(Stable)
@Nullable
default Object getWordPolicyConfig()

The word policy you configure for the guardrail.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-wordpolicyconfig

builder

@Stability(Stable)
static CfnGuardrailProps.Builder builder()

Returns:

a CfnGuardrailProps.Builder of CfnGuardrailProps