Guardrail class
Resource for managing an Amazon Bedrock Guardrail.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.Guardrail("example", {
contentPolicyConfig: {
filtersConfigs: [{
inputStrength: "MEDIUM",
outputStrength: "MEDIUM",
type: "HATE",
}],
tierConfigs: [{
tierName: "STANDARD",
}],
},
sensitiveInformationPolicyConfig: {
piiEntitiesConfigs: [{
action: "BLOCK",
inputAction: "BLOCK",
outputAction: "ANONYMIZE",
inputEnabled: true,
outputEnabled: true,
type: "NAME",
}],
regexesConfigs: [{
action: "BLOCK",
inputAction: "BLOCK",
outputAction: "BLOCK",
inputEnabled: true,
outputEnabled: false,
description: "example regex",
name: "regex_example",
pattern: "^\\d{3}-\\d{2}-\\d{4}$",
}],
},
topicPolicyConfig: {
tierConfigs: [{
tierName: "CLASSIC",
}],
topicsConfigs: [{
name: "investment_topic",
examples: ["Where should I invest my money ?"],
type: "DENY",
definition: "Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns .",
}],
},
wordPolicyConfig: {
managedWordListsConfigs: [{
type: "PROFANITY",
}],
wordsConfigs: [{
text: "HATE",
}],
},
name: "example",
blockedInputMessaging: "example",
blockedOutputsMessaging: "example",
description: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.Guardrail("example",
content_policy_config={
"filters_configs": [{
"input_strength": "MEDIUM",
"output_strength": "MEDIUM",
"type": "HATE",
}],
"tier_configs": [{
"tier_name": "STANDARD",
}],
},
sensitive_information_policy_config={
"pii_entities_configs": [{
"action": "BLOCK",
"input_action": "BLOCK",
"output_action": "ANONYMIZE",
"input_enabled": True,
"output_enabled": True,
"type": "NAME",
}],
"regexes_configs": [{
"action": "BLOCK",
"input_action": "BLOCK",
"output_action": "BLOCK",
"input_enabled": True,
"output_enabled": False,
"description": "example regex",
"name": "regex_example",
"pattern": "^\\d{3}-\\d{2}-\\d{4}$",
}],
},
topic_policy_config={
"tier_configs": [{
"tier_name": "CLASSIC",
}],
"topics_configs": [{
"name": "investment_topic",
"examples": ["Where should I invest my money ?"],
"type": "DENY",
"definition": "Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns .",
}],
},
word_policy_config={
"managed_word_lists_configs": [{
"type": "PROFANITY",
}],
"words_configs": [{
"text": "HATE",
}],
},
name="example",
blocked_input_messaging="example",
blocked_outputs_messaging="example",
description="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Bedrock.Guardrail("example", new()
{
ContentPolicyConfig = new Aws.Bedrock.Inputs.GuardrailContentPolicyConfigArgs
{
FiltersConfigs = new[]
{
new Aws.Bedrock.Inputs.GuardrailContentPolicyConfigFiltersConfigArgs
{
InputStrength = "MEDIUM",
OutputStrength = "MEDIUM",
Type = "HATE",
},
},
TierConfigs = new[]
{
new Aws.Bedrock.Inputs.GuardrailContentPolicyConfigTierConfigArgs
{
TierName = "STANDARD",
},
},
},
SensitiveInformationPolicyConfig = new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigArgs
{
PiiEntitiesConfigs = new[]
{
new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs
{
Action = "BLOCK",
InputAction = "BLOCK",
OutputAction = "ANONYMIZE",
InputEnabled = true,
OutputEnabled = true,
Type = "NAME",
},
},
RegexesConfigs = new[]
{
new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs
{
Action = "BLOCK",
InputAction = "BLOCK",
OutputAction = "BLOCK",
InputEnabled = true,
OutputEnabled = false,
Description = "example regex",
Name = "regex_example",
Pattern = "^\\d{3}-\\d{2}-\\d{4}$",
},
},
},
TopicPolicyConfig = new Aws.Bedrock.Inputs.GuardrailTopicPolicyConfigArgs
{
TierConfigs = new[]
{
new Aws.Bedrock.Inputs.GuardrailTopicPolicyConfigTierConfigArgs
{
TierName = "CLASSIC",
},
},
TopicsConfigs = new[]
{
new Aws.Bedrock.Inputs.GuardrailTopicPolicyConfigTopicsConfigArgs
{
Name = "investment_topic",
Examples = new[]
{
"Where should I invest my money ?",
},
Type = "DENY",
Definition = "Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns .",
},
},
},
WordPolicyConfig = new Aws.Bedrock.Inputs.GuardrailWordPolicyConfigArgs
{
ManagedWordListsConfigs = new[]
{
new Aws.Bedrock.Inputs.GuardrailWordPolicyConfigManagedWordListsConfigArgs
{
Type = "PROFANITY",
},
},
WordsConfigs = new[]
{
new Aws.Bedrock.Inputs.GuardrailWordPolicyConfigWordsConfigArgs
{
Text = "HATE",
},
},
},
Name = "example",
BlockedInputMessaging = "example",
BlockedOutputsMessaging = "example",
Description = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewGuardrail(ctx, "example", &bedrock.GuardrailArgs{
ContentPolicyConfig: &bedrock.GuardrailContentPolicyConfigArgs{
FiltersConfigs: bedrock.GuardrailContentPolicyConfigFiltersConfigArray{
&bedrock.GuardrailContentPolicyConfigFiltersConfigArgs{
InputStrength: pulumi.String("MEDIUM"),
OutputStrength: pulumi.String("MEDIUM"),
Type: pulumi.String("HATE"),
},
},
TierConfigs: bedrock.GuardrailContentPolicyConfigTierConfigArray{
&bedrock.GuardrailContentPolicyConfigTierConfigArgs{
TierName: pulumi.String("STANDARD"),
},
},
},
SensitiveInformationPolicyConfig: &bedrock.GuardrailSensitiveInformationPolicyConfigArgs{
PiiEntitiesConfigs: bedrock.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArray{
&bedrock.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs{
Action: pulumi.String("BLOCK"),
InputAction: pulumi.String("BLOCK"),
OutputAction: pulumi.String("ANONYMIZE"),
InputEnabled: pulumi.Bool(true),
OutputEnabled: pulumi.Bool(true),
Type: pulumi.String("NAME"),
},
},
RegexesConfigs: bedrock.GuardrailSensitiveInformationPolicyConfigRegexesConfigArray{
&bedrock.GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs{
Action: pulumi.String("BLOCK"),
InputAction: pulumi.String("BLOCK"),
OutputAction: pulumi.String("BLOCK"),
InputEnabled: pulumi.Bool(true),
OutputEnabled: pulumi.Bool(false),
Description: pulumi.String("example regex"),
Name: pulumi.String("regex_example"),
Pattern: pulumi.String("^\\d{3}-\\d{2}-\\d{4}$"),
},
},
},
TopicPolicyConfig: &bedrock.GuardrailTopicPolicyConfigArgs{
TierConfigs: bedrock.GuardrailTopicPolicyConfigTierConfigArray{
&bedrock.GuardrailTopicPolicyConfigTierConfigArgs{
TierName: pulumi.String("CLASSIC"),
},
},
TopicsConfigs: bedrock.GuardrailTopicPolicyConfigTopicsConfigArray{
&bedrock.GuardrailTopicPolicyConfigTopicsConfigArgs{
Name: pulumi.String("investment_topic"),
Examples: pulumi.StringArray{
pulumi.String("Where should I invest my money ?"),
},
Type: pulumi.String("DENY"),
Definition: pulumi.String("Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns ."),
},
},
},
WordPolicyConfig: &bedrock.GuardrailWordPolicyConfigArgs{
ManagedWordListsConfigs: bedrock.GuardrailWordPolicyConfigManagedWordListsConfigArray{
&bedrock.GuardrailWordPolicyConfigManagedWordListsConfigArgs{
Type: pulumi.String("PROFANITY"),
},
},
WordsConfigs: bedrock.GuardrailWordPolicyConfigWordsConfigArray{
&bedrock.GuardrailWordPolicyConfigWordsConfigArgs{
Text: pulumi.String("HATE"),
},
},
},
Name: pulumi.String("example"),
BlockedInputMessaging: pulumi.String("example"),
BlockedOutputsMessaging: pulumi.String("example"),
Description: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_bedrock_guardrail" "example" {
content_policy_config = {
filters_configs = [{
"inputStrength" = "MEDIUM"
"outputStrength" = "MEDIUM"
"type" = "HATE"
}]
tier_configs = [{
"tierName" = "STANDARD"
}]
}
sensitive_information_policy_config = {
pii_entities_configs = [{
"action" = "BLOCK"
"inputAction" = "BLOCK"
"outputAction" = "ANONYMIZE"
"inputEnabled" = true
"outputEnabled" = true
"type" = "NAME"
}]
regexes_configs = [{
"action" = "BLOCK"
"inputAction" = "BLOCK"
"outputAction" = "BLOCK"
"inputEnabled" = true
"outputEnabled" = false
"description" = "example regex"
"name" = "regex_example"
"pattern" = "^\\d{3}-\\d{2}-\\d{4}$"
}]
}
topic_policy_config = {
tier_configs = [{
"tierName" = "CLASSIC"
}]
topics_configs = [{
"name" = "investment_topic"
"examples" = ["Where should I invest my money ?"]
"type" = "DENY"
"definition" = "Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns ."
}]
}
word_policy_config = {
managed_word_lists_configs = [{
"type" = "PROFANITY"
}]
words_configs = [{
"text" = "HATE"
}]
}
name = "example"
blocked_input_messaging = "example"
blocked_outputs_messaging = "example"
description = "example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.Guardrail;
import com.pulumi.aws.bedrock.GuardrailArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailContentPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailContentPolicyConfigFiltersConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailContentPolicyConfigTierConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailSensitiveInformationPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailTopicPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailTopicPolicyConfigTierConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailTopicPolicyConfigTopicsConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailWordPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailWordPolicyConfigManagedWordListsConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailWordPolicyConfigWordsConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Guardrail("example", GuardrailArgs.builder()
.contentPolicyConfig(GuardrailContentPolicyConfigArgs.builder()
.filtersConfigs(GuardrailContentPolicyConfigFiltersConfigArgs.builder()
.inputStrength("MEDIUM")
.outputStrength("MEDIUM")
.type("HATE")
.build())
.tierConfigs(GuardrailContentPolicyConfigTierConfigArgs.builder()
.tierName("STANDARD")
.build())
.build())
.sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfigArgs.builder()
.piiEntitiesConfigs(GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs.builder()
.action("BLOCK")
.inputAction("BLOCK")
.outputAction("ANONYMIZE")
.inputEnabled(true)
.outputEnabled(true)
.type("NAME")
.build())
.regexesConfigs(GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs.builder()
.action("BLOCK")
.inputAction("BLOCK")
.outputAction("BLOCK")
.inputEnabled(true)
.outputEnabled(false)
.description("example regex")
.name("regex_example")
.pattern("^\\d{3}-\\d{2}-\\d{4}$")
.build())
.build())
.topicPolicyConfig(GuardrailTopicPolicyConfigArgs.builder()
.tierConfigs(GuardrailTopicPolicyConfigTierConfigArgs.builder()
.tierName("CLASSIC")
.build())
.topicsConfigs(GuardrailTopicPolicyConfigTopicsConfigArgs.builder()
.name("investment_topic")
.examples("Where should I invest my money ?")
.type("DENY")
.definition("Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns .")
.build())
.build())
.wordPolicyConfig(GuardrailWordPolicyConfigArgs.builder()
.managedWordListsConfigs(GuardrailWordPolicyConfigManagedWordListsConfigArgs.builder()
.type("PROFANITY")
.build())
.wordsConfigs(GuardrailWordPolicyConfigWordsConfigArgs.builder()
.text("HATE")
.build())
.build())
.name("example")
.blockedInputMessaging("example")
.blockedOutputsMessaging("example")
.description("example")
.build());
}
}
resources:
example:
type: aws:bedrock:Guardrail
properties:
contentPolicyConfig:
filtersConfigs:
- inputStrength: MEDIUM
outputStrength: MEDIUM
type: HATE
tierConfigs:
- tierName: STANDARD
sensitiveInformationPolicyConfig:
piiEntitiesConfigs:
- action: BLOCK
inputAction: BLOCK
outputAction: ANONYMIZE
inputEnabled: true
outputEnabled: true
type: NAME
regexesConfigs:
- action: BLOCK
inputAction: BLOCK
outputAction: BLOCK
inputEnabled: true
outputEnabled: false
description: example regex
name: regex_example
pattern: ^\d{3}-\d{2}-\d{4}$
topicPolicyConfig:
tierConfigs:
- tierName: CLASSIC
topicsConfigs:
- name: investment_topic
examples:
- Where should I invest my money ?
type: DENY
definition: Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns .
wordPolicyConfig:
managedWordListsConfigs:
- type: PROFANITY
wordsConfigs:
- text: HATE
name: example
blockedInputMessaging: example
blockedOutputsMessaging: example
description: example
Import
Using pulumi import, import Amazon Bedrock Guardrail using using a comma-delimited string of guardrailId and version. For example:
$ pulumi import aws:bedrock/guardrail:Guardrail example guardrail-id-12345678,DRAFT
Constructors
- Guardrail(String name, {GuardrailArgs? args, CustomResourceOptions? options})
-
Creates a new Guardrail.
nameThe Pulumi resource name.argsArguments used to configure this Guardrail. The set of arguments for Guardrail.optionsResource options controlling this resource's behavior. - Guardrail.reference(String urn)
- Creates a typed reference to an existing Guardrail resource.
Properties
-
blockedInputMessaging
↔ Output<
String> -
Message to return when the guardrail blocks a prompt.
latefinal
-
blockedOutputsMessaging
↔ Output<
String> -
Message to return when the guardrail blocks a model response.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
contentPolicyConfig
↔ Output<
GuardrailContentPolicyConfig?> -
Content policy config for a guardrail. See Content Policy Config for more information.
latefinal
-
contextualGroundingPolicyConfig
↔ Output<
GuardrailContextualGroundingPolicyConfig?> -
Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
latefinal
-
createdAt
↔ Output<
String> -
Unix epoch timestamp in seconds for when the Guardrail was created.
latefinal
-
crossRegionConfig
↔ Output<
GuardrailCrossRegionConfig?> -
latefinal
-
description
↔ Output<
String> -
Description of the guardrail or its version.
latefinal
-
guardrailArn
↔ Output<
String> -
ARN of the Guardrail.
latefinal
-
guardrailId
↔ Output<
String> -
ID of the Guardrail.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyArn
↔ Output<
String?> -
The KMS key with which the guardrail was encrypted at rest.
latefinal
-
name
↔ Output<
String> -
Name of the guardrail.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sensitiveInformationPolicyConfig
↔ Output<
GuardrailSensitiveInformationPolicyConfig?> -
Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
latefinal
-
status
↔ Output<
String> -
Status of the Bedrock Guardrail. One of
READY,FAILED.latefinal -
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
latefinal
-
timeouts
↔ Output<
GuardrailTimeouts?> -
latefinal
-
topicPolicyConfig
↔ Output<
GuardrailTopicPolicyConfig?> -
Topic policy config for a guardrail. See Topic Policy Config for more information.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
updatedAt
↔ Output<
String> -
Date and time that the Guardrail list was last updated.
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
-
version
↔ Output<
String> -
Version of the Guardrail.
latefinal
-
wordPolicyConfig
↔ Output<
GuardrailWordPolicyConfig?> -
Word policy config for a guardrail. See Word Policy Config for more information.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited