reference_stores

Creates, updates, deletes or gets a reference_store resource or lists reference_stores in a region

Overview

Name	reference_stores
Type	Resource
Description	Definition of AWS::Omics::ReferenceStore Resource Type
Id	awscc.omics.reference_stores

Fields

get (all properties)

Name	Datatype	Description
arn	string	The store's ARN.
creation_time	string	When the store was created.
description	string	A description for the store.
name	string	A name for the store.
reference_store_id	string
▶sse_config	object
tags	object	A map of resource tags
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
reference_store_id	string
region	string	AWS region.

For more information, see AWS::Omics::ReferenceStore.

Methods

Name	Resource	Accessible by	Required Params
create_resource	reference_stores	INSERT	Name, region
delete_resource	reference_stores	DELETE	Identifier, region
list_resources	reference_stores_list_only	SELECT	region
get_resource	reference_stores	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual reference_store.

SELECT
  region,
  arn,
  creation_time,
  description,
  name,
  reference_store_id,
  sse_config,
  tags
FROM awscc.omics.reference_stores
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ reference_store_id }}';

list (identifiers only)

Lists all reference_stores in a region.

SELECT
  region,
  reference_store_id
FROM awscc.omics.reference_stores_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.omics.reference_stores (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.omics.reference_stores (
  Description,
  Name,
  SseConfig,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ sse_config }}',
  '{{ 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: reference_store
  props:
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: sse_config
      value:
        type: '{{ type }}'
        key_arn: '{{ key_arn }}'
    - name: tags
      value: {}

DELETE example

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

Create

omics:CreateReferenceStore,
omics:TagResource,
kms:DescribeKey

Read

omics:GetReferenceStore,
omics:ListTagsForResource

Delete

omics:DeleteReferenceStore

List

omics:ListReferenceStores