AWS::Omics::AnnotationStore

Important

AWS HealthOmics variant stores and annotation stores will no longer be open to new customers starting November 7, 2025. If you would like to use variant stores or annotation stores, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see AWS HealthOmics variant store and annotation store availability change.

Creates an annotation store.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Omics::AnnotationStore",
  "Properties" : {
      "Description" : String,
      "Name" : String,
      "Reference" : ReferenceItem,
      "SseConfig" : SseConfig,
      "StoreFormat" : String,
      "StoreOptions" : StoreOptions,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::Omics::AnnotationStore
Properties:
  Description: String
  Name: String
  Reference: 
    ReferenceItem
  SseConfig: 
    SseConfig
  StoreFormat: String
  StoreOptions: 
    StoreOptions
  Tags: 
    Key: Value

Properties

Description

A description for the store.

Required: No

Type: String

Minimum: 0

Maximum: 500

Update requires: No interruption

Name

The name of the Annotation Store.

Required: Yes

Type: String

Pattern: ^([a-z]){1}([a-z0-9_]){2,254}

Update requires: Replacement

Reference

The genome reference for the store's annotations.

Required: No

Type: ReferenceItem

Update requires: Replacement

SseConfig

The store's server-side encryption (SSE) settings.

Required: No

Type: SseConfig

Update requires: Replacement

StoreFormat

The annotation file format of the store.

Required: Yes

Type: String

Allowed values: GFF | TSV | VCF

Update requires: Replacement

StoreOptions

File parsing options for the annotation store.

Required: No

Type: StoreOptions

Update requires: Replacement

Tags

Tags for the store.

Required: No

Type: Object of String

Pattern: .+

Minimum: 0

Maximum: 256

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the details of this resource. For example:

{ "Ref": "AnnotationStore.Id" }Ref returns the id for the annotation store.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreationTime

When the store was created.

Id

The store's ID.

Status

The store's status.

StatusMessage

The store's status message.

StoreArn

The store's ARN.

StoreSizeBytes

The store's size in bytes.

UpdateTime

When the store was updated.