CfnGuardrail

class aws_cdk.aws_bedrock.CfnGuardrail(scope, id, *, blocked_input_messaging, blocked_outputs_messaging, name, content_policy_config=None, description=None, kms_key_arn=None, sensitive_information_policy_config=None, tags=None, topic_policy_config=None, word_policy_config=None)

Bases: CfnResource

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

You can configure denied topics to disallow undesirable topics and content filters to block harmful content in model inputs and responses. For more information, see Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide

See:

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

CloudformationResource:

AWS::Bedrock::Guardrail

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

cfn_guardrail = bedrock.CfnGuardrail(self, "MyCfnGuardrail",
    blocked_input_messaging="blockedInputMessaging",
    blocked_outputs_messaging="blockedOutputsMessaging",
    name="name",

    # the properties below are optional
    content_policy_config=bedrock.CfnGuardrail.ContentPolicyConfigProperty(
        filters_config=[bedrock.CfnGuardrail.ContentFilterConfigProperty(
            input_strength="inputStrength",
            output_strength="outputStrength",
            type="type"
        )]
    ),
    description="description",
    kms_key_arn="kmsKeyArn",
    sensitive_information_policy_config=bedrock.CfnGuardrail.SensitiveInformationPolicyConfigProperty(
        pii_entities_config=[bedrock.CfnGuardrail.PiiEntityConfigProperty(
            action="action",
            type="type"
        )],
        regexes_config=[bedrock.CfnGuardrail.RegexConfigProperty(
            action="action",
            name="name",
            pattern="pattern",

            # the properties below are optional
            description="description"
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    topic_policy_config=bedrock.CfnGuardrail.TopicPolicyConfigProperty(
        topics_config=[bedrock.CfnGuardrail.TopicConfigProperty(
            definition="definition",
            name="name",
            type="type",

            # the properties below are optional
            examples=["examples"]
        )]
    ),
    word_policy_config=bedrock.CfnGuardrail.WordPolicyConfigProperty(
        managed_word_lists_config=[bedrock.CfnGuardrail.ManagedWordsConfigProperty(
            type="type"
        )],
        words_config=[bedrock.CfnGuardrail.WordConfigProperty(
            text="text"
        )]
    )
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • blocked_input_messaging (str) – The message to return when the guardrail blocks a prompt.

  • blocked_outputs_messaging (str) – The message to return when the guardrail blocks a model response.

  • name (str) – The name of the guardrail.

  • content_policy_config (Union[IResolvable, ContentPolicyConfigProperty, Dict[str, Any], None]) – Content policy config for a guardrail.

  • description (Optional[str]) – A description of the guardrail.

  • kms_key_arn (Optional[str]) – The ARN of the AWS KMS key used to encrypt the guardrail.

  • sensitive_information_policy_config (Union[IResolvable, SensitiveInformationPolicyConfigProperty, Dict[str, Any], None]) – Sensitive information policy config for a guardrail.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata that you can assign to a guardrail as key-value pairs. For more information, see the following resources:. - Tag naming limits and requirements - Tagging best practices

  • topic_policy_config (Union[IResolvable, TopicPolicyConfigProperty, Dict[str, Any], None]) – Topic policy config for a guardrail.

  • word_policy_config (Union[IResolvable, WordPolicyConfigProperty, Dict[str, Any], None]) – Word policy config for a guardrail.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Bedrock::Guardrail'
attr_created_at

The date and time at which the guardrail was created.

CloudformationAttribute:

CreatedAt

attr_failure_recommendations

List of failure recommendations.

CloudformationAttribute:

FailureRecommendations

attr_guardrail_arn

The Amazon Resource Name (ARN) of the guardrail.

This a the primary identifier for the guardrail.

CloudformationAttribute:

GuardrailArn

attr_guardrail_id

The unique identifier of the guardrail.

CloudformationAttribute:

GuardrailId

attr_status

Status of the guardrail.

CloudformationAttribute:

Status

attr_status_reasons

List of status reasons.

CloudformationAttribute:

StatusReasons

attr_updated_at

The date and time at which the guardrail was last updated.

CloudformationAttribute:

UpdatedAt

attr_version

The version of the guardrail.

CloudformationAttribute:

Version

blocked_input_messaging

The message to return when the guardrail blocks a prompt.

blocked_outputs_messaging

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

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

content_policy_config

Content policy config for a guardrail.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

A description of the guardrail.

kms_key_arn

The ARN of the AWS KMS key used to encrypt the guardrail.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the guardrail.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

sensitive_information_policy_config

Sensitive information policy config for a guardrail.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Metadata that you can assign to a guardrail as key-value pairs.

For more information, see the following resources:.

topic_policy_config

Topic policy config for a guardrail.

word_policy_config

Word policy config for a guardrail.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

ContentFilterConfigProperty

class CfnGuardrail.ContentFilterConfigProperty(*, input_strength, output_strength, type)

Bases: object

Content filter config in content policy.

Parameters:

  • input_strength (str) – Strength for filters.

  • output_strength (str) – Strength for filters.

  • type (str) – Type of filter in content policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

content_filter_config_property = bedrock.CfnGuardrail.ContentFilterConfigProperty(
    input_strength="inputStrength",
    output_strength="outputStrength",
    type="type"
)

Attributes

input_strength

Strength for filters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputstrength

output_strength

Strength for filters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputstrength

type

Type of filter in content policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-type

ContentPolicyConfigProperty

class CfnGuardrail.ContentPolicyConfigProperty(*, filters_config)

Bases: object

Content policy config for a guardrail.

Parameters:

filters_config (Union[IResolvable, Sequence[Union[IResolvable, ContentFilterConfigProperty, Dict[str, Any]]]]) – List of content filter configs in content policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

content_policy_config_property = bedrock.CfnGuardrail.ContentPolicyConfigProperty(
    filters_config=[bedrock.CfnGuardrail.ContentFilterConfigProperty(
        input_strength="inputStrength",
        output_strength="outputStrength",
        type="type"
    )]
)

Attributes

filters_config

List of content filter configs in content policy.

See:

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

ManagedWordsConfigProperty

class CfnGuardrail.ManagedWordsConfigProperty(*, type)

Bases: object

A managed words config.

Parameters:

type (str) – Options for managed words.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

managed_words_config_property = bedrock.CfnGuardrail.ManagedWordsConfigProperty(
    type="type"
)

Attributes

type

Options for managed words.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-type

PiiEntityConfigProperty

class CfnGuardrail.PiiEntityConfigProperty(*, action, type)

Bases: object

Pii entity configuration.

Parameters:

  • action (str) – Options for sensitive information action.

  • type (str) – The currently supported PII entities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

pii_entity_config_property = bedrock.CfnGuardrail.PiiEntityConfigProperty(
    action="action",
    type="type"
)

Attributes

action

Options for sensitive information action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-action

type

The currently supported PII entities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-type

RegexConfigProperty

class CfnGuardrail.RegexConfigProperty(*, action, name, pattern, description=None)

Bases: object

A regex configuration.

Parameters:

  • action (str) – Options for sensitive information action.

  • name (str) – The regex name.

  • pattern (str) – The regex pattern.

  • description (Optional[str]) – The regex description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

regex_config_property = bedrock.CfnGuardrail.RegexConfigProperty(
    action="action",
    name="name",
    pattern="pattern",

    # the properties below are optional
    description="description"
)

Attributes

action

Options for sensitive information action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-action

description

The regex description.

See:

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

name

The regex name.

See:

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

pattern

The regex pattern.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-pattern

SensitiveInformationPolicyConfigProperty

class CfnGuardrail.SensitiveInformationPolicyConfigProperty(*, pii_entities_config=None, regexes_config=None)

Bases: object

Sensitive information policy config for a guardrail.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

sensitive_information_policy_config_property = bedrock.CfnGuardrail.SensitiveInformationPolicyConfigProperty(
    pii_entities_config=[bedrock.CfnGuardrail.PiiEntityConfigProperty(
        action="action",
        type="type"
    )],
    regexes_config=[bedrock.CfnGuardrail.RegexConfigProperty(
        action="action",
        name="name",
        pattern="pattern",

        # the properties below are optional
        description="description"
    )]
)

Attributes

pii_entities_config

List of entities.

See:

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

regexes_config

List of regex.

See:

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

TopicConfigProperty

class CfnGuardrail.TopicConfigProperty(*, definition, name, type, examples=None)

Bases: object

Topic config in topic policy.

Parameters:

  • 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 (Optional[Sequence[str]]) – List of text examples.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

topic_config_property = bedrock.CfnGuardrail.TopicConfigProperty(
    definition="definition",
    name="name",
    type="type",

    # the properties below are optional
    examples=["examples"]
)

Attributes

definition

Definition of topic in topic policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-definition

examples

List of text examples.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-examples

name

Name of topic in topic policy.

See:

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

type

Type of topic in a policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-type

TopicPolicyConfigProperty

class CfnGuardrail.TopicPolicyConfigProperty(*, topics_config)

Bases: object

Topic policy config for a guardrail.

Parameters:

topics_config (Union[IResolvable, Sequence[Union[IResolvable, TopicConfigProperty, Dict[str, Any]]]]) – List of topic configs in topic policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

topic_policy_config_property = bedrock.CfnGuardrail.TopicPolicyConfigProperty(
    topics_config=[bedrock.CfnGuardrail.TopicConfigProperty(
        definition="definition",
        name="name",
        type="type",

        # the properties below are optional
        examples=["examples"]
    )]
)

Attributes

topics_config

List of topic configs in topic policy.

See:

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

WordConfigProperty

class CfnGuardrail.WordConfigProperty(*, text)

Bases: object

A custom word config.

Parameters:

text (str) – The custom word text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

word_config_property = bedrock.CfnGuardrail.WordConfigProperty(
    text="text"
)

Attributes

text

The custom word text.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-text

WordPolicyConfigProperty

class CfnGuardrail.WordPolicyConfigProperty(*, managed_word_lists_config=None, words_config=None)

Bases: object

Word policy config for a guardrail.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

word_policy_config_property = bedrock.CfnGuardrail.WordPolicyConfigProperty(
    managed_word_lists_config=[bedrock.CfnGuardrail.ManagedWordsConfigProperty(
        type="type"
    )],
    words_config=[bedrock.CfnGuardrail.WordConfigProperty(
        text="text"
    )]
)

Attributes

managed_word_lists_config

A config for the list of managed words.

See:

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

words_config

List of custom word configs.

See:

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