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	aws.omics.reference_stores

Fields

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.

Methods

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

SELECT examples

Gets all reference_stores in a region.

SELECT
region,
arn,
creation_time,
description,
name,
reference_store_id,
sse_config,
tags
FROM aws.omics.reference_stores
WHERE region = 'us-east-1';

Gets all properties from an individual reference_store.

SELECT
region,
arn,
creation_time,
description,
name,
reference_store_id,
sse_config,
tags
FROM aws.omics.reference_stores
WHERE region = 'us-east-1' AND data__Identifier = '<ReferenceStoreId>';

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 aws.omics.reference_stores (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.omics.reference_stores (
 Description,
 Name,
 SseConfig,
 Tags,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Name }}',
 '{{ SseConfig }}',
 '{{ Tags }}',
 '{{ region }}';

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: SseConfig
        value:
          Type: '{{ Type }}'
          KeyArn: '{{ KeyArn }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.omics.reference_stores
WHERE data__Identifier = '<ReferenceStoreId>'
AND region = 'us-east-1';

Permissions

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

Create

omics:CreateReferenceStore,
omics:TagResource

Read

omics:GetReferenceStore,
omics:ListTagsForResource

Delete

omics:DeleteReferenceStore

List

omics:ListReferenceStores