Interface CfnGuardrailProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnGuardrailProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:05.156Z")
@Stability(Stable)
public interface CfnGuardrailProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnGuardrail
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.bedrock.*; CfnGuardrailProps cfnGuardrailProps = CfnGuardrailProps.builder() .blockedInputMessaging("blockedInputMessaging") .blockedOutputsMessaging("blockedOutputsMessaging") .name("name") // the properties below are optional .contentPolicyConfig(ContentPolicyConfigProperty.builder() .filtersConfig(List.of(ContentFilterConfigProperty.builder() .inputStrength("inputStrength") .outputStrength("outputStrength") .type("type") .build())) .build()) .contextualGroundingPolicyConfig(ContextualGroundingPolicyConfigProperty.builder() .filtersConfig(List.of(ContextualGroundingFilterConfigProperty.builder() .threshold(123) .type("type") .build())) .build()) .description("description") .kmsKeyArn("kmsKeyArn") .sensitiveInformationPolicyConfig(SensitiveInformationPolicyConfigProperty.builder() .piiEntitiesConfig(List.of(PiiEntityConfigProperty.builder() .action("action") .type("type") .build())) .regexesConfig(List.of(RegexConfigProperty.builder() .action("action") .name("name") .pattern("pattern") // the properties below are optional .description("description") .build())) .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .topicPolicyConfig(TopicPolicyConfigProperty.builder() .topicsConfig(List.of(TopicConfigProperty.builder() .definition("definition") .name("name") .type("type") // the properties below are optional .examples(List.of("examples")) .build())) .build()) .wordPolicyConfig(WordPolicyConfigProperty.builder() .managedWordListsConfig(List.of(ManagedWordsConfigProperty.builder() .type("type") .build())) .wordsConfig(List.of(WordConfigProperty.builder() .text("text") .build())) .build()) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnGuardrailProps
static final class
An implementation forCfnGuardrailProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnGuardrailProps.Builder
builder()
The message to return when the guardrail blocks a prompt.The message to return when the guardrail blocks a model response.default Object
The content filter policies to configure for the guardrail.default Object
Contextual grounding policy config for a guardrail.default String
A description of the guardrail.default String
The ARN of the AWS KMS key that you use to encrypt the guardrail.getName()
The name of the guardrail.default Object
The sensitive information policy to configure for the guardrail.getTags()
The tags that you want to attach to the guardrail.default Object
The topic policies to configure for the guardrail.default Object
The word policy you configure for the guardrail.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBlockedInputMessaging
The message to return when the guardrail blocks a prompt.- See Also:
-
getBlockedOutputsMessaging
The message to return when the guardrail blocks a model response.- See Also:
-
getName
The name of the guardrail.- See Also:
-
getContentPolicyConfig
The content filter policies to configure for the guardrail.- See Also:
-
getContextualGroundingPolicyConfig
Contextual grounding policy config for a guardrail.- See Also:
-
getDescription
A description of the guardrail.- See Also:
-
getKmsKeyArn
The ARN of the AWS KMS key that you use to encrypt the guardrail.- See Also:
-
getSensitiveInformationPolicyConfig
The sensitive information policy to configure for the guardrail.- See Also:
-
getTags
The tags that you want to attach to the guardrail.- See Also:
-
getTopicPolicyConfig
The topic policies to configure for the guardrail.- See Also:
-
getWordPolicyConfig
The word policy you configure for the guardrail.- See Also:
-
builder
- Returns:
- a
CfnGuardrailProps.Builder
ofCfnGuardrailProps
-