Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. bedrock
  5. Guardrail
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.bedrock.Guardrail

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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", {
    name: "example",
    blockedInputMessaging: "example",
    blockedOutputsMessaging: "example",
    description: "example",
    contentPolicyConfig: {
        filtersConfigs: [{
            inputStrength: "MEDIUM",
            outputStrength: "MEDIUM",
            type: "HATE",
        }],
    },
    sensitiveInformationPolicyConfig: {
        piiEntitiesConfigs: [{
            action: "BLOCK",
            type: "NAME",
        }],
        regexesConfigs: [{
            action: "BLOCK",
            description: "example regex",
            name: "regex_example",
            pattern: "^\\d{3}-\\d{2}-\\d{4}$",
        }],
    },
    topicPolicyConfig: {
        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",
        }],
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.bedrock.Guardrail("example",
    name="example",
    blocked_input_messaging="example",
    blocked_outputs_messaging="example",
    description="example",
    content_policy_config={
        "filters_configs": [{
            "input_strength": "MEDIUM",
            "output_strength": "MEDIUM",
            "type": "HATE",
        }],
    },
    sensitive_information_policy_config={
        "pii_entities_configs": [{
            "action": "BLOCK",
            "type": "NAME",
        }],
        "regexes_configs": [{
            "action": "BLOCK",
            "description": "example regex",
            "name": "regex_example",
            "pattern": "^\\d{3}-\\d{2}-\\d{4}$",
        }],
    },
    topic_policy_config={
        "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",
        }],
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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{
			Name:                    pulumi.String("example"),
			BlockedInputMessaging:   pulumi.String("example"),
			BlockedOutputsMessaging: pulumi.String("example"),
			Description:             pulumi.String("example"),
			ContentPolicyConfig: &bedrock.GuardrailContentPolicyConfigArgs{
				FiltersConfigs: bedrock.GuardrailContentPolicyConfigFiltersConfigArray{
					&bedrock.GuardrailContentPolicyConfigFiltersConfigArgs{
						InputStrength:  pulumi.String("MEDIUM"),
						OutputStrength: pulumi.String("MEDIUM"),
						Type:           pulumi.String("HATE"),
					},
				},
			},
			SensitiveInformationPolicyConfig: &bedrock.GuardrailSensitiveInformationPolicyConfigArgs{
				PiiEntitiesConfigs: bedrock.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArray{
					&bedrock.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs{
						Action: pulumi.String("BLOCK"),
						Type:   pulumi.String("NAME"),
					},
				},
				RegexesConfigs: bedrock.GuardrailSensitiveInformationPolicyConfigRegexesConfigArray{
					&bedrock.GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs{
						Action:      pulumi.String("BLOCK"),
						Description: pulumi.String("example regex"),
						Name:        pulumi.String("regex_example"),
						Pattern:     pulumi.String("^\\d{3}-\\d{2}-\\d{4}$"),
					},
				},
			},
			TopicPolicyConfig: &bedrock.GuardrailTopicPolicyConfigArgs{
				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"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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()
    {
        Name = "example",
        BlockedInputMessaging = "example",
        BlockedOutputsMessaging = "example",
        Description = "example",
        ContentPolicyConfig = new Aws.Bedrock.Inputs.GuardrailContentPolicyConfigArgs
        {
            FiltersConfigs = new[]
            {
                new Aws.Bedrock.Inputs.GuardrailContentPolicyConfigFiltersConfigArgs
                {
                    InputStrength = "MEDIUM",
                    OutputStrength = "MEDIUM",
                    Type = "HATE",
                },
            },
        },
        SensitiveInformationPolicyConfig = new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigArgs
        {
            PiiEntitiesConfigs = new[]
            {
                new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs
                {
                    Action = "BLOCK",
                    Type = "NAME",
                },
            },
            RegexesConfigs = new[]
            {
                new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs
                {
                    Action = "BLOCK",
                    Description = "example regex",
                    Name = "regex_example",
                    Pattern = "^\\d{3}-\\d{2}-\\d{4}$",
                },
            },
        },
        TopicPolicyConfig = new Aws.Bedrock.Inputs.GuardrailTopicPolicyConfigArgs
        {
            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",
                },
            },
        },
    });

});

    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.GuardrailSensitiveInformationPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailTopicPolicyConfigArgs;
import com.pulumi.aws.bedrock.inputs.GuardrailWordPolicyConfigArgs;
import java.util.List;
import java.util.ArrayList;
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()
            .name("example")
            .blockedInputMessaging("example")
            .blockedOutputsMessaging("example")
            .description("example")
            .contentPolicyConfig(GuardrailContentPolicyConfigArgs.builder()
                .filtersConfigs(GuardrailContentPolicyConfigFiltersConfigArgs.builder()
                    .inputStrength("MEDIUM")
                    .outputStrength("MEDIUM")
                    .type("HATE")
                    .build())
                .build())
            .sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfigArgs.builder()
                .piiEntitiesConfigs(GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs.builder()
                    .action("BLOCK")
                    .type("NAME")
                    .build())
                .regexesConfigs(GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs.builder()
                    .action("BLOCK")
                    .description("example regex")
                    .name("regex_example")
                    .pattern("^\\d{3}-\\d{2}-\\d{4}$")
                    .build())
                .build())
            .topicPolicyConfig(GuardrailTopicPolicyConfigArgs.builder()
                .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())
            .build());

    }
}

    resources:
  example:
    type: aws:bedrock:Guardrail
    properties:
      name: example
      blockedInputMessaging: example
      blockedOutputsMessaging: example
      description: example
      contentPolicyConfig:
        filtersConfigs:
          - inputStrength: MEDIUM
            outputStrength: MEDIUM
            type: HATE
      sensitiveInformationPolicyConfig:
        piiEntitiesConfigs:
          - action: BLOCK
            type: NAME
        regexesConfigs:
          - action: BLOCK
            description: example regex
            name: regex_example
            pattern: ^\d{3}-\d{2}-\d{4}$
      topicPolicyConfig:
        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

    Create Guardrail Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Guardrail(name: string, args: GuardrailArgs, opts?: CustomResourceOptions);
    @overload
