AwsBedrockGuardrailArgs

interface AwsBedrockGuardrailArgs {
blockedInputMessage?: string;
blockedOutputMessage?: string;
contentFilters?: Partial<Record<AwsBedrockContentCategory, AwsBedrockContentFilterArgs>>;
deniedTopics?: Record<string, AwsBedrockDeniedTopicArgs>;
deniedWords?: readonly string[];
description: string;
kmsKey?: AwsKmsKeyInput;
name: string;
piiEntities?: Partial<Record<AwsBedrockPiiEntity, AwsBedrockPiiAction>>;
tags?: Input<Record<string, Input<string>>>;
}

Arguments for the Bedrock Guardrail capability.

Example

CODE

const guardrail: AwsBedrockGuardrailArgs = {
  name: 'customerSupport',
  description: 'Protects the customer-support assistant.',
  piiEntities: { email: 'anonymise' },
};

Properties

`blockedInputMessage: string`

Message returned when the guardrail blocks model input.

Default: `'This request cannot be processed.'`

`blockedOutputMessage: string`

Message returned when the guardrail blocks a model response.

Default: `'This response cannot be returned.'`

`contentFilters: Partial<Record<AwsBedrockContentCategory, AwsBedrockContentFilterArgs>>`

Optional harmful-content filters keyed by category.

`deniedTopics: Record<string, AwsBedrockDeniedTopicArgs>`

Optional topics keyed by stable consumer-defined topic names.

`deniedWords: readonly string[]`

Optional words that Bedrock must block in inputs and outputs.

`description: string`

Human-readable explanation of the guardrail's intended protection boundary.

`kmsKey: AwsKmsKeyInput`

Optional customer-managed KMS key. Omit to use Bedrock's AWS-managed encryption key.

Use { keyArn } for a known commercial-partition KMS key ARN, or { identifier } for an external key ID, key ARN, alias name, or alias ARN.

`name: string`

Camel-case purpose used for the component identity and Bedrock guardrail name.

`piiEntities: Partial<Record<AwsBedrockPiiEntity, AwsBedrockPiiAction>>`

Optional PII protections keyed by entity type.

`tags: Input<Record<string, Input<string>>>`

Additional tags merged with the required JobCloud default tags.