aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,345 lines • 53.1 kB
TypeScript
import * as cdk from "../../core";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
/**
* 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, 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;
/**
* 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>;
/**
* @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);
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, 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;
/**
* 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>;
/**
* @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);
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, 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;
/**
* 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>;
/**
* @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);
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, 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;
/**
* 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>;
/**
* @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);
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, 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;
/**
* 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>;
/**
* @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);
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 files* : Define your workflow in one or more workflow definition files, 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.
* - (Optional) *Parameter template* : You can create a parameter template file that defines the run parameters, or AWS HealthOmics can generate the parameter template for you.
* - *ECR container images* : Create one or more container images for the workflow. Store the images in a private ECR repository.
* - (Optional) *Sentieon licenses* : Request a Sentieon license if using the Sentieon software in a private workflow.
*
* 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, 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;
/**
* 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;
/**
* 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;
/**
* @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);
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;
}
}
/**
* Properties for defining a `CfnWorkflow`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html
*/
export interface CfnWorkflowProps {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-accelerators
*/
readonly accelerators?: string;
/**
* Contains information about a source code repository that hosts the workflow definition files.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-definitionrepository
*/
readonly definitionRepository?: CfnWorkflow.DefinitionRepositoryProperty | cdk.IResolvable;
/**
* The URI of a definition for the workflow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-definitionuri
*/
readonly definitionUri?: string;
/**
* The parameter's description.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-description
*/
readonly description?: string;
/**
* An engine for the workflow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-engine
*/
readonly engine?: string;
/**
* The path of the main definition file for the workflow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-main
*/
readonly main?: string;
/**
* The workflow's name.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-name
*/
readonly name?: string;
/**
* The workflow's parameter template.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-parametertemplate
*/
readonly parameterTemplate?: cdk.IResolvable | Record<string, cdk.IResolvable | CfnWorkflow.WorkflowParameterProperty>;
/**
* Path to the primary workflow parameter template JSON file inside the repository.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-parametertemplatepath
*/
readonly parameterTemplatePath?: string;
/**
* The markdown content for the workflow's README file.
*
* This provides documentation and usage information for users of the workflow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-readmemarkdown
*/
readonly readmeMarkdown?: string;
/**
* The path to the workflow README markdown file within the repository.
*
* This file provides documentation and usage information for the workflow. If not specified, the README.md file from the root directory of the repository will be used.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-readmepath
*/
readonly readmePath?: string;
/**
* The S3 URI of the README file for the workflow.
*
* This file provides documentation and usage information for the workflow. The S3 URI must begin with s3://USER-OWNED-BUCKET/. The requester must have access to the S3 bucket and object. The max README content length is 500 KiB.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-readmeuri
*/
readonly readmeUri?: string;
/**
* The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
*
* The `storageCapacity` can be overwritten at run time. The storage capacity is not required for runs with a `DYNAMIC` storage type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-storagecapacity
*/
readonly storageCapacity?: number;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-storagetype
*/
readonly storageType?: string;
/**
* Tags for the workflow.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-tags
*/
readonly tags?: Record<string, string>;
/**
* Optional workflow bucket owner ID to verify the workflow bucket.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflow.html#cfn-omics-workflow-workflowbucketownerid
*/
readonly workflowBucketOwnerId?: string;
}
/**
* Creates a new workflow version for the workflow that you specify with the `workflowId` parameter.
*
* When you create a new version of a workflow, you need to specify the configuration for the new version. It doesn't inherit any configuration values from the workflow.
*
* Provide a version name that is unique for this workflow. You cannot change the name after HealthOmics creates the version.
*
* > Don't include any personally identifiable information (PII) in the version name. Version names appear in the workflow version ARN.
*
* For more information, see [Workflow versioning in AWS HealthOmics](https://docs.aws.amazon.com/omics/latest/dev/workflow-versions.html) in the *AWS HealthOmics User Guide* .
*
* @cloudformationResource AWS::Omics::WorkflowVersion
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-omics-workflowversion.html
*/
export declare class CfnWorkflowVersion extends cdk.CfnResource implements cdk.IInspectable, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnWorkflowVersion 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): CfnWorkflowVersion;
/**
* ARN of the workflow version.
*
* @cloudformationAttribute Arn
*/
readonly attrArn: string;
/**
* The creation time of the workflow version.
*
* @cloudformationAttribute CreationTime
*/
readonly attrCreationTime: string;
/**
* The status of the workflow version.
*
* @cloudformationAttribute Status
*/
readonly attrStatus: string;
/**
* The type of the workflow version.
*
* @cloudformationAttribute Type
*/
readonly attrType: string;
/**
* @cloudformationAttribute Uuid
*/
readonly attrUuid: string;
accelerators?: string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
definitionUri?: string;
/**
* The description of the workflow version.
*/
description?: string;
engine?: string;
main?: string;
parameterTemplate?: cdk.IResolvable | Record<string, cdk.IResolvable | CfnWorkflowVersion.WorkflowParameterProperty>;
storageCapacity?: number;
storageType?: string;
/**
* A map of resource tags.
*/
tags?: Record<string, string>;
/**
* The name of the workflow version.
*/
versionName: string;
workflowBucketOwnerId?: string;
/**
* The workflow's ID.
*/
workflowId: string;
/**
* @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: CfnWorkflowVersionProps);
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 CfnWorkflowVersion {
/**
* A workflow parameter.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowparameter.html
*/
interface WorkflowParameterProperty {
/**
* The parameter's description.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowparameter.html#cfn-omics-workflowversion-workflowparameter-description
*/
readonly description?: string;
/**
* Whether the parameter is optional.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-omics-workflowversion-workflowparameter.html#cfn-omi