CfnAnnotationStorePropsMixin

class aws_cdk.cfn_property_mixins.aws_omics.CfnAnnotationStorePropsMixin(props, *, strategy=None)

Bases: Mixin

AWS HealthOmics variant stores and annotation stores are no longer open to new customers.

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.

see:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html
cloudformationResource:: AWS::Omics::AnnotationStore
mixin:: true
exampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_omics as omics
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy
# schema: Any

cfn_annotation_store_props_mixin = omics.CfnAnnotationStorePropsMixin(omics.CfnAnnotationStoreMixinProps(
    description="description",
    name="name",
    reference=omics.CfnAnnotationStorePropsMixin.ReferenceItemProperty(
        reference_arn="referenceArn"
    ),
    sse_config=omics.CfnAnnotationStorePropsMixin.SseConfigProperty(
        key_arn="keyArn",
        type="type"
    ),
    store_format="storeFormat",
    store_options=omics.CfnAnnotationStorePropsMixin.StoreOptionsProperty(
        tsv_store_options=omics.CfnAnnotationStorePropsMixin.TsvStoreOptionsProperty(
            annotation_type="annotationType",
            format_to_header={
                "format_to_header_key": "formatToHeader"
            },
            schema=schema
        )
    ),
    tags={
        "tags_key": "tags"
    }
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Omics::AnnotationStore.

Parameters:

props (Union[CfnAnnotationStoreMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'name', 'reference', 'sseConfig', 'storeFormat', 'storeOptions', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ReferenceItemProperty

class CfnAnnotationStorePropsMixin.ReferenceItemProperty(*, reference_arn=None)

Bases: object

A genome reference.

Parameters:: reference_arn (Optional[str]) – The reference’s ARN.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-referenceitem.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_omics as omics

reference_item_property = omics.CfnAnnotationStorePropsMixin.ReferenceItemProperty(
    reference_arn="referenceArn"
)

Attributes

reference_arn

The reference’s ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-referenceitem.html#cfn-omics-annotationstore-referenceitem-referencearn

SseConfigProperty

class CfnAnnotationStorePropsMixin.SseConfigProperty(*, key_arn=None, type=None)

Bases: object

Server-side encryption (SSE) settings for a store.

Parameters:

key_arn (Optional[str]) – An encryption key ARN.
type (Optional[str]) – The encryption type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_omics as omics

sse_config_property = omics.CfnAnnotationStorePropsMixin.SseConfigProperty(
    key_arn="keyArn",
    type="type"
)

Attributes

key_arn

An encryption key ARN.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html#cfn-omics-annotationstore-sseconfig-keyarn

type

The encryption type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html#cfn-omics-annotationstore-sseconfig-type

StoreOptionsProperty

class CfnAnnotationStorePropsMixin.StoreOptionsProperty(*, tsv_store_options=None)

Bases: object

The store’s file parsing options.

Parameters:: tsv_store_options (Union[IResolvable, TsvStoreOptionsProperty, Dict[str, Any], None]) – Formatting options for a TSV file.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-storeoptions.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_omics as omics

# schema: Any

store_options_property = omics.CfnAnnotationStorePropsMixin.StoreOptionsProperty(
    tsv_store_options=omics.CfnAnnotationStorePropsMixin.TsvStoreOptionsProperty(
        annotation_type="annotationType",
        format_to_header={
            "format_to_header_key": "formatToHeader"
        },
        schema=schema
    )
)

Attributes

tsv_store_options

Formatting options for a TSV file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-storeoptions.html#cfn-omics-annotationstore-storeoptions-tsvstoreoptions

TsvStoreOptionsProperty

class CfnAnnotationStorePropsMixin.TsvStoreOptionsProperty(*, annotation_type=None, format_to_header=None, schema=None)

Bases: object

The store’s parsing options.

Parameters:

annotation_type (Optional[str]) – The store’s annotation type.
format_to_header (Union[Mapping[str, str], IResolvable, None]) – The store’s header key to column name mapping.
schema (Any) – The schema of an annotation store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_omics as omics

# schema: Any

tsv_store_options_property = omics.CfnAnnotationStorePropsMixin.TsvStoreOptionsProperty(
    annotation_type="annotationType",
    format_to_header={
        "format_to_header_key": "formatToHeader"
    },
    schema=schema
)

Attributes

annotation_type

The store’s annotation type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html#cfn-omics-annotationstore-tsvstoreoptions-annotationtype

format_to_header

The store’s header key to column name mapping.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html#cfn-omics-annotationstore-tsvstoreoptions-formattoheader

schema

The schema of an annotation store.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html#cfn-omics-annotationstore-tsvstoreoptions-schema