annotation_stores

Creates, updates, deletes or gets an annotation_store resource or lists annotation_stores in a region

Overview

Name	annotation_stores
Type	Resource
Description	Definition of AWS::Omics::AnnotationStore Resource Type
Id	aws.omics.annotation_stores

Fields

Name	Datatype	Description
creation_time	string
description	string
id	string
name	string
reference	object
sse_config	object
status	string
status_message	string
store_arn	string
store_format	string
store_options	undefined
store_size_bytes	number
tags	object	A map of resource tags
update_time	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, StoreFormat, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all annotation_stores in a region.

SELECT
region,
creation_time,
description,
id,
name,
reference,
sse_config,
status,
status_message,
store_arn,
store_format,
store_options,
store_size_bytes,
tags,
update_time
FROM aws.omics.annotation_stores
WHERE region = 'us-east-1';

Gets all properties from an individual annotation_store.

SELECT
region,
creation_time,
description,
id,
name,
reference,
sse_config,
status,
status_message,
store_arn,
store_format,
store_options,
store_size_bytes,
tags,
update_time
FROM aws.omics.annotation_stores
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.omics.annotation_stores (
 Name,
 StoreFormat,
 region
)
SELECT 
'{{ Name }}',
 '{{ StoreFormat }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: annotation_store
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: Reference
        value:
          ReferenceArn: '{{ ReferenceArn }}'
      - name: SseConfig
        value:
          Type: '{{ Type }}'
          KeyArn: '{{ KeyArn }}'
      - name: StoreFormat
        value: '{{ StoreFormat }}'
      - name: StoreOptions
        value: null
      - name: Tags
        value: {}

DELETE example

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

Permissions

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

Create

omics:CreateAnnotationStore,
omics:TagResource,
kms:DescribeKey,
kms:GenerateDataKey,
kms:CreateGrant,
ram:AcceptResourceShareInvitation,
ram:GetResourceShareInvitations,
omics:GetAnnotationStore

Read

omics:GetAnnotationStore

Update

omics:UpdateAnnotationStore,
omics:TagResource,
omics:UntagResource,
omics:GetAnnotationStore,
omics:ListTagsForResource

Delete

omics:DeleteAnnotationStore,
omics:ListAnnotationStores

List

omics:ListAnnotationStores