guardrail_versions

Creates, updates, deletes or gets a guardrail_version resource or lists guardrail_versions in a region

Overview

Name	guardrail_versions
Type	Resource
Description	Definition of AWS::Bedrock::GuardrailVersion Resource Type
Id	aws.bedrock.guardrail_versions

Fields

Name	Datatype	Description
description	string	Description of the Guardrail version
guardrail_arn	string	Arn representation for the guardrail
guardrail_id	string	Unique id for the guardrail
guardrail_identifier	string	Identifier (GuardrailId or GuardrailArn) for the guardrail
version	string	Guardrail version
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GuardrailIdentifier, region
delete_resource	DELETE	data__Identifier, region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual guardrail_version.

SELECT
region,
description,
guardrail_arn,
guardrail_id,
guardrail_identifier,
version
FROM aws.bedrock.guardrail_versions
WHERE region = 'us-east-1' AND data__Identifier = '<GuardrailId>|<Version>';

INSERT example

Use the following StackQL query and manifest file to create a new guardrail_version resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.bedrock.guardrail_versions (
 GuardrailIdentifier,
 region
)
SELECT 
'{{ GuardrailIdentifier }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.bedrock.guardrail_versions (
 Description,
 GuardrailIdentifier,
 region
)
SELECT 
 '{{ Description }}',
 '{{ GuardrailIdentifier }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: guardrail_version
    props:
      - name: Description
        value: '{{ Description }}'
      - name: GuardrailIdentifier
        value: '{{ GuardrailIdentifier }}'

DELETE example

/*+ delete */
DELETE FROM aws.bedrock.guardrail_versions
WHERE data__Identifier = '<GuardrailId|Version>'
AND region = 'us-east-1';

Permissions

To operate on the guardrail_versions resource, the following permissions are required:

Create

bedrock:CreateGuardrailVersion,
bedrock:GetGuardrail,
kms:CreateGrant,
kms:Decrypt

Read

bedrock:GetGuardrail,
kms:Decrypt

Delete

bedrock:DeleteGuardrail,
bedrock:GetGuardrail,
kms:RetireGrant