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

Fields

get (all properties)

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	object
store_size_bytes	number
tags	object	A map of resource tags
update_time	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	annotation_stores	INSERT	Name, StoreFormat, region
delete_resource	annotation_stores	DELETE	Identifier, region
update_resource	annotation_stores	UPDATE	Identifier, PatchDocument, region
list_resources	annotation_stores_list_only	SELECT	region
get_resource	annotation_stores	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.omics.annotation_stores
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all annotation_stores in a region.

SELECT
  region,
  name
FROM awscc.omics.annotation_stores_list_only
WHERE
  region = '{{ region }}';

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 awscc.omics.annotation_stores (
  Name,
  StoreFormat,
  region
)
SELECT
  '{{ name }}',
  '{{ store_format }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.omics.annotation_stores (
  Description,
  Name,
  Reference,
  SseConfig,
  StoreFormat,
  StoreOptions,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ name }}',
  '{{ reference }}',
  '{{ sse_config }}',
  '{{ store_format }}',
  '{{ store_options }}',
  '{{ 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: annotation_store
  props:
    - name: description
      value: '{{ description }}'
    - name: name
      value: '{{ name }}'
    - name: reference
      value:
        reference_arn: '{{ reference_arn }}'
    - name: sse_config
      value:
        type: '{{ type }}'
        key_arn: '{{ key_arn }}'
    - name: store_format
      value: '{{ store_format }}'
    - name: store_options
      value: null
    - name: tags
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.omics.annotation_stores
SET PatchDocument = string('{{ {
    "Description": description
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.omics.annotation_stores
WHERE
  Identifier = '{{ name }}' 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 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