AWS::Bedrock::GuardrailVersion

Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

Syntax

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

JSON

{
  "Type" : "AWS::Bedrock::GuardrailVersion",
  "Properties" : {
      "Description" : String,
      "GuardrailIdentifier" : String
    }
}

YAML

Type: AWS::Bedrock::GuardrailVersion
Properties:
  Description: String
  GuardrailIdentifier: String

Properties

Description

A description of the guardrail version.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update requires: Replacement

GuardrailIdentifier

The unique identifier of the guardrail. This can be an 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]+))$

Maximum: 2048

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the guardrail ID and version, separated by a pipe (|) in the format (guardrail-id|guardrail-version).

For example, { "Ref": "myGuardrailVersion" } would return the value "3mzzryddufkp|2".

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

GuardrailArn

The ARN of the guardrail.

GuardrailId

The unique identifier of the guardrail.

Version

The version of the guardrail.