sequence_stores

Creates, updates, deletes or gets a sequence_store resource or lists sequence_stores in a region

Overview

Name	sequence_stores
Type	Resource
Description	Resource Type definition for AWS::Omics::SequenceStore
Id	awscc.omics.sequence_stores

Fields

get (all properties)

Name	Datatype	Description
access_log_location	string	Location of the access logs.
arn	string	The store's ARN.
creation_time	string	When the store was created.
description	string	A description for the store.
e_tag_algorithm_family	string
fallback_location	string	An S3 location that is used to store files that have failed a direct upload.
name	string	A name for the store.
propagated_set_level_tags	array	The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
s3_access_point_arn	string	This is ARN of the access point associated with the S3 bucket storing read sets.
s3_access_policy	object	The resource policy that controls S3 access on the store
s3_uri	string	The S3 URI of the sequence store.
sequence_store_id	string
▶sse_config	object
status	string
status_message	string	The status message of the sequence store.
tags	object	A map of resource tags
update_time	string	The last-updated time of the sequence store.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
sequence_store_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	sequence_stores	INSERT	Name, region
delete_resource	sequence_stores	DELETE	Identifier, region
update_resource	sequence_stores	UPDATE	Identifier, PatchDocument, region
list_resources	sequence_stores_list_only	SELECT	region
get_resource	sequence_stores	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual sequence_store.

SELECT
  region,
  access_log_location,
  arn,
  creation_time,
  description,
  e_tag_algorithm_family,
  fallback_location,
  name,
  propagated_set_level_tags,
  s3_access_point_arn,
  s3_access_policy,
  s3_uri,
  sequence_store_id,
  sse_config,
  status,
  status_message,
  tags,
  update_time
FROM awscc.omics.sequence_stores
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ sequence_store_id }}';

list (identifiers only)

Lists all sequence_stores in a region.

SELECT
  region,
  sequence_store_id
FROM awscc.omics.sequence_stores_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.omics.sequence_stores (
  AccessLogLocation,
  Description,
  ETagAlgorithmFamily,
  FallbackLocation,
  Name,
  PropagatedSetLevelTags,
  S3AccessPolicy,
  SseConfig,
  Tags,
  region
)
SELECT
  '{{ access_log_location }}',
  '{{ description }}',
  '{{ e_tag_algorithm_family }}',
  '{{ fallback_location }}',
  '{{ name }}',
  '{{ propagated_set_level_tags }}',
  '{{ s3_access_policy }}',
  '{{ 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: sequence_store
  props:
    - name: access_log_location
      value: '{{ access_log_location }}'
    - name: description
      value: '{{ description }}'
    - name: e_tag_algorithm_family
      value: '{{ e_tag_algorithm_family }}'
    - name: fallback_location
      value: '{{ fallback_location }}'
    - name: name
      value: '{{ name }}'
    - name: propagated_set_level_tags
      value:
        - '{{ propagated_set_level_tags[0] }}'
    - name: s3_access_policy
      value: {}
    - name: sse_config
      value:
        type: '{{ type }}'
        key_arn: '{{ key_arn }}'
    - name: tags
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.omics.sequence_stores
SET PatchDocument = string('{{ {
    "AccessLogLocation": access_log_location,
    "Description": description,
    "FallbackLocation": fallback_location,
    "Name": name,
    "PropagatedSetLevelTags": propagated_set_level_tags,
    "S3AccessPolicy": s3_access_policy,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ sequence_store_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

omics:CreateSequenceStore,
omics:GetSequenceStore,
omics:GetS3AccessPolicy,
omics:PutS3AccessPolicy,
omics:ListTagsForResource,
omics:TagResource,
kms:DescribeKey

Read

omics:GetS3AccessPolicy,
omics:GetSequenceStore,
omics:ListTagsForResource

Update

omics:UpdateSequenceStore,
omics:GetSequenceStore,
omics:TagResource,
omics:UntagResource,
omics:ListTagsForResource,
omics:GetS3AccessPolicy,
omics:DeleteS3AccessPolicy,
omics:PutS3AccessPolicy

Delete

omics:DeleteSequenceStore

List

omics:ListSequenceStores