def Guardrail(resource_name: str,
              args: GuardrailArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Guardrail(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              blocked_input_messaging: Optional[str] = None,
              blocked_outputs_messaging: Optional[str] = None,
              content_policy_config: Optional[GuardrailContentPolicyConfigArgs] = None,
              contextual_grounding_policy_config: Optional[GuardrailContextualGroundingPolicyConfigArgs] = None,
              description: Optional[str] = None,
              kms_key_arn: Optional[str] = None,
              name: Optional[str] = None,
              sensitive_information_policy_config: Optional[GuardrailSensitiveInformationPolicyConfigArgs] = None,
              tags: Optional[Mapping[str, str]] = None,
              timeouts: Optional[GuardrailTimeoutsArgs] = None,
              topic_policy_config: Optional[GuardrailTopicPolicyConfigArgs] = None,
              word_policy_config: Optional[GuardrailWordPolicyConfigArgs] = None)
    func NewGuardrail(ctx *Context, name string, args GuardrailArgs, opts ...ResourceOption) (*Guardrail, error)
    public Guardrail(string name, GuardrailArgs args, CustomResourceOptions? opts = null)
    public Guardrail(String name, GuardrailArgs args)
public Guardrail(String name, GuardrailArgs args, CustomResourceOptions options)

    type: aws:bedrock:Guardrail
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var guardrailResource = new Aws.Bedrock.Guardrail("guardrailResource", new()
{
    BlockedInputMessaging = "string",
    BlockedOutputsMessaging = "string",
    ContentPolicyConfig = new Aws.Bedrock.Inputs.GuardrailContentPolicyConfigArgs
    {
        FiltersConfigs = new[]
        {
            new Aws.Bedrock.Inputs.GuardrailContentPolicyConfigFiltersConfigArgs
            {
                InputStrength = "string",
                OutputStrength = "string",
                Type = "string",
            },
        },
    },
    ContextualGroundingPolicyConfig = new Aws.Bedrock.Inputs.GuardrailContextualGroundingPolicyConfigArgs
    {
        FiltersConfigs = new[]
        {
            new Aws.Bedrock.Inputs.GuardrailContextualGroundingPolicyConfigFiltersConfigArgs
            {
                Threshold = 0,
                Type = "string",
            },
        },
    },
    Description = "string",
    KmsKeyArn = "string",
    Name = "string",
    SensitiveInformationPolicyConfig = new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigArgs
    {
        PiiEntitiesConfigs = new[]
        {
            new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs
            {
                Action = "string",
                Type = "string",
            },
        },
        RegexesConfigs = new[]
        {
            new Aws.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs
            {
                Action = "string",
                Name = "string",
                Pattern = "string",
                Description = "string",
            },
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Bedrock.Inputs.GuardrailTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    TopicPolicyConfig = new Aws.Bedrock.Inputs.GuardrailTopicPolicyConfigArgs
    {
        TopicsConfigs = new[]
        {
            new Aws.Bedrock.Inputs.GuardrailTopicPolicyConfigTopicsConfigArgs
            {
                Definition = "string",
                Name = "string",
                Type = "string",
                Examples = new[]
                {
                    "string",
                },
            },
        },
    },
    WordPolicyConfig = new Aws.Bedrock.Inputs.GuardrailWordPolicyConfigArgs
    {
        ManagedWordListsConfigs = new[]
        {
            new Aws.Bedrock.Inputs.GuardrailWordPolicyConfigManagedWordListsConfigArgs
            {
                Type = "string",
            },
        },
        WordsConfigs = new[]
        {
            new Aws.Bedrock.Inputs.GuardrailWordPolicyConfigWordsConfigArgs
            {
                Text = "string",
            },
        },
    },
});

    example, err := bedrock.NewGuardrail(ctx, "guardrailResource", &bedrock.GuardrailArgs{
	BlockedInputMessaging:   pulumi.String("string"),
	BlockedOutputsMessaging: pulumi.String("string"),
	ContentPolicyConfig: &bedrock.GuardrailContentPolicyConfigArgs{
		FiltersConfigs: bedrock.GuardrailContentPolicyConfigFiltersConfigArray{
			&bedrock.GuardrailContentPolicyConfigFiltersConfigArgs{
				InputStrength:  pulumi.String("string"),
				OutputStrength: pulumi.String("string"),
				Type:           pulumi.String("string"),
			},
		},
	},
	ContextualGroundingPolicyConfig: &bedrock.GuardrailContextualGroundingPolicyConfigArgs{
		FiltersConfigs: bedrock.GuardrailContextualGroundingPolicyConfigFiltersConfigArray{
			&bedrock.GuardrailContextualGroundingPolicyConfigFiltersConfigArgs{
				Threshold: pulumi.Float64(0),
				Type:      pulumi.String("string"),
			},
		},
	},
	Description: pulumi.String("string"),
	KmsKeyArn:   pulumi.String("string"),
	Name:        pulumi.String("string"),
	SensitiveInformationPolicyConfig: &bedrock.GuardrailSensitiveInformationPolicyConfigArgs{
		PiiEntitiesConfigs: bedrock.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArray{
			&bedrock.GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs{
				Action: pulumi.String("string"),
				Type:   pulumi.String("string"),
			},
		},
		RegexesConfigs: bedrock.GuardrailSensitiveInformationPolicyConfigRegexesConfigArray{
			&bedrock.GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs{
				Action:      pulumi.String("string"),
				Name:        pulumi.String("string"),
				Pattern:     pulumi.String("string"),
				Description: pulumi.String("string"),
			},
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &bedrock.GuardrailTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	TopicPolicyConfig: &bedrock.GuardrailTopicPolicyConfigArgs{
		TopicsConfigs: bedrock.GuardrailTopicPolicyConfigTopicsConfigArray{
			&bedrock.GuardrailTopicPolicyConfigTopicsConfigArgs{
				Definition: pulumi.String("string"),
				Name:       pulumi.String("string"),
				Type:       pulumi.String("string"),
				Examples: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	WordPolicyConfig: &bedrock.GuardrailWordPolicyConfigArgs{
		ManagedWordListsConfigs: bedrock.GuardrailWordPolicyConfigManagedWordListsConfigArray{
			&bedrock.GuardrailWordPolicyConfigManagedWordListsConfigArgs{
				Type: pulumi.String("string"),
			},
		},
		WordsConfigs: bedrock.GuardrailWordPolicyConfigWordsConfigArray{
			&bedrock.GuardrailWordPolicyConfigWordsConfigArgs{
				Text: pulumi.String("string"),
			},
		},
	},
})

    var guardrailResource = new Guardrail("guardrailResource", GuardrailArgs.builder()
    .blockedInputMessaging("string")
    .blockedOutputsMessaging("string")
    .contentPolicyConfig(GuardrailContentPolicyConfigArgs.builder()
        .filtersConfigs(GuardrailContentPolicyConfigFiltersConfigArgs.builder()
            .inputStrength("string")
            .outputStrength("string")
            .type("string")
            .build())
        .build())
    .contextualGroundingPolicyConfig(GuardrailContextualGroundingPolicyConfigArgs.builder()
        .filtersConfigs(GuardrailContextualGroundingPolicyConfigFiltersConfigArgs.builder()
            .threshold(0)
            .type("string")
            .build())
        .build())
    .description("string")
    .kmsKeyArn("string")
    .name("string")
    .sensitiveInformationPolicyConfig(GuardrailSensitiveInformationPolicyConfigArgs.builder()
        .piiEntitiesConfigs(GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs.builder()
            .action("string")
            .type("string")
            .build())
        .regexesConfigs(GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs.builder()
            .action("string")
            .name("string")
            .pattern("string")
            .description("string")
            .build())
        .build())
    .tags(Map.of("string", "string"))
    .timeouts(GuardrailTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .topicPolicyConfig(GuardrailTopicPolicyConfigArgs.builder()
        .topicsConfigs(GuardrailTopicPolicyConfigTopicsConfigArgs.builder()
            .definition("string")
            .name("string")
            .type("string")
            .examples("string")
            .build())
        .build())
    .wordPolicyConfig(GuardrailWordPolicyConfigArgs.builder()
        .managedWordListsConfigs(GuardrailWordPolicyConfigManagedWordListsConfigArgs.builder()
            .type("string")
            .build())
        .wordsConfigs(GuardrailWordPolicyConfigWordsConfigArgs.builder()
            .text("string")
            .build())
        .build())
    .build());

    guardrail_resource = aws.bedrock.Guardrail("guardrailResource",
    blocked_input_messaging="string",
    blocked_outputs_messaging="string",
    content_policy_config={
        "filters_configs": [{
            "input_strength": "string",
            "output_strength": "string",
            "type": "string",
        }],
    },
    contextual_grounding_policy_config={
        "filters_configs": [{
            "threshold": 0,
            "type": "string",
        }],
    },
    description="string",
    kms_key_arn="string",
    name="string",
    sensitive_information_policy_config={
        "pii_entities_configs": [{
            "action": "string",
            "type": "string",
        }],
        "regexes_configs": [{
            "action": "string",
            "name": "string",
            "pattern": "string",
            "description": "string",
        }],
    },
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    topic_policy_config={
        "topics_configs": [{
            "definition": "string",
            "name": "string",
            "type": "string",
            "examples": ["string"],
        }],
    },
    word_policy_config={
        "managed_word_lists_configs": [{
            "type": "string",
        }],
        "words_configs": [{
            "text": "string",
        }],
    })

    const guardrailResource = new aws.bedrock.Guardrail("guardrailResource", {
    blockedInputMessaging: "string",
    blockedOutputsMessaging: "string",
    contentPolicyConfig: {
        filtersConfigs: [{
            inputStrength: "string",
            outputStrength: "string",
            type: "string",
        }],
    },
    contextualGroundingPolicyConfig: {
        filtersConfigs: [{
            threshold: 0,
            type: "string",
        }],
    },
    description: "string",
    kmsKeyArn: "string",
    name: "string",
    sensitiveInformationPolicyConfig: {
        piiEntitiesConfigs: [{
            action: "string",
            type: "string",
        }],
        regexesConfigs: [{
            action: "string",
            name: "string",
            pattern: "string",
            description: "string",
        }],
    },
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    topicPolicyConfig: {
        topicsConfigs: [{
            definition: "string",
            name: "string",
            type: "string",
            examples: ["string"],
        }],
    },
    wordPolicyConfig: {
        managedWordListsConfigs: [{
            type: "string",
        }],
        wordsConfigs: [{
            text: "string",
        }],
    },
});

    type: aws:bedrock:Guardrail
properties:
    blockedInputMessaging: string
    blockedOutputsMessaging: string
    contentPolicyConfig:
        filtersConfigs:
            - inputStrength: string
              outputStrength: string
              type: string
    contextualGroundingPolicyConfig:
        filtersConfigs:
            - threshold: 0
              type: string
    description: string
    kmsKeyArn: string
    name: string
    sensitiveInformationPolicyConfig:
        piiEntitiesConfigs:
            - action: string
              type: string
        regexesConfigs:
            - action: string
              description: string
              name: string
              pattern: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    topicPolicyConfig:
        topicsConfigs:
            - definition: string
              examples:
                - string
              name: string
              type: string
    wordPolicyConfig:
        managedWordListsConfigs:
            - type: string
        wordsConfigs:
            - text: string

    Guardrail Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Guardrail resource accepts the following input properties:

    BlockedInputMessaging string
    Message to return when the guardrail blocks a prompt.
    BlockedOutputsMessaging string
    Message to return when the guardrail blocks a model response.
    ContentPolicyConfig GuardrailContentPolicyConfig
    Content policy config for a guardrail. See Content Policy Config for more information.
    ContextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfig
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    Description string
    Description of the guardrail or its version.
    KmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest.
    Name string

    Name of the guardrail.

    The following arguments are optional:

    SensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts GuardrailTimeouts
    TopicPolicyConfig GuardrailTopicPolicyConfig
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    WordPolicyConfig GuardrailWordPolicyConfig
    Word policy config for a guardrail. See Word Policy Config for more information.
    BlockedInputMessaging string
    Message to return when the guardrail blocks a prompt.
    BlockedOutputsMessaging string
    Message to return when the guardrail blocks a model response.
    ContentPolicyConfig GuardrailContentPolicyConfigArgs
    Content policy config for a guardrail. See Content Policy Config for more information.
    ContextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfigArgs
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    Description string
    Description of the guardrail or its version.
    KmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest.
    Name string

    Name of the guardrail.

    The following arguments are optional:

    SensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfigArgs
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts GuardrailTimeoutsArgs
    TopicPolicyConfig GuardrailTopicPolicyConfigArgs
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    WordPolicyConfig GuardrailWordPolicyConfigArgs
    Word policy config for a guardrail. See Word Policy Config for more information.
    blockedInputMessaging String
    Message to return when the guardrail blocks a prompt.
    blockedOutputsMessaging String
    Message to return when the guardrail blocks a model response.
    contentPolicyConfig GuardrailContentPolicyConfig
    Content policy config for a guardrail. See Content Policy Config for more information.
    contextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfig
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    description String
    Description of the guardrail or its version.
    kmsKeyArn String
    The KMS key with which the guardrail was encrypted at rest.
    name String

    Name of the guardrail.

    The following arguments are optional:

    sensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts GuardrailTimeouts
    topicPolicyConfig GuardrailTopicPolicyConfig
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    wordPolicyConfig GuardrailWordPolicyConfig
    Word policy config for a guardrail. See Word Policy Config for more information.
    blockedInputMessaging string
    Message to return when the guardrail blocks a prompt.
    blockedOutputsMessaging string
    Message to return when the guardrail blocks a model response.
    contentPolicyConfig GuardrailContentPolicyConfig
    Content policy config for a guardrail. See Content Policy Config for more information.
    contextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfig
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    description string
    Description of the guardrail or its version.
    kmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest.
    name string

    Name of the guardrail.

    The following arguments are optional:

    sensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts GuardrailTimeouts
    topicPolicyConfig GuardrailTopicPolicyConfig
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    wordPolicyConfig GuardrailWordPolicyConfig
    Word policy config for a guardrail. See Word Policy Config for more information.
    blocked_input_messaging str
    Message to return when the guardrail blocks a prompt.
    blocked_outputs_messaging str
    Message to return when the guardrail blocks a model response.
    content_policy_config GuardrailContentPolicyConfigArgs
    Content policy config for a guardrail. See Content Policy Config for more information.
    contextual_grounding_policy_config GuardrailContextualGroundingPolicyConfigArgs
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    description str
    Description of the guardrail or its version.
    kms_key_arn str
    The KMS key with which the guardrail was encrypted at rest.
    name str

    Name of the guardrail.

    The following arguments are optional:

    sensitive_information_policy_config GuardrailSensitiveInformationPolicyConfigArgs
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts GuardrailTimeoutsArgs
    topic_policy_config GuardrailTopicPolicyConfigArgs
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    word_policy_config GuardrailWordPolicyConfigArgs
    Word policy config for a guardrail. See Word Policy Config for more information.
    blockedInputMessaging String
    Message to return when the guardrail blocks a prompt.
    blockedOutputsMessaging String
    Message to return when the guardrail blocks a model response.
    contentPolicyConfig Property Map
    Content policy config for a guardrail. See Content Policy Config for more information.
    contextualGroundingPolicyConfig Property Map
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    description String
    Description of the guardrail or its version.
    kmsKeyArn String
    The KMS key with which the guardrail was encrypted at rest.
    name String

    Name of the guardrail.

    The following arguments are optional:

    sensitiveInformationPolicyConfig Property Map
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map
    topicPolicyConfig Property Map
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    wordPolicyConfig Property Map
    Word policy config for a guardrail. See Word Policy Config for more information.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Guardrail resource produces the following output properties:

    CreatedAt string
    Unix epoch timestamp in seconds for when the Guardrail was created.
    GuardrailArn string
    ARN of the Guardrail.
    GuardrailId string
    ID of the Guardrail.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the Bedrock Guardrail. One of READY, FAILED.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Version string
    Version of the Guardrail.
    CreatedAt string
    Unix epoch timestamp in seconds for when the Guardrail was created.
    GuardrailArn string
    ARN of the Guardrail.
    GuardrailId string
    ID of the Guardrail.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the Bedrock Guardrail. One of READY, FAILED.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Version string
    Version of the Guardrail.
    createdAt String
    Unix epoch timestamp in seconds for when the Guardrail was created.
    guardrailArn String
    ARN of the Guardrail.
    guardrailId String
    ID of the Guardrail.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the Bedrock Guardrail. One of READY, FAILED.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    version String
    Version of the Guardrail.
    createdAt string
    Unix epoch timestamp in seconds for when the Guardrail was created.
    guardrailArn string
    ARN of the Guardrail.
    guardrailId string
    ID of the Guardrail.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the Bedrock Guardrail. One of READY, FAILED.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    version string
    Version of the Guardrail.
    created_at str
    Unix epoch timestamp in seconds for when the Guardrail was created.
    guardrail_arn str
    ARN of the Guardrail.
    guardrail_id str
    ID of the Guardrail.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the Bedrock Guardrail. One of READY, FAILED.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    version str
    Version of the Guardrail.
    createdAt String
    Unix epoch timestamp in seconds for when the Guardrail was created.
    guardrailArn String
    ARN of the Guardrail.
    guardrailId String
    ID of the Guardrail.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the Bedrock Guardrail. One of READY, FAILED.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    version String
    Version of the Guardrail.

    Look up Existing Guardrail Resource

    Get an existing Guardrail resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GuardrailState, opts?: CustomResourceOptions): Guardrail
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        blocked_input_messaging: Optional[str] = None,
        blocked_outputs_messaging: Optional[str] = None,
        content_policy_config: Optional[GuardrailContentPolicyConfigArgs] = None,
        contextual_grounding_policy_config: Optional[GuardrailContextualGroundingPolicyConfigArgs] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        guardrail_arn: Optional[str] = None,
        guardrail_id: Optional[str] = None,
        kms_key_arn: Optional[str] = None,
        name: Optional[str] = None,
        sensitive_information_policy_config: Optional[GuardrailSensitiveInformationPolicyConfigArgs] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[GuardrailTimeoutsArgs] = None,
        topic_policy_config: Optional[GuardrailTopicPolicyConfigArgs] = None,
        version: Optional[str] = None,
        word_policy_config: Optional[GuardrailWordPolicyConfigArgs] = None) -> Guardrail
    func GetGuardrail(ctx *Context, name string, id IDInput, state *GuardrailState, opts ...ResourceOption) (*Guardrail, error)
    public static Guardrail Get(string name, Input<string> id, GuardrailState? state, CustomResourceOptions? opts = null)
    public static Guardrail get(String name, Output<String> id, GuardrailState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BlockedInputMessaging string
    Message to return when the guardrail blocks a prompt.
    BlockedOutputsMessaging string
    Message to return when the guardrail blocks a model response.
    ContentPolicyConfig GuardrailContentPolicyConfig
    Content policy config for a guardrail. See Content Policy Config for more information.
    ContextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfig
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    CreatedAt string
    Unix epoch timestamp in seconds for when the Guardrail was created.
    Description string
    Description of the guardrail or its version.
    GuardrailArn string
    ARN of the Guardrail.
    GuardrailId string
    ID of the Guardrail.
    KmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest.
    Name string

    Name of the guardrail.

    The following arguments are optional:

    SensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    Status string
    Status of the Bedrock Guardrail. One of READY, FAILED.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Timeouts GuardrailTimeouts
    TopicPolicyConfig GuardrailTopicPolicyConfig
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    Version string
    Version of the Guardrail.
    WordPolicyConfig GuardrailWordPolicyConfig
    Word policy config for a guardrail. See Word Policy Config for more information.
    BlockedInputMessaging string
    Message to return when the guardrail blocks a prompt.
    BlockedOutputsMessaging string
    Message to return when the guardrail blocks a model response.
    ContentPolicyConfig GuardrailContentPolicyConfigArgs
    Content policy config for a guardrail. See Content Policy Config for more information.
    ContextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfigArgs
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    CreatedAt string
    Unix epoch timestamp in seconds for when the Guardrail was created.
    Description string
    Description of the guardrail or its version.
    GuardrailArn string
    ARN of the Guardrail.
    GuardrailId string
    ID of the Guardrail.
    KmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest.
    Name string

    Name of the guardrail.

    The following arguments are optional:

    SensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfigArgs
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    Status string
    Status of the Bedrock Guardrail. One of READY, FAILED.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    Timeouts GuardrailTimeoutsArgs
    TopicPolicyConfig GuardrailTopicPolicyConfigArgs
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    Version string
    Version of the Guardrail.
    WordPolicyConfig GuardrailWordPolicyConfigArgs
    Word policy config for a guardrail. See Word Policy Config for more information.
    blockedInputMessaging String
    Message to return when the guardrail blocks a prompt.
    blockedOutputsMessaging String
    Message to return when the guardrail blocks a model response.
    contentPolicyConfig GuardrailContentPolicyConfig
    Content policy config for a guardrail. See Content Policy Config for more information.
    contextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfig
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    createdAt String
    Unix epoch timestamp in seconds for when the Guardrail was created.
    description String
    Description of the guardrail or its version.
    guardrailArn String
    ARN of the Guardrail.
    guardrailId String
    ID of the Guardrail.
    kmsKeyArn String
    The KMS key with which the guardrail was encrypted at rest.
    name String

    Name of the guardrail.

    The following arguments are optional:

    sensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    status String
    Status of the Bedrock Guardrail. One of READY, FAILED.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    timeouts GuardrailTimeouts
    topicPolicyConfig GuardrailTopicPolicyConfig
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    version String
    Version of the Guardrail.
    wordPolicyConfig GuardrailWordPolicyConfig
    Word policy config for a guardrail. See Word Policy Config for more information.
    blockedInputMessaging string
    Message to return when the guardrail blocks a prompt.
    blockedOutputsMessaging string
    Message to return when the guardrail blocks a model response.
    contentPolicyConfig GuardrailContentPolicyConfig
    Content policy config for a guardrail. See Content Policy Config for more information.
    contextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfig
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    createdAt string
    Unix epoch timestamp in seconds for when the Guardrail was created.
    description string
    Description of the guardrail or its version.
    guardrailArn string
    ARN of the Guardrail.
    guardrailId string
    ID of the Guardrail.
    kmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest.
    name string

    Name of the guardrail.

    The following arguments are optional:

    sensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    status string
    Status of the Bedrock Guardrail. One of READY, FAILED.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    timeouts GuardrailTimeouts
    topicPolicyConfig GuardrailTopicPolicyConfig
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    version string
    Version of the Guardrail.
    wordPolicyConfig GuardrailWordPolicyConfig
    Word policy config for a guardrail. See Word Policy Config for more information.
    blocked_input_messaging str
    Message to return when the guardrail blocks a prompt.
    blocked_outputs_messaging str
    Message to return when the guardrail blocks a model response.
    content_policy_config GuardrailContentPolicyConfigArgs
    Content policy config for a guardrail. See Content Policy Config for more information.
    contextual_grounding_policy_config GuardrailContextualGroundingPolicyConfigArgs
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    created_at str
    Unix epoch timestamp in seconds for when the Guardrail was created.
    description str
    Description of the guardrail or its version.
    guardrail_arn str
    ARN of the Guardrail.
    guardrail_id str
    ID of the Guardrail.
    kms_key_arn str
    The KMS key with which the guardrail was encrypted at rest.
    name str

    Name of the guardrail.

    The following arguments are optional:

    sensitive_information_policy_config GuardrailSensitiveInformationPolicyConfigArgs
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    status str
    Status of the Bedrock Guardrail. One of READY, FAILED.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    timeouts GuardrailTimeoutsArgs
    topic_policy_config GuardrailTopicPolicyConfigArgs
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    version str
    Version of the Guardrail.
    word_policy_config GuardrailWordPolicyConfigArgs
    Word policy config for a guardrail. See Word Policy Config for more information.
    blockedInputMessaging String
    Message to return when the guardrail blocks a prompt.
    blockedOutputsMessaging String
    Message to return when the guardrail blocks a model response.
    contentPolicyConfig Property Map
    Content policy config for a guardrail. See Content Policy Config for more information.
    contextualGroundingPolicyConfig Property Map
    Contextual grounding policy config for a guardrail. See Contextual Grounding Policy Config for more information.
    createdAt String
    Unix epoch timestamp in seconds for when the Guardrail was created.
    description String
    Description of the guardrail or its version.
    guardrailArn String
    ARN of the Guardrail.
    guardrailId String
    ID of the Guardrail.
    kmsKeyArn String
    The KMS key with which the guardrail was encrypted at rest.
    name String

    Name of the guardrail.

    The following arguments are optional:

    sensitiveInformationPolicyConfig Property Map
    Sensitive information policy config for a guardrail. See Sensitive Information Policy Config for more information.
    status String
    Status of the Bedrock Guardrail. One of READY, FAILED.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    timeouts Property Map
    topicPolicyConfig Property Map
    Topic policy config for a guardrail. See Topic Policy Config for more information.
    version String
    Version of the Guardrail.
    wordPolicyConfig Property Map
    Word policy config for a guardrail. See Word Policy Config for more information.

    Supporting Types

    GuardrailContentPolicyConfig, GuardrailContentPolicyConfigArgs

    FiltersConfigs List<GuardrailContentPolicyConfigFiltersConfig>
    List of content filter configs in content policy. See Filters Config for more information.
    FiltersConfigs []GuardrailContentPolicyConfigFiltersConfig
    List of content filter configs in content policy. See Filters Config for more information.
    filtersConfigs List<GuardrailContentPolicyConfigFiltersConfig>
    List of content filter configs in content policy. See Filters Config for more information.
    filtersConfigs GuardrailContentPolicyConfigFiltersConfig[]
    List of content filter configs in content policy. See Filters Config for more information.
    filters_configs Sequence[GuardrailContentPolicyConfigFiltersConfig]
    List of content filter configs in content policy. See Filters Config for more information.
    filtersConfigs List<Property Map>
    List of content filter configs in content policy. See Filters Config for more information.

    GuardrailContentPolicyConfigFiltersConfig, GuardrailContentPolicyConfigFiltersConfigArgs

    InputStrength string
    Strength for filters.
    OutputStrength string
    Strength for filters.
    Type string
    Type of contextual grounding filter.
    InputStrength string
    Strength for filters.
    OutputStrength string
    Strength for filters.
    Type string
    Type of contextual grounding filter.
    inputStrength String
    Strength for filters.
    outputStrength String
    Strength for filters.
    type String
    Type of contextual grounding filter.
    inputStrength string
    Strength for filters.
    outputStrength string
    Strength for filters.
    type string
    Type of contextual grounding filter.
    input_strength str
    Strength for filters.
    output_strength str
    Strength for filters.
    type str
    Type of contextual grounding filter.
    inputStrength String
    Strength for filters.
    outputStrength String
    Strength for filters.
    type String
    Type of contextual grounding filter.

    GuardrailContextualGroundingPolicyConfig, GuardrailContextualGroundingPolicyConfigArgs

    FiltersConfigs List<GuardrailContextualGroundingPolicyConfigFiltersConfig>
    List of contextual grounding filter configs. See Contextual Grounding Filters Config for more information.
    FiltersConfigs []GuardrailContextualGroundingPolicyConfigFiltersConfig
    List of contextual grounding filter configs. See Contextual Grounding Filters Config for more information.
    filtersConfigs List<GuardrailContextualGroundingPolicyConfigFiltersConfig>
    List of contextual grounding filter configs. See Contextual Grounding Filters Config for more information.
    filtersConfigs GuardrailContextualGroundingPolicyConfigFiltersConfig[]
    List of contextual grounding filter configs. See Contextual Grounding Filters Config for more information.
    filters_configs Sequence[GuardrailContextualGroundingPolicyConfigFiltersConfig]
    List of contextual grounding filter configs. See Contextual Grounding Filters Config for more information.
    filtersConfigs List<Property Map>
    List of contextual grounding filter configs. See Contextual Grounding Filters Config for more information.

    GuardrailContextualGroundingPolicyConfigFiltersConfig, GuardrailContextualGroundingPolicyConfigFiltersConfigArgs

    Threshold double
    The threshold for this filter.
    Type string
    Type of contextual grounding filter.
    Threshold float64
    The threshold for this filter.
    Type string
    Type of contextual grounding filter.
    threshold Double
    The threshold for this filter.
    type String
    Type of contextual grounding filter.
    threshold number
    The threshold for this filter.
    type string
    Type of contextual grounding filter.
    threshold float
    The threshold for this filter.
    type str
    Type of contextual grounding filter.
    threshold Number
    The threshold for this filter.
    type String
    Type of contextual grounding filter.

    GuardrailSensitiveInformationPolicyConfig, GuardrailSensitiveInformationPolicyConfigArgs

    PiiEntitiesConfigs List<GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig>
    List of entities. See PII Entities Config for more information.
    RegexesConfigs List<GuardrailSensitiveInformationPolicyConfigRegexesConfig>
    List of regex. See Regexes Config for more information.
    PiiEntitiesConfigs []GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig
    List of entities. See PII Entities Config for more information.
    RegexesConfigs []GuardrailSensitiveInformationPolicyConfigRegexesConfig
    List of regex. See Regexes Config for more information.
    piiEntitiesConfigs List<GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig>
    List of entities. See PII Entities Config for more information.
    regexesConfigs List<GuardrailSensitiveInformationPolicyConfigRegexesConfig>
    List of regex. See Regexes Config for more information.
    piiEntitiesConfigs GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig[]
    List of entities. See PII Entities Config for more information.
    regexesConfigs GuardrailSensitiveInformationPolicyConfigRegexesConfig[]
    List of regex. See Regexes Config for more information.
    pii_entities_configs Sequence[GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig]
    List of entities. See PII Entities Config for more information.
    regexes_configs Sequence[GuardrailSensitiveInformationPolicyConfigRegexesConfig]
    List of regex. See Regexes Config for more information.
    piiEntitiesConfigs List<Property Map>
    List of entities. See PII Entities Config for more information.
    regexesConfigs List<Property Map>
    List of regex. See Regexes Config for more information.

    GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfig, GuardrailSensitiveInformationPolicyConfigPiiEntitiesConfigArgs

    Action string
    Options for sensitive information action.
    Type string
    The currently supported PII entities.
    Action string
    Options for sensitive information action.
    Type string
    The currently supported PII entities.
    action String
    Options for sensitive information action.
    type String
    The currently supported PII entities.
    action string
    Options for sensitive information action.
    type string
    The currently supported PII entities.
    action str
    Options for sensitive information action.
    type str
    The currently supported PII entities.
    action String
    Options for sensitive information action.
    type String
    The currently supported PII entities.

    GuardrailSensitiveInformationPolicyConfigRegexesConfig, GuardrailSensitiveInformationPolicyConfigRegexesConfigArgs

    Action string
    Options for sensitive information action.
    Name string
    The regex name.
    Pattern string
    The regex pattern.
    Description string
    The regex description.
    Action string
    Options for sensitive information action.
    Name string
    The regex name.
    Pattern string
    The regex pattern.
    Description string
    The regex description.
    action String
    Options for sensitive information action.
    name String
    The regex name.
    pattern String
    The regex pattern.
    description String
    The regex description.
    action string
    Options for sensitive information action.
    name string
    The regex name.
    pattern string
    The regex pattern.
    description string
    The regex description.
    action str
    Options for sensitive information action.
    name str
    The regex name.
    pattern str
    The regex pattern.
    description str
    The regex description.
    action String
    Options for sensitive information action.
    name String
    The regex name.
    pattern String
    The regex pattern.
    description String
    The regex description.

    GuardrailTimeouts, GuardrailTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    GuardrailTopicPolicyConfig, GuardrailTopicPolicyConfigArgs

    TopicsConfigs List<GuardrailTopicPolicyConfigTopicsConfig>
    List of topic configs in topic policy. See Topics Config for more information.
    TopicsConfigs []GuardrailTopicPolicyConfigTopicsConfig
    List of topic configs in topic policy. See Topics Config for more information.
    topicsConfigs List<GuardrailTopicPolicyConfigTopicsConfig>
    List of topic configs in topic policy. See Topics Config for more information.
    topicsConfigs GuardrailTopicPolicyConfigTopicsConfig[]
    List of topic configs in topic policy. See Topics Config for more information.
    topics_configs Sequence[GuardrailTopicPolicyConfigTopicsConfig]
    List of topic configs in topic policy. See Topics Config for more information.
    topicsConfigs List<Property Map>
    List of topic configs in topic policy. See Topics Config for more information.

    GuardrailTopicPolicyConfigTopicsConfig, GuardrailTopicPolicyConfigTopicsConfigArgs

    Definition string
    Definition of topic in topic policy.
    Name string
    Name of topic in topic policy.
    Type string
    Type of topic in a policy.
    Examples List<string>
    List of text examples.
    Definition string
    Definition of topic in topic policy.
    Name string
    Name of topic in topic policy.
    Type string
    Type of topic in a policy.
    Examples []string
    List of text examples.
    definition String
    Definition of topic in topic policy.
    name String
    Name of topic in topic policy.
    type String
    Type of topic in a policy.
    examples List<String>
    List of text examples.
    definition string
    Definition of topic in topic policy.
    name string
    Name of topic in topic policy.
    type string
    Type of topic in a policy.
    examples string[]
    List of text examples.
    definition str
    Definition of topic in topic policy.
    name str
    Name of topic in topic policy.
    type str
    Type of topic in a policy.
    examples Sequence[str]
    List of text examples.
    definition String
    Definition of topic in topic policy.
    name String
    Name of topic in topic policy.
    type String
    Type of topic in a policy.
    examples List<String>
    List of text examples.

    GuardrailWordPolicyConfig, GuardrailWordPolicyConfigArgs

    ManagedWordListsConfigs List<GuardrailWordPolicyConfigManagedWordListsConfig>
    A config for the list of managed words. See Managed Word Lists Config for more information.
    WordsConfigs List<GuardrailWordPolicyConfigWordsConfig>
    List of custom word configs. See Words Config for more information.
    ManagedWordListsConfigs []GuardrailWordPolicyConfigManagedWordListsConfig
    A config for the list of managed words. See Managed Word Lists Config for more information.
    WordsConfigs []GuardrailWordPolicyConfigWordsConfig
    List of custom word configs. See Words Config for more information.
    managedWordListsConfigs List<GuardrailWordPolicyConfigManagedWordListsConfig>
    A config for the list of managed words. See Managed Word Lists Config for more information.
    wordsConfigs List<GuardrailWordPolicyConfigWordsConfig>
    List of custom word configs. See Words Config for more information.
    managedWordListsConfigs GuardrailWordPolicyConfigManagedWordListsConfig[]
    A config for the list of managed words. See Managed Word Lists Config for more information.
    wordsConfigs GuardrailWordPolicyConfigWordsConfig[]
    List of custom word configs. See Words Config for more information.
    managed_word_lists_configs Sequence[GuardrailWordPolicyConfigManagedWordListsConfig]
    A config for the list of managed words. See Managed Word Lists Config for more information.
    words_configs Sequence[GuardrailWordPolicyConfigWordsConfig]
    List of custom word configs. See Words Config for more information.
    managedWordListsConfigs List<Property Map>
    A config for the list of managed words. See Managed Word Lists Config for more information.
    wordsConfigs List<Property Map>
    List of custom word configs. See Words Config for more information.

    GuardrailWordPolicyConfigManagedWordListsConfig, GuardrailWordPolicyConfigManagedWordListsConfigArgs

    Type string
    Options for managed words.
    Type string
    Options for managed words.
    type String
    Options for managed words.
    type string
    Options for managed words.
    type str
    Options for managed words.
    type String
    Options for managed words.

    GuardrailWordPolicyConfigWordsConfig, GuardrailWordPolicyConfigWordsConfigArgs

    Text string
    The custom word text.
    Text string
    The custom word text.
    text String
    The custom word text.
    text string
    The custom word text.
    text str
    The custom word text.
    text String
    The custom word text.

    Import

    Using pulumi import, import Amazon Bedrock Guardrail using using a comma-delimited string of guardrail_id and version. For example:

    $ pulumi import aws:bedrock/guardrail:Guardrail example guardrail-id-12345678,DRAFT

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws