blueprints

Creates, updates, deletes or gets a blueprint resource or lists blueprints in a region

Overview

Name	blueprints
Type	Resource
Description	Definition of AWS::Bedrock::Blueprint Resource Type
Id	awscc.bedrock.blueprints

Fields

get (all properties)

Name	Datatype	Description
blueprint_arn	string	ARN of a Blueprint
blueprint_name	string	Name of the Blueprint
creation_time	string	Creation timestamp
last_modified_time	string	Last modified timestamp
schema	object	Schema of the blueprint
type	string	Modality Type
blueprint_stage	string	Stage of the Blueprint
kms_key_id	string	KMS key identifier
kms_encryption_context	object	KMS encryption context
▶tags	array	List of Tags
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
blueprint_arn	string	ARN of a Blueprint
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	blueprints	INSERT	BlueprintName, Schema, Type, region
delete_resource	blueprints	DELETE	Identifier, region
update_resource	blueprints	UPDATE	Identifier, PatchDocument, region
list_resources	blueprints_list_only	SELECT	region
get_resource	blueprints	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual blueprint.

SELECT
  region,
  blueprint_arn,
  blueprint_name,
  creation_time,
  last_modified_time,
  schema,
  type,
  blueprint_stage,
  kms_key_id,
  kms_encryption_context,
  tags
FROM awscc.bedrock.blueprints
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ blueprint_arn }}';

list (identifiers only)

Lists all blueprints in a region.

SELECT
  region,
  blueprint_arn
FROM awscc.bedrock.blueprints_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.bedrock.blueprints (
  BlueprintName,
  Schema,
  Type,
  region
)
SELECT
  '{{ blueprint_name }}',
  '{{ schema }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.bedrock.blueprints (
  BlueprintName,
  Schema,
  Type,
  KmsKeyId,
  KmsEncryptionContext,
  Tags,
  region
)
SELECT
  '{{ blueprint_name }}',
  '{{ schema }}',
  '{{ type }}',
  '{{ kms_key_id }}',
  '{{ kms_encryption_context }}',
  '{{ tags }}',
  '{{ 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: blueprint
  props:
    - name: blueprint_name
      value: '{{ blueprint_name }}'
    - name: schema
      value: {}
    - name: type
      value: '{{ type }}'
    - name: kms_key_id
      value: '{{ kms_key_id }}'
    - name: kms_encryption_context
      value: {}
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a blueprint resource, using stack-deploy.

/*+ update */
UPDATE awscc.bedrock.blueprints
SET PatchDocument = string('{{ {
    "Schema": schema,
    "KmsKeyId": kms_key_id,
    "KmsEncryptionContext": kms_encryption_context,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ blueprint_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.bedrock.blueprints
WHERE
  Identifier = '{{ blueprint_arn }}' 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 blueprints resource, the following permissions are required:

Create

bedrock:CreateBlueprint,
bedrock:GetBlueprint,
bedrock:TagResource,
bedrock:ListTagsForResource,
kms:DescribeKey,
kms:Decrypt,
kms:GenerateDataKey

Read

bedrock:GetBlueprint,
bedrock:ListTagsForResource,
kms:DescribeKey,
kms:Decrypt

Update

bedrock:UpdateBlueprint,
bedrock:GetBlueprint,
bedrock:TagResource,
bedrock:UntagResource,
bedrock:ListTagsForResource,
kms:DescribeKey,
kms:Decrypt,
kms:GenerateDataKey

Delete

bedrock:DeleteBlueprint,
bedrock:GetBlueprint,
kms:DescribeKey,
kms:Decrypt

List

bedrock:ListBlueprints