Package software.amazon.awscdk.services.omics

Class CfnAnnotationStore

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.omics.CfnAnnotationStore
All Implemented Interfaces:
IInspectable, ITaggable, IAnnotationStoreRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:44.197Z") @Stability(Stable) public class CfnAnnotationStore extends CfnResource implements IInspectable, IAnnotationStoreRef, ITaggable

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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.omics.*;
 Object schema;
 CfnAnnotationStore cfnAnnotationStore = CfnAnnotationStore.Builder.create(this, "MyCfnAnnotationStore")
         .name("name")
         .storeFormat("storeFormat")
         // the properties below are optional
         .description("description")
         .reference(ReferenceItemProperty.builder()
                 .referenceArn("referenceArn")
                 .build())
         .sseConfig(SseConfigProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .keyArn("keyArn")
                 .build())
         .storeOptions(StoreOptionsProperty.builder()
                 .tsvStoreOptions(TsvStoreOptionsProperty.builder()
                         .annotationType("annotationType")
                         .formatToHeader(Map.of(
                                 "formatToHeaderKey", "formatToHeader"))
                         .schema(schema)
                         .build())
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAnnotationStore

      protected CfnAnnotationStore(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAnnotationStore

      protected CfnAnnotationStore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAnnotationStore

      @Stability(Stable) public CfnAnnotationStore(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAnnotationStoreProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromAnnotationStoreName

      @Stability(Stable) @NotNull public static IAnnotationStoreRef fromAnnotationStoreName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String annotationStoreName)
      Creates a new IAnnotationStoreRef from a annotationStoreName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      annotationStoreName - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAnnotationStoreRef

      @Stability(Stable) @NotNull public AnnotationStoreReference getAnnotationStoreRef()
      A reference to a AnnotationStore resource.
      Specified by:
      getAnnotationStoreRef in interface IAnnotationStoreRef

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      When the store was created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The store's ID.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The store's status.

    • getAttrStatusMessage

      @Stability(Stable) @NotNull public String getAttrStatusMessage()
      The store's status message.

    • getAttrStoreArn

      @Stability(Stable) @NotNull public String getAttrStoreArn()
      The store's ARN.

    • getAttrStoreSizeBytes

      @Stability(Stable) @NotNull public IResolvable getAttrStoreSizeBytes()
      The store's size in bytes.

    • getAttrUpdateTime

      @Stability(Stable) @NotNull public String getAttrUpdateTime()
      When the store was updated.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the Annotation Store.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the Annotation Store.

    • getStoreFormat

      @Stability(Stable) @NotNull public String getStoreFormat()
      The annotation file format of the store.

    • setStoreFormat

      @Stability(Stable) public void setStoreFormat(@NotNull String value)
      The annotation file format of the store.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the store.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the store.

    • getReference

      @Stability(Stable) @Nullable public Object getReference()
      The genome reference for the store's annotations.

      Returns union: either IResolvable or CfnAnnotationStore.ReferenceItemProperty

    • setReference

      @Stability(Stable) public void setReference(@Nullable IResolvable value)
      The genome reference for the store's annotations.

    • setReference

      @Stability(Stable) public void setReference(@Nullable CfnAnnotationStore.ReferenceItemProperty value)
      The genome reference for the store's annotations.

    • getSseConfig

      @Stability(Stable) @Nullable public Object getSseConfig()
      The store's server-side encryption (SSE) settings.

      Returns union: either IResolvable or CfnAnnotationStore.SseConfigProperty

    • setSseConfig

      @Stability(Stable) public void setSseConfig(@Nullable IResolvable value)
      The store's server-side encryption (SSE) settings.

    • setSseConfig

      @Stability(Stable) public void setSseConfig(@Nullable CfnAnnotationStore.SseConfigProperty value)
      The store's server-side encryption (SSE) settings.

    • getStoreOptions

      @Stability(Stable) @Nullable public Object getStoreOptions()
      File parsing options for the annotation store.

      Returns union: either IResolvable or CfnAnnotationStore.StoreOptionsProperty

    • setStoreOptions

      @Stability(Stable) public void setStoreOptions(@Nullable IResolvable value)
      File parsing options for the annotation store.

    • setStoreOptions

      @Stability(Stable) public void setStoreOptions(@Nullable CfnAnnotationStore.StoreOptionsProperty value)
      File parsing options for the annotation store.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      Tags for the store.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      Tags for the store.