1. Packages
  2. AWS Native
  3. API Docs
  4. omics
  5. AnnotationStore

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.omics.AnnotationStore

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Definition of AWS::Omics::AnnotationStore Resource Type

    Create AnnotationStore Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AnnotationStore(name: string, args: AnnotationStoreArgs, opts?: CustomResourceOptions);
    @overload
    def AnnotationStore(resource_name: str,
                        args: AnnotationStoreArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def AnnotationStore(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        store_format: Optional[AnnotationStoreStoreFormat] = None,
                        description: Optional[str] = None,
                        name: Optional[str] = None,
                        reference: Optional[AnnotationStoreReferenceItemArgs] = None,
                        sse_config: Optional[AnnotationStoreSseConfigArgs] = None,
                        store_options: Optional[AnnotationStoreStoreOptionsPropertiesArgs] = None,
                        tags: Optional[Mapping[str, str]] = None)
    func NewAnnotationStore(ctx *Context, name string, args AnnotationStoreArgs, opts ...ResourceOption) (*AnnotationStore, error)
    public AnnotationStore(string name, AnnotationStoreArgs args, CustomResourceOptions? opts = null)
    public AnnotationStore(String name, AnnotationStoreArgs args)
    public AnnotationStore(String name, AnnotationStoreArgs args, CustomResourceOptions options)
    
    type: aws-native:omics:AnnotationStore
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AnnotationStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AnnotationStoreArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AnnotationStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AnnotationStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AnnotationStoreArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const annotationStoreResource = new aws_native.omics.AnnotationStore("annotationStoreResource", {
        storeFormat: aws_native.omics.AnnotationStoreStoreFormat.Gff,
        description: "string",
        name: "string",
        reference: {
            referenceArn: "string",
        },
        sseConfig: {
            type: aws_native.omics.AnnotationStoreEncryptionType.Kms,
            keyArn: "string",
        },
        storeOptions: {
            tsvStoreOptions: {
                annotationType: aws_native.omics.AnnotationStoreAnnotationType.Generic,
                formatToHeader: {
                    string: "string",
                },
                schema: [{
                    string: aws_native.omics.AnnotationStoreSchemaValueType.Long,
                }],
            },
        },
        tags: {
            string: "string",
        },
    });
    
    Coming soon!
    

    AnnotationStore Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AnnotationStore resource accepts the following input properties:

    StoreFormat Pulumi.AwsNative.Omics.AnnotationStoreStoreFormat
    The annotation file format of the store.
    Description string
    A description for the store.
    Name string
    The name of the Annotation Store.
    Reference Pulumi.AwsNative.Omics.Inputs.AnnotationStoreReferenceItem
    The genome reference for the store's annotations.
    SseConfig Pulumi.AwsNative.Omics.Inputs.AnnotationStoreSseConfig
    The store's server-side encryption (SSE) settings.
    StoreOptions Pulumi.AwsNative.Omics.Inputs.AnnotationStoreStoreOptionsProperties
    File parsing options for the annotation store.
    Tags Dictionary<string, string>
    Tags for the store.
    StoreFormat AnnotationStoreStoreFormat
    The annotation file format of the store.
    Description string
    A description for the store.
    Name string
    The name of the Annotation Store.
    Reference AnnotationStoreReferenceItemArgs
    The genome reference for the store's annotations.
    SseConfig AnnotationStoreSseConfigArgs
    The store's server-side encryption (SSE) settings.
    StoreOptions AnnotationStoreStoreOptionsPropertiesArgs
    File parsing options for the annotation store.
    Tags map[string]string
    Tags for the store.
    storeFormat AnnotationStoreStoreFormat
    The annotation file format of the store.
    description String
    A description for the store.
    name String
    The name of the Annotation Store.
    reference AnnotationStoreReferenceItem
    The genome reference for the store's annotations.
    sseConfig AnnotationStoreSseConfig
    The store's server-side encryption (SSE) settings.
    storeOptions AnnotationStoreStoreOptionsProperties
    File parsing options for the annotation store.
    tags Map<String,String>
    Tags for the store.
    storeFormat AnnotationStoreStoreFormat
    The annotation file format of the store.
    description string
    A description for the store.
    name string
    The name of the Annotation Store.
    reference AnnotationStoreReferenceItem
    The genome reference for the store's annotations.
    sseConfig AnnotationStoreSseConfig
    The store's server-side encryption (SSE) settings.
    storeOptions AnnotationStoreStoreOptionsProperties
    File parsing options for the annotation store.
    tags {[key: string]: string}
    Tags for the store.
    store_format AnnotationStoreStoreFormat
    The annotation file format of the store.
    description str
    A description for the store.
    name str
    The name of the Annotation Store.
    reference AnnotationStoreReferenceItemArgs
    The genome reference for the store's annotations.
    sse_config AnnotationStoreSseConfigArgs
    The store's server-side encryption (SSE) settings.
    store_options AnnotationStoreStoreOptionsPropertiesArgs
    File parsing options for the annotation store.
    tags Mapping[str, str]
    Tags for the store.
    storeFormat "GFF" | "TSV" | "VCF"
    The annotation file format of the store.
    description String
    A description for the store.
    name String
    The name of the Annotation Store.
    reference Property Map
    The genome reference for the store's annotations.
    sseConfig Property Map
    The store's server-side encryption (SSE) settings.
    storeOptions Property Map
    File parsing options for the annotation store.
    tags Map<String>
    Tags for the store.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AnnotationStore resource produces the following output properties:

    AwsId string
    The store's ID.
    CreationTime string
    When the store was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.Omics.AnnotationStoreStoreStatus
    The store's status.
    StatusMessage string
    The store's status message.
    StoreArn string
    The store's ARN.
    StoreSizeBytes double
    The store's size in bytes.
    UpdateTime string
    When the store was updated.
    AwsId string
    The store's ID.
    CreationTime string
    When the store was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status AnnotationStoreStoreStatus
    The store's status.
    StatusMessage string
    The store's status message.
    StoreArn string
    The store's ARN.
    StoreSizeBytes float64
    The store's size in bytes.
    UpdateTime string
    When the store was updated.
    awsId String
    The store's ID.
    creationTime String
    When the store was created.
    id String
    The provider-assigned unique ID for this managed resource.
    status AnnotationStoreStoreStatus
    The store's status.
    statusMessage String
    The store's status message.
    storeArn String
    The store's ARN.
    storeSizeBytes Double
    The store's size in bytes.
    updateTime String
    When the store was updated.
    awsId string
    The store's ID.
    creationTime string
    When the store was created.
    id string
    The provider-assigned unique ID for this managed resource.
    status AnnotationStoreStoreStatus
    The store's status.
    statusMessage string
    The store's status message.
    storeArn string
    The store's ARN.
    storeSizeBytes number
    The store's size in bytes.
    updateTime string
    When the store was updated.
    aws_id str
    The store's ID.
    creation_time str
    When the store was created.
    id str
    The provider-assigned unique ID for this managed resource.
    status AnnotationStoreStoreStatus
    The store's status.
    status_message str
    The store's status message.
    store_arn str
    The store's ARN.
    store_size_bytes float
    The store's size in bytes.
    update_time str
    When the store was updated.
    awsId String
    The store's ID.
    creationTime String
    When the store was created.
    id String
    The provider-assigned unique ID for this managed resource.
    status "CREATING" | "UPDATING" | "DELETING" | "ACTIVE" | "FAILED"
    The store's status.
    statusMessage String
    The store's status message.
    storeArn String
    The store's ARN.
    storeSizeBytes Number
    The store's size in bytes.
    updateTime String
    When the store was updated.

    Supporting Types

    AnnotationStoreAnnotationType, AnnotationStoreAnnotationTypeArgs

    Generic
    GENERIC
    ChrPos
    CHR_POS
    ChrPosRefAlt
    CHR_POS_REF_ALT
    ChrStartEndOneBase
    CHR_START_END_ONE_BASE
    ChrStartEndRefAltOneBase
    CHR_START_END_REF_ALT_ONE_BASE
    ChrStartEndZeroBase
    CHR_START_END_ZERO_BASE
    ChrStartEndRefAltZeroBase
    CHR_START_END_REF_ALT_ZERO_BASE
    AnnotationStoreAnnotationTypeGeneric
    GENERIC
    AnnotationStoreAnnotationTypeChrPos
    CHR_POS
    AnnotationStoreAnnotationTypeChrPosRefAlt
    CHR_POS_REF_ALT
    AnnotationStoreAnnotationTypeChrStartEndOneBase
    CHR_START_END_ONE_BASE
    AnnotationStoreAnnotationTypeChrStartEndRefAltOneBase
    CHR_START_END_REF_ALT_ONE_BASE
    AnnotationStoreAnnotationTypeChrStartEndZeroBase
    CHR_START_END_ZERO_BASE
    AnnotationStoreAnnotationTypeChrStartEndRefAltZeroBase
    CHR_START_END_REF_ALT_ZERO_BASE
    Generic
    GENERIC
    ChrPos
    CHR_POS
    ChrPosRefAlt
    CHR_POS_REF_ALT
    ChrStartEndOneBase
    CHR_START_END_ONE_BASE
    ChrStartEndRefAltOneBase
    CHR_START_END_REF_ALT_ONE_BASE
    ChrStartEndZeroBase
    CHR_START_END_ZERO_BASE
    ChrStartEndRefAltZeroBase
    CHR_START_END_REF_ALT_ZERO_BASE
    Generic
    GENERIC
    ChrPos
    CHR_POS
    ChrPosRefAlt
    CHR_POS_REF_ALT
    ChrStartEndOneBase
    CHR_START_END_ONE_BASE
    ChrStartEndRefAltOneBase
    CHR_START_END_REF_ALT_ONE_BASE
    ChrStartEndZeroBase
    CHR_START_END_ZERO_BASE
    ChrStartEndRefAltZeroBase
    CHR_START_END_REF_ALT_ZERO_BASE
    GENERIC
    GENERIC
    CHR_POS
    CHR_POS
    CHR_POS_REF_ALT
    CHR_POS_REF_ALT
    CHR_START_END_ONE_BASE
    CHR_START_END_ONE_BASE
    CHR_START_END_REF_ALT_ONE_BASE
    CHR_START_END_REF_ALT_ONE_BASE
    CHR_START_END_ZERO_BASE
    CHR_START_END_ZERO_BASE
    CHR_START_END_REF_ALT_ZERO_BASE
    CHR_START_END_REF_ALT_ZERO_BASE
    "GENERIC"
    GENERIC
    "CHR_POS"
    CHR_POS
    "CHR_POS_REF_ALT"
    CHR_POS_REF_ALT
    "CHR_START_END_ONE_BASE"
    CHR_START_END_ONE_BASE
    "CHR_START_END_REF_ALT_ONE_BASE"
    CHR_START_END_REF_ALT_ONE_BASE
    "CHR_START_END_ZERO_BASE"
    CHR_START_END_ZERO_BASE
    "CHR_START_END_REF_ALT_ZERO_BASE"
    CHR_START_END_REF_ALT_ZERO_BASE

    AnnotationStoreEncryptionType, AnnotationStoreEncryptionTypeArgs

    Kms
    KMS
    AnnotationStoreEncryptionTypeKms
    KMS
    Kms
    KMS
    Kms
    KMS
    KMS
    KMS
    "KMS"
    KMS

    AnnotationStoreReferenceItem, AnnotationStoreReferenceItemArgs

    ReferenceArn string
    The reference's ARN.
    ReferenceArn string
    The reference's ARN.
    referenceArn String
    The reference's ARN.
    referenceArn string
    The reference's ARN.
    reference_arn str
    The reference's ARN.
    referenceArn String
    The reference's ARN.

    AnnotationStoreSchemaValueType, AnnotationStoreSchemaValueTypeArgs

    Long
    LONG
    Int
    INT
    String
    STRING
    Float
    FLOAT
    Double
    DOUBLE
    Boolean
    BOOLEAN
    AnnotationStoreSchemaValueTypeLong
    LONG
    AnnotationStoreSchemaValueTypeInt
    INT
    AnnotationStoreSchemaValueTypeString
    STRING
    AnnotationStoreSchemaValueTypeFloat
    FLOAT
    AnnotationStoreSchemaValueTypeDouble
    DOUBLE
    AnnotationStoreSchemaValueTypeBoolean
    BOOLEAN
    Long
    LONG
    Int
    INT
    String
    STRING
    Float
    FLOAT
    Double
    DOUBLE
    Boolean
    BOOLEAN
    Long
    LONG
    Int
    INT
    String
    STRING
    Float
    FLOAT
    Double
    DOUBLE
    Boolean
    BOOLEAN
    LONG
    LONG
    INT
    INT
    STRING
    STRING
    FLOAT
    FLOAT
    DOUBLE
    DOUBLE
    BOOLEAN
    BOOLEAN
    "LONG"
    LONG
    "INT"
    INT
    "STRING"
    STRING
    "FLOAT"
    FLOAT
    "DOUBLE"
    DOUBLE
    "BOOLEAN"
    BOOLEAN

    AnnotationStoreSseConfig, AnnotationStoreSseConfigArgs

    Type Pulumi.AwsNative.Omics.AnnotationStoreEncryptionType
    The encryption type.
    KeyArn string
    An encryption key ARN.
    Type AnnotationStoreEncryptionType
    The encryption type.
    KeyArn string
    An encryption key ARN.
    type AnnotationStoreEncryptionType
    The encryption type.
    keyArn String
    An encryption key ARN.
    type AnnotationStoreEncryptionType
    The encryption type.
    keyArn string
    An encryption key ARN.
    type AnnotationStoreEncryptionType
    The encryption type.
    key_arn str
    An encryption key ARN.
    type "KMS"
    The encryption type.
    keyArn String
    An encryption key ARN.

    AnnotationStoreStoreFormat, AnnotationStoreStoreFormatArgs

    Gff
    GFF
    Tsv
    TSV
    Vcf
    VCF
    AnnotationStoreStoreFormatGff
    GFF
    AnnotationStoreStoreFormatTsv
    TSV
    AnnotationStoreStoreFormatVcf
    VCF
    Gff
    GFF
    Tsv
    TSV
    Vcf
    VCF
    Gff
    GFF
    Tsv
    TSV
    Vcf
    VCF
    GFF
    GFF
    TSV
    TSV
    VCF
    VCF
    "GFF"
    GFF
    "TSV"
    TSV
    "VCF"
    VCF

    AnnotationStoreStoreOptionsProperties, AnnotationStoreStoreOptionsPropertiesArgs

    AnnotationStoreStoreStatus, AnnotationStoreStoreStatusArgs

    Creating
    CREATING
    Updating
    UPDATING
    Deleting
    DELETING
    Active
    ACTIVE
    Failed
    FAILED
    AnnotationStoreStoreStatusCreating
    CREATING
    AnnotationStoreStoreStatusUpdating
    UPDATING
    AnnotationStoreStoreStatusDeleting
    DELETING
    AnnotationStoreStoreStatusActive
    ACTIVE
    AnnotationStoreStoreStatusFailed
    FAILED
    Creating
    CREATING
    Updating
    UPDATING
    Deleting
    DELETING
    Active
    ACTIVE
    Failed
    FAILED
    Creating
    CREATING
    Updating
    UPDATING
    Deleting
    DELETING
    Active
    ACTIVE
    Failed
    FAILED
    CREATING
    CREATING
    UPDATING
    UPDATING
    DELETING
    DELETING
    ACTIVE
    ACTIVE
    FAILED
    FAILED
    "CREATING"
    CREATING
    "UPDATING"
    UPDATING
    "DELETING"
    DELETING
    "ACTIVE"
    ACTIVE
    "FAILED"
    FAILED

    AnnotationStoreTsvStoreOptions, AnnotationStoreTsvStoreOptionsArgs

    AnnotationType Pulumi.AwsNative.Omics.AnnotationStoreAnnotationType
    FormatToHeader Dictionary<string, string>
    Schema List<ImmutableDictionary<string, Pulumi.AwsNative.Omics.AnnotationStoreSchemaValueType>>
    AnnotationType AnnotationStoreAnnotationType
    FormatToHeader map[string]string
    Schema []map[string]AnnotationStoreSchemaValueType
    annotationType AnnotationStoreAnnotationType
    formatToHeader Map<String,String>
    schema List<Map<String,AnnotationStoreSchemaValueType>>
    annotationType AnnotationStoreAnnotationType
    formatToHeader {[key: string]: string}
    schema {[key: string]: AnnotationStoreSchemaValueType}[]
    annotation_type AnnotationStoreAnnotationType
    format_to_header Mapping[str, str]
    schema Sequence[Mapping[str, AnnotationStoreSchemaValueType]]

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi