Skip to content
v2.277.0

CfnAnnotationStoreProps Struct ​

Properties for defining a CfnAnnotationStore.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_omics as omics } from 'aws-cdk-lib';

declare const schema: any;
const cfnAnnotationStoreProps: omics.CfnAnnotationStoreProps = {
  name: 'name',
  storeFormat: 'storeFormat',

  // the properties below are optional
  description: 'description',
  reference: {
    referenceArn: 'referenceArn',
  },
  sseConfig: {
    type: 'type',

    // the properties below are optional
    keyArn: 'keyArn',
  },
  storeOptions: {
    tsvStoreOptions: {
      annotationType: 'annotationType',
      formatToHeader: {
        formatToHeaderKey: 'formatToHeader',
      },
      schema: schema,
    },
  },
  tags: {
    tagsKey: 'tags',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_omics as omics

# schema: Any

cfn_annotation_store_props = omics.CfnAnnotationStoreProps(
    name="name",
    store_format="storeFormat",

    # the properties below are optional
    description="description",
    reference=omics.CfnAnnotationStore.ReferenceItemProperty(
        reference_arn="referenceArn"
    ),
    sse_config=omics.CfnAnnotationStore.SseConfigProperty(
        type="type",

        # the properties below are optional
        key_arn="keyArn"
    ),
    store_options=omics.CfnAnnotationStore.StoreOptionsProperty(
        tsv_store_options=omics.CfnAnnotationStore.TsvStoreOptionsProperty(
            annotation_type="annotationType",
            format_to_header={
                "format_to_header_key": "formatToHeader"
            },
            schema=schema
        )
    ),
    tags={
        "tags_key": "tags"
    }
)
java
// 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;

CfnAnnotationStoreProps cfnAnnotationStoreProps = CfnAnnotationStoreProps.builder()
        .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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Omics;

var schema;

var cfnAnnotationStoreProps = new CfnAnnotationStoreProps {
    Name = "name",
    StoreFormat = "storeFormat",

    // the properties below are optional
    Description = "description",
    Reference = new ReferenceItemProperty {
        ReferenceArn = "referenceArn"
    },
    SseConfig = new SseConfigProperty {
        Type = "type",

        // the properties below are optional
        KeyArn = "keyArn"
    },
    StoreOptions = new StoreOptionsProperty {
        TsvStoreOptions = new TsvStoreOptionsProperty {
            AnnotationType = "annotationType",
            FormatToHeader = new Dictionary<string, string> {
                { "formatToHeaderKey", "formatToHeader" }
            },
            Schema = schema
        }
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var schema interface{}

cfnAnnotationStoreProps := &CfnAnnotationStoreProps{
	Name: jsii.String("name"),
	StoreFormat: jsii.String("storeFormat"),

	// the properties below are optional
	Description: jsii.String("description"),
	Reference: &ReferenceItemProperty{
		ReferenceArn: jsii.String("referenceArn"),
	},
	SseConfig: &SseConfigProperty{
		Type: jsii.String("type"),

		// the properties below are optional
		KeyArn: jsii.String("keyArn"),
	},
	StoreOptions: &StoreOptionsProperty{
		TsvStoreOptions: &TsvStoreOptionsProperty{
			AnnotationType: jsii.String("annotationType"),
			FormatToHeader: map[string]*string{
				"formatToHeaderKey": jsii.String("formatToHeader"),
			},
			Schema: schema,
		},
	},
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

Properties ​

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description for the store.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the Annotation Store.
referenceoptionalIResolvable | CfnAnnotationStore.ReferenceItemPropertyreferenceoptionaltyping.Union[IResolvable, ReferenceItemProperty]referenceoptionalIResolvableReferenceoptionalIResolvableReferenceoptionalinterface{}#
The genome reference for the store's annotations.
sseConfigoptionalIResolvable | CfnAnnotationStore.SseConfigPropertysse_configoptionaltyping.Union[IResolvable, SseConfigProperty]sseConfigoptionalIResolvableSseConfigoptionalIResolvableSseConfigoptionalinterface{}#
The store's server-side encryption (SSE) settings.
storeFormatstringstore_formatstrstoreFormatStringStoreFormatstringStoreFormat*stringrequired#
The annotation file format of the store.
storeOptionsoptionalIResolvable | CfnAnnotationStore.StoreOptionsPropertystore_optionsoptionaltyping.Union[IResolvable, StoreOptionsProperty]storeOptionsoptionalIResolvableStoreOptionsoptionalIResolvableStoreOptionsoptionalinterface{}#
File parsing options for the annotation store.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
Tags for the store.