UNPKG

aws-cdk-lib

Version:

Version 2 of the AWS Cloud Development Kit library

1,286 lines 75.4 kB
import * as cdk from "../../core/lib"; import * as constructs from "constructs"; import * as cfn_parse from "../../core/lib/helpers-internal"; import { AnnotationStoreReference, IAnnotationStoreRef, IReferenceStoreRef, IRunGroupRef, ISequenceStoreRef, IVariantStoreRef, IWorkflowRef, IWorkflowVersionRef, ReferenceStoreReference, RunGroupReference, SequenceStoreReference, VariantStoreReference, WorkflowReference, WorkflowVersionReference } from "../../interfaces/generated/aws-omics-interfaces.generated"; /** * > 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](https://docs.aws.amazon.com/omics/latest/dev/variant-store-availability-change.html) . * * Creates an annotation store. * * @cloudformationResource AWS::Omics::AnnotationStore * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html */ export declare class CfnAnnotationStore extends cdk.CfnResource implements cdk.IInspectable, IAnnotationStoreRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnAnnotationStore from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAnnotationStore; /** * Checks whether the given object is a CfnAnnotationStore */ static isCfnAnnotationStore(x: any): x is CfnAnnotationStore; /** * Creates a new IAnnotationStoreRef from a annotationStoreName */ static fromAnnotationStoreName(scope: constructs.Construct, id: string, annotationStoreName: string): IAnnotationStoreRef; static arnForAnnotationStore(resource: IAnnotationStoreRef): string; /** * When the store was created. * * @cloudformationAttribute CreationTime */ readonly attrCreationTime: string; /** * The store's ID. * * @cloudformationAttribute Id */ readonly attrId: string; /** * The store's status. * * @cloudformationAttribute Status */ readonly attrStatus: string; /** * The store's status message. * * @cloudformationAttribute StatusMessage */ readonly attrStatusMessage: string; /** * The store's ARN. * * @cloudformationAttribute StoreArn */ readonly attrStoreArn: string; /** * The store's size in bytes. * * @cloudformationAttribute StoreSizeBytes */ readonly attrStoreSizeBytes: cdk.IResolvable; /** * When the store was updated. * * @cloudformationAttribute UpdateTime */ readonly attrUpdateTime: string; /** * A description for the store. */ description?: string; /** * The name of the Annotation Store. */ name: string; /** * The genome reference for the store's annotations. */ reference?: cdk.IResolvable | CfnAnnotationStore.ReferenceItemProperty; /** * The store's server-side encryption (SSE) settings. */ sseConfig?: cdk.IResolvable | CfnAnnotationStore.SseConfigProperty; /** * The annotation file format of the store. */ storeFormat: string; /** * File parsing options for the annotation store. */ storeOptions?: cdk.IResolvable | CfnAnnotationStore.StoreOptionsProperty; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Tags for the store. */ tagsRaw?: Record<string, string>; /** * Create a new `AWS::Omics::AnnotationStore`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnAnnotationStoreProps); get annotationStoreRef(): AnnotationStoreReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnAnnotationStore { /** * A genome reference. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-referenceitem.html */ interface ReferenceItemProperty { /** * The reference's ARN. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-referenceitem.html#cfn-omics-annotationstore-referenceitem-referencearn */ readonly referenceArn: string; } /** * Server-side encryption (SSE) settings for a store. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html */ interface SseConfigProperty { /** * An encryption key ARN. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html#cfn-omics-annotationstore-sseconfig-keyarn */ readonly keyArn?: string; /** * The encryption type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-sseconfig.html#cfn-omics-annotationstore-sseconfig-type */ readonly type: string; } /** * The store's file parsing options. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-storeoptions.html */ interface StoreOptionsProperty { /** * 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 */ readonly tsvStoreOptions: cdk.IResolvable | CfnAnnotationStore.TsvStoreOptionsProperty; } /** * The store's parsing options. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-annotationstore-tsvstoreoptions.html */ interface TsvStoreOptionsProperty { /** * 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 */ readonly annotationType?: string; /** * 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 */ readonly formatToHeader?: cdk.IResolvable | Record<string, string>; /** * 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 */ readonly schema?: any | cdk.IResolvable; } } /** * Properties for defining a `CfnAnnotationStore` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html */ export interface CfnAnnotationStoreProps { /** * A description for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-description */ readonly description?: string; /** * The name of the Annotation Store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-name */ readonly name: string; /** * The genome reference for the store's annotations. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-reference */ readonly reference?: cdk.IResolvable | CfnAnnotationStore.ReferenceItemProperty; /** * The store's server-side encryption (SSE) settings. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-sseconfig */ readonly sseConfig?: cdk.IResolvable | CfnAnnotationStore.SseConfigProperty; /** * The annotation file format of the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-storeformat */ readonly storeFormat: string; /** * File parsing options for the annotation store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-storeoptions */ readonly storeOptions?: cdk.IResolvable | CfnAnnotationStore.StoreOptionsProperty; /** * Tags for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-annotationstore.html#cfn-omics-annotationstore-tags */ readonly tags?: Record<string, string>; } /** * Creates a reference store. * * @cloudformationResource AWS::Omics::ReferenceStore * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html */ export declare class CfnReferenceStore extends cdk.CfnResource implements cdk.IInspectable, IReferenceStoreRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnReferenceStore from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnReferenceStore; /** * Checks whether the given object is a CfnReferenceStore */ static isCfnReferenceStore(x: any): x is CfnReferenceStore; /** * Creates a new IReferenceStoreRef from an ARN */ static fromReferenceStoreArn(scope: constructs.Construct, id: string, arn: string): IReferenceStoreRef; /** * Creates a new IReferenceStoreRef from a referenceStoreId */ static fromReferenceStoreId(scope: constructs.Construct, id: string, referenceStoreId: string): IReferenceStoreRef; static arnForReferenceStore(resource: IReferenceStoreRef): string; /** * The store's ARN. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * When the store was created. * * @cloudformationAttribute CreationTime */ readonly attrCreationTime: string; /** * The store's ID. * * @cloudformationAttribute ReferenceStoreId */ readonly attrReferenceStoreId: string; /** * A description for the store. */ description?: string; /** * A name for the store. */ name: string; /** * Server-side encryption (SSE) settings for the store. */ sseConfig?: cdk.IResolvable | CfnReferenceStore.SseConfigProperty; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Tags for the store. */ tagsRaw?: Record<string, string>; /** * Create a new `AWS::Omics::ReferenceStore`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnReferenceStoreProps); get referenceStoreRef(): ReferenceStoreReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnReferenceStore { /** * Server-side encryption (SSE) settings for a store. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-referencestore-sseconfig.html */ interface SseConfigProperty { /** * An encryption key ARN. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-referencestore-sseconfig.html#cfn-omics-referencestore-sseconfig-keyarn */ readonly keyArn?: string; /** * The encryption type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-referencestore-sseconfig.html#cfn-omics-referencestore-sseconfig-type */ readonly type: string; } } /** * Properties for defining a `CfnReferenceStore` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html */ export interface CfnReferenceStoreProps { /** * A description for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html#cfn-omics-referencestore-description */ readonly description?: string; /** * A name for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html#cfn-omics-referencestore-name */ readonly name: string; /** * Server-side encryption (SSE) settings for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html#cfn-omics-referencestore-sseconfig */ readonly sseConfig?: cdk.IResolvable | CfnReferenceStore.SseConfigProperty; /** * Tags for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-referencestore.html#cfn-omics-referencestore-tags */ readonly tags?: Record<string, string>; } /** * Creates a run group to limit the compute resources for the runs that are added to the group. * * Returns an ARN, ID, and tags for the run group. * * @cloudformationResource AWS::Omics::RunGroup * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html */ export declare class CfnRunGroup extends cdk.CfnResource implements cdk.IInspectable, IRunGroupRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnRunGroup from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnRunGroup; /** * Checks whether the given object is a CfnRunGroup */ static isCfnRunGroup(x: any): x is CfnRunGroup; static arnForRunGroup(resource: IRunGroupRef): string; /** * The run group's ARN. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * When the run group was created. * * @cloudformationAttribute CreationTime */ readonly attrCreationTime: string; /** * The run group's ID. * * @cloudformationAttribute Id */ readonly attrId: string; /** * The group's maximum CPU count setting. */ maxCpus?: number; /** * The group's maximum duration setting in minutes. */ maxDuration?: number; /** * The maximum GPUs that can be used by a run group. */ maxGpus?: number; /** * The group's maximum concurrent run setting. */ maxRuns?: number; /** * The group's name. */ name?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Tags for the group. */ tagsRaw?: Record<string, string>; /** * Create a new `AWS::Omics::RunGroup`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnRunGroupProps); get runGroupRef(): RunGroupReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } /** * Properties for defining a `CfnRunGroup` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html */ export interface CfnRunGroupProps { /** * The group's maximum CPU count setting. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-maxcpus */ readonly maxCpus?: number; /** * The group's maximum duration setting in minutes. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-maxduration */ readonly maxDuration?: number; /** * The maximum GPUs that can be used by a run group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-maxgpus */ readonly maxGpus?: number; /** * The group's maximum concurrent run setting. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-maxruns */ readonly maxRuns?: number; /** * The group's name. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-name */ readonly name?: string; /** * Tags for the group. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-rungroup.html#cfn-omics-rungroup-tags */ readonly tags?: Record<string, string>; } /** * Creates a sequence store. * * @cloudformationResource AWS::Omics::SequenceStore * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html */ export declare class CfnSequenceStore extends cdk.CfnResource implements cdk.IInspectable, ISequenceStoreRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnSequenceStore from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSequenceStore; /** * Checks whether the given object is a CfnSequenceStore */ static isCfnSequenceStore(x: any): x is CfnSequenceStore; /** * Creates a new ISequenceStoreRef from an ARN */ static fromSequenceStoreArn(scope: constructs.Construct, id: string, arn: string): ISequenceStoreRef; /** * Creates a new ISequenceStoreRef from a sequenceStoreId */ static fromSequenceStoreId(scope: constructs.Construct, id: string, sequenceStoreId: string): ISequenceStoreRef; static arnForSequenceStore(resource: ISequenceStoreRef): string; /** * The store's ARN. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * When the store was created. * * @cloudformationAttribute CreationTime */ readonly attrCreationTime: string; /** * This is ARN of the access point associated with the S3 bucket storing read sets. * * @cloudformationAttribute S3AccessPointArn */ readonly attrS3AccessPointArn: string; /** * The S3 URI of the sequence store. * * @cloudformationAttribute S3Uri */ readonly attrS3Uri: string; /** * The store's ID. * * @cloudformationAttribute SequenceStoreId */ readonly attrSequenceStoreId: string; /** * Status of the sequence store. * * @cloudformationAttribute Status */ readonly attrStatus: string; /** * The status message of the sequence store. * * @cloudformationAttribute StatusMessage */ readonly attrStatusMessage: string; /** * The last-updated time of the Sequence Store. * * @cloudformationAttribute UpdateTime */ readonly attrUpdateTime: string; /** * Location of the access logs. */ accessLogLocation?: string; /** * A description for the store. */ description?: string; /** * The algorithm family of the ETag. */ eTagAlgorithmFamily?: string; /** * An S3 location that is used to store files that have failed a direct upload. */ fallbackLocation?: string; /** * A name for the store. */ name: string; /** * The tags keys to propagate to the S3 objects associated with read sets in the sequence store. */ propagatedSetLevelTags?: Array<string>; /** * The resource policy that controls S3 access on the store. */ s3AccessPolicy?: any | cdk.IResolvable; /** * Server-side encryption (SSE) settings for the store. */ sseConfig?: cdk.IResolvable | CfnSequenceStore.SseConfigProperty; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Tags for the store. */ tagsRaw?: Record<string, string>; /** * Create a new `AWS::Omics::SequenceStore`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnSequenceStoreProps); get sequenceStoreRef(): SequenceStoreReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnSequenceStore { /** * Server-side encryption (SSE) settings for a store. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-sequencestore-sseconfig.html */ interface SseConfigProperty { /** * An encryption key ARN. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-sequencestore-sseconfig.html#cfn-omics-sequencestore-sseconfig-keyarn */ readonly keyArn?: string; /** * The encryption type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-sequencestore-sseconfig.html#cfn-omics-sequencestore-sseconfig-type */ readonly type: string; } } /** * Properties for defining a `CfnSequenceStore` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html */ export interface CfnSequenceStoreProps { /** * Location of the access logs. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-accessloglocation */ readonly accessLogLocation?: string; /** * A description for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-description */ readonly description?: string; /** * The algorithm family of the ETag. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-etagalgorithmfamily */ readonly eTagAlgorithmFamily?: string; /** * An S3 location that is used to store files that have failed a direct upload. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-fallbacklocation */ readonly fallbackLocation?: string; /** * A name for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-name */ readonly name: string; /** * The tags keys to propagate to the S3 objects associated with read sets in the sequence store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-propagatedsetleveltags */ readonly propagatedSetLevelTags?: Array<string>; /** * The resource policy that controls S3 access on the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-s3accesspolicy */ readonly s3AccessPolicy?: any | cdk.IResolvable; /** * Server-side encryption (SSE) settings for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-sseconfig */ readonly sseConfig?: cdk.IResolvable | CfnSequenceStore.SseConfigProperty; /** * Tags for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-sequencestore.html#cfn-omics-sequencestore-tags */ readonly tags?: Record<string, string>; } /** * Create a store for variant data. * * @cloudformationResource AWS::Omics::VariantStore * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html */ export declare class CfnVariantStore extends cdk.CfnResource implements cdk.IInspectable, IVariantStoreRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnVariantStore from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnVariantStore; /** * Checks whether the given object is a CfnVariantStore */ static isCfnVariantStore(x: any): x is CfnVariantStore; /** * Creates a new IVariantStoreRef from a variantStoreName */ static fromVariantStoreName(scope: constructs.Construct, id: string, variantStoreName: string): IVariantStoreRef; static arnForVariantStore(resource: IVariantStoreRef): string; /** * When the store was created. * * @cloudformationAttribute CreationTime */ readonly attrCreationTime: string; /** * The store's ID. * * @cloudformationAttribute Id */ readonly attrId: string; /** * The store's status. * * @cloudformationAttribute Status */ readonly attrStatus: string; /** * The store's status message. * * @cloudformationAttribute StatusMessage */ readonly attrStatusMessage: string; /** * The store's ARN. * * @cloudformationAttribute StoreArn */ readonly attrStoreArn: string; /** * The store's size in bytes. * * @cloudformationAttribute StoreSizeBytes */ readonly attrStoreSizeBytes: cdk.IResolvable; /** * When the store was updated. * * @cloudformationAttribute UpdateTime */ readonly attrUpdateTime: string; /** * A description for the store. */ description?: string; /** * A name for the store. */ name: string; /** * The genome reference for the store's variants. */ reference: cdk.IResolvable | CfnVariantStore.ReferenceItemProperty; /** * Server-side encryption (SSE) settings for the store. */ sseConfig?: cdk.IResolvable | CfnVariantStore.SseConfigProperty; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Tags for the store. */ tagsRaw?: Record<string, string>; /** * Create a new `AWS::Omics::VariantStore`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props: CfnVariantStoreProps); get variantStoreRef(): VariantStoreReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnVariantStore { /** * The read set's genome reference ARN. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-referenceitem.html */ interface ReferenceItemProperty { /** * The reference's ARN. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-referenceitem.html#cfn-omics-variantstore-referenceitem-referencearn */ readonly referenceArn: string; } /** * Server-side encryption (SSE) settings for a store. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-sseconfig.html */ interface SseConfigProperty { /** * An encryption key ARN. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-sseconfig.html#cfn-omics-variantstore-sseconfig-keyarn */ readonly keyArn?: string; /** * The encryption type. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-variantstore-sseconfig.html#cfn-omics-variantstore-sseconfig-type */ readonly type: string; } } /** * Properties for defining a `CfnVariantStore` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html */ export interface CfnVariantStoreProps { /** * A description for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-description */ readonly description?: string; /** * A name for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-name */ readonly name: string; /** * The genome reference for the store's variants. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-reference */ readonly reference: cdk.IResolvable | CfnVariantStore.ReferenceItemProperty; /** * Server-side encryption (SSE) settings for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-sseconfig */ readonly sseConfig?: cdk.IResolvable | CfnVariantStore.SseConfigProperty; /** * Tags for the store. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-variantstore.html#cfn-omics-variantstore-tags */ readonly tags?: Record<string, string>; } /** * Creates a private workflow. Before you create a private workflow, you must create and configure these required resources:. * * - *Workflow definition file:* A workflow definition file written in WDL, Nextflow, or CWL. The workflow definition specifies the inputs and outputs for runs that use the workflow. It also includes specifications for the runs and run tasks for your workflow, including compute and memory requirements. The workflow definition file must be in `.zip` format. For more information, see [Workflow definition files](https://docs.aws.amazon.com/omics/latest/dev/workflow-definition-files.html) in AWS HealthOmics. * * - You can use Amazon Q CLI to build and validate your workflow definition files in WDL, Nextflow, and CWL. For more information, see [Example prompts for Amazon Q CLI](https://docs.aws.amazon.com/omics/latest/dev/getting-started.html#omics-q-prompts) and the [AWS HealthOmics Agentic generative AI tutorial](https://docs.aws.amazon.com/https://github.com/aws-samples/aws-healthomics-tutorials/tree/main/generative-ai) on GitHub. * - *(Optional) Parameter template file:* A parameter template file written in JSON. Create the file to define the run parameters, or AWS HealthOmics generates the parameter template for you. For more information, see [Parameter template files for HealthOmics workflows](https://docs.aws.amazon.com/omics/latest/dev/parameter-templates.html) . * - *ECR container images:* Create container images for the workflow in a private ECR repository, or synchronize images from a supported upstream registry with your Amazon ECR private repository. * - *(Optional) Sentieon licenses:* Request a Sentieon license to use the Sentieon software in private workflows. * * For more information, see [Creating or updating a private workflow in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html) in the *AWS HealthOmics User Guide* . * * @cloudformationResource AWS::Omics::Workflow * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html */ export declare class CfnWorkflow extends cdk.CfnResource implements cdk.IInspectable, IWorkflowRef, cdk.ITaggable { /** * The CloudFormation resource type name for this resource class. */ static readonly CFN_RESOURCE_TYPE_NAME: string; /** * Build a CfnWorkflow from CloudFormation properties * * A factory method that creates a new instance of this class from an object * containing the CloudFormation properties of this resource. * Used in the @aws-cdk/cloudformation-include module. * * @internal */ static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnWorkflow; /** * Checks whether the given object is a CfnWorkflow */ static isCfnWorkflow(x: any): x is CfnWorkflow; static arnForWorkflow(resource: IWorkflowRef): string; /** * The ARN for the workflow. * * @cloudformationAttribute Arn */ readonly attrArn: string; /** * When the workflow was created. * * @cloudformationAttribute CreationTime */ readonly attrCreationTime: string; /** * The workflow's ID. * * @cloudformationAttribute Id */ readonly attrId: string; /** * The workflow's status. * * @cloudformationAttribute Status */ readonly attrStatus: string; /** * The workflow's type. * * @cloudformationAttribute Type */ readonly attrType: string; /** * @cloudformationAttribute Uuid */ readonly attrUuid: string; accelerators?: string; /** * Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. */ containerRegistryMap?: CfnWorkflow.ContainerRegistryMapProperty | cdk.IResolvable; containerRegistryMapUri?: string; /** * Contains information about a source code repository that hosts the workflow definition files. */ definitionRepository?: CfnWorkflow.DefinitionRepositoryProperty | cdk.IResolvable; /** * The URI of a definition for the workflow. */ definitionUri?: string; /** * The parameter's description. */ description?: string; /** * An engine for the workflow. */ engine?: string; /** * The path of the main definition file for the workflow. */ main?: string; /** * The workflow's name. */ name?: string; /** * The workflow's parameter template. */ parameterTemplate?: cdk.IResolvable | Record<string, cdk.IResolvable | CfnWorkflow.WorkflowParameterProperty>; /** * Path to the primary workflow parameter template JSON file inside the repository. */ parameterTemplatePath?: string; /** * The markdown content for the workflow's README file. */ readmeMarkdown?: string; /** * The path to the workflow README markdown file within the repository. */ readmePath?: string; /** * The S3 URI of the README file for the workflow. */ readmeUri?: string; /** * The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version. */ storageCapacity?: number; storageType?: string; /** * Tag Manager which manages the tags for this resource */ readonly tags: cdk.TagManager; /** * Tags for the workflow. */ tagsRaw?: Record<string, string>; /** * Optional workflow bucket owner ID to verify the workflow bucket. */ workflowBucketOwnerId?: string; /** * Create a new `AWS::Omics::Workflow`. * * @param scope Scope in which this resource is defined * @param id Construct identifier for this resource (unique in its scope) * @param props Resource properties */ constructor(scope: constructs.Construct, id: string, props?: CfnWorkflowProps); get workflowRef(): WorkflowReference; protected get cfnProperties(): Record<string, any>; /** * Examines the CloudFormation resource and discloses attributes * * @param inspector tree inspector to collect and process attributes */ inspect(inspector: cdk.TreeInspector): void; protected renderProperties(props: Record<string, any>): Record<string, any>; } export declare namespace CfnWorkflow { /** * A workflow parameter. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html */ interface WorkflowParameterProperty { /** * The parameter's description. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html#cfn-omics-workflow-workflowparameter-description */ readonly description?: string; /** * Whether the parameter is optional. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-workflowparameter.html#cfn-omics-workflow-workflowparameter-optional */ readonly optional?: boolean | cdk.IResolvable; } /** * Contains information about a source code repository that hosts the workflow definition files. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-definitionrepository.html */ interface DefinitionRepositoryProperty { /** * The Amazon Resource Name (ARN) of the connection to the source code repository. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-definitionrepository.html#cfn-omics-workflow-definitionrepository-connectionarn */ readonly connectionArn?: string; /** * A list of file patterns to exclude when retrieving the workflow definition from the repository. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-definitionrepository.html#cfn-omics-workflow-definitionrepository-excludefilepatterns */ readonly excludeFilePatterns?: Array<string>; /** * The full repository identifier, including the repository owner and name. * * For example, 'repository-owner/repository-name'. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-definitionrepository.html#cfn-omics-workflow-definitionrepository-fullrepositoryid */ readonly fullRepositoryId?: string; /** * The source reference for the repository, such as a branch name, tag, or commit ID. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-definitionrepository.html#cfn-omics-workflow-definitionrepository-sourcereference */ readonly sourceReference?: cdk.IResolvable | CfnWorkflow.SourceReferenceProperty; } /** * Contains information about the source reference in a code repository, such as a branch, tag, or commit. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-sourcereference.html */ interface SourceReferenceProperty { /** * The type of source reference, such as branch, tag, or commit. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-sourcereference.html#cfn-omics-workflow-sourcereference-type */ readonly type?: string; /** * The value of the source reference, such as the branch name, tag name, or commit ID. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-sourcereference.html#cfn-omics-workflow-sourcereference-value */ readonly value?: string; } /** * Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries. * * For more information, see [Container images](https://docs.aws.amazon.com/omics/latest/dev/workflows-ecr.html) in the *AWS HealthOmics User Guide* . * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-containerregistrymap.html */ interface ContainerRegistryMapProperty { /** * Image mappings specify path mappings between the ECR private repository and their corresponding external repositories. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-containerregistrymap.html#cfn-omics-workflow-containerregistrymap-imagemappings */ readonly imageMappings?: Array<CfnWorkflow.ImageMappingProperty | cdk.IResolvable> | cdk.IResolvable; /** * Mapping that provides the ECR repository path where upstream container images are pulled and synchronized. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-containerregistrymap.html#cfn-omics-workflow-containerregistrymap-registrymappings */ readonly registryMappings?: Array<cdk.IResolvable | CfnWorkflow.RegistryMappingProperty> | cdk.IResolvable; } /** * If you are using the ECR pull through cache feature, the registry mapping maps between the ECR repository and the upstream registry where container images are pulled and synchronized. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-registrymapping.html */ interface RegistryMappingProperty { /** * Account ID of the account that owns the upstream container image. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-registrymapping.html#cfn-omics-workflow-registrymapping-ecraccountid */ readonly ecrAccountId?: string; /** * The repository prefix to use in the ECR private repository. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-registrymapping.html#cfn-omics-workflow-registrymapping-ecrrepositoryprefix */ readonly ecrRepositoryPrefix?: string; /** * The URI of the upstream registry. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-registrymapping.html#cfn-omics-workflow-registrymapping-upstreamregistryurl */ readonly upstreamRegistryUrl?: string; /** * The repository prefix of the corresponding repository in the upstream registry. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-registrymapping.html#cfn-omics-workflow-registrymapping-upstreamrepositoryprefix */ readonly upstreamRepositoryPrefix?: string; } /** * Specifies image mappings that workflow tasks can use. * * For example, you can replace all the task references of a public image to use an equivalent image in your private ECR repository. You can use image mappings with upstream registries that don't support pull through cache. You need to manually synchronize the upstream registry with your private repository. * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-imagemapping.html */ interface ImageMappingProperty { /** * Specifies the URI of the corresponding image in the private ECR registry. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-imagemapping.html#cfn-omics-workflow-imagemapping-destinationimage */ readonly destinationImage?: string; /** * Specifies the URI of the source image in the upstream registry. * * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflow-imagemapping.html#cfn-omics-workflow-imagemapping-sourceimage */ readonly sourceImage?: string; } } /** * Properties for defining a `CfnWorkflow` * * @struct * @stability external * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html *