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	awscc.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.

For more information, see AWS::Bedrock::GuardrailVersion.

Methods

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

SELECT examples

Gets all properties from an individual guardrail_version.

SELECT
  region,
  description,
  guardrail_arn,
  guardrail_id,
  guardrail_identifier,
  version
FROM awscc.bedrock.guardrail_versions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ guardrail_id }}|{{ 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 awscc.bedrock.guardrail_versions (
  GuardrailIdentifier,
  region
)
SELECT
  '{{ guardrail_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.bedrock.guardrail_versions (
  Description,
  GuardrailIdentifier,
  region
)
SELECT
  '{{ description }}',
  '{{ guardrail_identifier }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: guardrail_identifier
      value: '{{ guardrail_identifier }}'

DELETE example

/*+ delete */
DELETE FROM awscc.bedrock.guardrail_versions
WHERE
  Identifier = '{{ guardrail_id }}|{{ version }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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