View a markdown version of this page

AWS::Bedrock::EnforcedGuardrailConfiguration - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Bedrock::EnforcedGuardrailConfiguration

Sets the account-level enforced guardrail configuration.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Bedrock::EnforcedGuardrailConfiguration",
  "Properties" : {
      "GuardrailIdentifier" : String,
      "GuardrailVersion" : String,
      "ModelEnforcement" : ModelEnforcement,
      "SelectiveContentGuarding" : SelectiveContentGuarding
    }
}

YAML

Type: AWS::Bedrock::EnforcedGuardrailConfiguration
Properties:
  GuardrailIdentifier: String
  GuardrailVersion: String
  ModelEnforcement: 
    ModelEnforcement
  SelectiveContentGuarding: 
    SelectiveContentGuarding

Properties

GuardrailIdentifier

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

Required: Yes

Type: String

Pattern: ^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$

Minimum: 0

Maximum: 2048

Update requires: No interruption

GuardrailVersion

Numerical guardrail version.

Required: Yes

Type: String

Pattern: ^[1-9][0-9]{0,7}$

Update requires: No interruption

ModelEnforcement

Model-specific information for the enforced guardrail configuration.

Required: No

Type: ModelEnforcement

Update requires: No interruption

SelectiveContentGuarding

Selective content guarding controls for enforced guardrails.

Required: No

Type: SelectiveContentGuarding

Update requires: No interruption

Return values

Ref

Fn::GetAtt

ConfigId

Unique ID for the account enforced configuration.

CreatedAt

Timestamp.

CreatedBy

The ARN of the role used to update the configuration.

GuardrailArn

ARN representation for the guardrail.

GuardrailId

Unique ID for the guardrail.

Owner

Configuration owner type.

UpdatedAt

Timestamp.

UpdatedBy

The ARN of the role used to update the configuration.