CfnEnforcedGuardrailConfigurationProps

class aws_cdk.aws_bedrock.CfnEnforcedGuardrailConfigurationProps(*, guardrail_identifier, guardrail_version, model_enforcement=None, selective_content_guarding=None)

Bases: object

Properties for defining a CfnEnforcedGuardrailConfiguration.

Parameters:

guardrail_identifier (str) – Identifier for the guardrail, could be the ID or the ARN.
guardrail_version (str) – Numerical guardrail version (not DRAFT).
model_enforcement (Union[IResolvable, ModelEnforcementProperty, Dict[str, Any], None]) – Model-specific information for the enforced guardrail configuration. If not present, the configuration is enforced on all models
selective_content_guarding (Union[IResolvable, SelectiveContentGuardingProperty, Dict[str, Any], None]) – Selective content guarding controls for enforced guardrails.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.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

cfn_enforced_guardrail_configuration_props = bedrock.CfnEnforcedGuardrailConfigurationProps(
    guardrail_identifier="guardrailIdentifier",
    guardrail_version="guardrailVersion",

    # the properties below are optional
    model_enforcement=bedrock.CfnEnforcedGuardrailConfiguration.ModelEnforcementProperty(
        excluded_models=["excludedModels"],
        included_models=["includedModels"]
    ),
    selective_content_guarding=bedrock.CfnEnforcedGuardrailConfiguration.SelectiveContentGuardingProperty(
        messages="messages",
        system="system"
    )
)

Attributes

guardrail_identifier

Identifier for the guardrail, could be the ID or the ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html#cfn-bedrock-enforcedguardrailconfiguration-guardrailidentifier

guardrail_version

Numerical guardrail version (not DRAFT).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html#cfn-bedrock-enforcedguardrailconfiguration-guardrailversion

model_enforcement

Model-specific information for the enforced guardrail configuration.

If not present, the configuration is enforced on all models

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html#cfn-bedrock-enforcedguardrailconfiguration-modelenforcement

selective_content_guarding

Selective content guarding controls for enforced guardrails.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-enforcedguardrailconfiguration.html#cfn-bedrock-enforcedguardrailconfiguration-selectivecontentguarding