aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,404 lines • 96.5 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { AnnotationStoreReference, ConfigurationReference, IAnnotationStoreRef, IConfigurationRef, 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;
/**
* A description for the store.
*/
private _description?;
/**
* The name of the Annotation Store.
*/
private _name;
/**
* The genome reference for the store's annotations.
*/
private _reference?;
/**
* The store's server-side encryption (SSE) settings.
*/
private _sseConfig?;
/**
* The annotation file format of the store.
*/
private _storeFormat;
/**
* File parsing options for the annotation store.
*/
private _storeOptions?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Tags for the store.
*/
private _tagsRaw?;
/**
* 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;
/**
* A description for the store.
*/
get description(): string | undefined;
/**
* A description for the store.
*/
set description(value: string | undefined);
/**
* The name of the Annotation Store.
*/
get name(): string;
/**
* The name of the Annotation Store.
*/
set name(value: string);
/**
* The genome reference for the store's annotations.
*/
get reference(): cdk.IResolvable | CfnAnnotationStore.ReferenceItemProperty | undefined;
/**
* The genome reference for the store's annotations.
*/
set reference(value: cdk.IResolvable | CfnAnnotationStore.ReferenceItemProperty | undefined);
/**
* The store's server-side encryption (SSE) settings.
*/
get sseConfig(): cdk.IResolvable | CfnAnnotationStore.SseConfigProperty | undefined;
/**
* The store's server-side encryption (SSE) settings.
*/
set sseConfig(value: cdk.IResolvable | CfnAnnotationStore.SseConfigProperty | undefined);
/**
* The annotation file format of the store.
*/
get storeFormat(): string;
/**
* The annotation file format of the store.
*/
set storeFormat(value: string);
/**
* File parsing options for the annotation store.
*/
get storeOptions(): cdk.IResolvable | CfnAnnotationStore.StoreOptionsProperty | undefined;
/**
* File parsing options for the annotation store.
*/
set storeOptions(value: cdk.IResolvable | CfnAnnotationStore.StoreOptionsProperty | undefined);
/**
* Tags for the store.
*/
get tagsRaw(): Record<string, string> | undefined;
/**
* Tags for the store.
*/
set tagsRaw(value: Record<string, string> | undefined);
/**
* When the store was created.
*
* @cloudformationAttribute CreationTime
*/
get attrCreationTime(): string;
/**
* The store's ID.
*
* @cloudformationAttribute Id
*/
get attrId(): string;
/**
* The store's status.
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
/**
* The store's status message.
*
* @cloudformationAttribute StatusMessage
*/
get attrStatusMessage(): string;
/**
* The store's ARN.
*
* @cloudformationAttribute StoreArn
*/
get attrStoreArn(): string;
/**
* The store's size in bytes.
*
* @cloudformationAttribute StoreSizeBytes
*/
get attrStoreSizeBytes(): cdk.IResolvable;
/**
* When the store was updated.
*
* @cloudformationAttribute UpdateTime
*/
get attrUpdateTime(): string;
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;
/**
* A description for the store.
*/
private _description?;
/**
* A name for the store.
*/
private _name;
/**
* Server-side encryption (SSE) settings for the store.
*/
private _sseConfig?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Tags for the store.
*/
private _tagsRaw?;
/**
* 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;
/**
* A description for the store.
*/
get description(): string | undefined;
/**
* A description for the store.
*/
set description(value: string | undefined);
/**
* A name for the store.
*/
get name(): string;
/**
* A name for the store.
*/
set name(value: string);
/**
* Server-side encryption (SSE) settings for the store.
*/
get sseConfig(): cdk.IResolvable | CfnReferenceStore.SseConfigProperty | undefined;
/**
* Server-side encryption (SSE) settings for the store.
*/
set sseConfig(value: cdk.IResolvable | CfnReferenceStore.SseConfigProperty | undefined);
/**
* Tags for the store.
*/
get tagsRaw(): Record<string, string> | undefined;
/**
* Tags for the store.
*/
set tagsRaw(value: Record<string, string> | undefined);
/**
* The store's ARN.
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
/**
* When the store was created.
*
* @cloudformationAttribute CreationTime
*/
get attrCreationTime(): string;
/**
* The store's ID.
*
* @cloudformationAttribute ReferenceStoreId
*/
get attrReferenceStoreId(): string;
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 group's maximum CPU count setting.
*/
private _maxCpus?;
/**
* The group's maximum duration setting in minutes.
*/
private _maxDuration?;
/**
* The maximum GPUs that can be used by a run group.
*/
private _maxGpus?;
/**
* The group's maximum concurrent run setting.
*/
private _maxRuns?;
/**
* The group's name.
*/
private _name?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Tags for the group.
*/
private _tagsRaw?;
/**
* 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;
/**
* The group's maximum CPU count setting.
*/
get maxCpus(): number | undefined;
/**
* The group's maximum CPU count setting.
*/
set maxCpus(value: number | undefined);
/**
* The group's maximum duration setting in minutes.
*/
get maxDuration(): number | undefined;
/**
* The group's maximum duration setting in minutes.
*/
set maxDuration(value: number | undefined);
/**
* The maximum GPUs that can be used by a run group.
*/
get maxGpus(): number | undefined;
/**
* The maximum GPUs that can be used by a run group.
*/
set maxGpus(value: number | undefined);
/**
* The group's maximum concurrent run setting.
*/
get maxRuns(): number | undefined;
/**
* The group's maximum concurrent run setting.
*/
set maxRuns(value: number | undefined);
/**
* The group's name.
*/
get name(): string | undefined;
/**
* The group's name.
*/
set name(value: string | undefined);
/**
* Tags for the group.
*/
get tagsRaw(): Record<string, string> | undefined;
/**
* Tags for the group.
*/
set tagsRaw(value: Record<string, string> | undefined);
/**
* The run group's ARN.
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
/**
* When the run group was created.
*
* @cloudformationAttribute CreationTime
*/
get attrCreationTime(): string;
/**
* The run group's ID.
*
* @cloudformationAttribute Id
*/
get attrId(): string;
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;
/**
* Location of the access logs.
*/
private _accessLogLocation?;
/**
* A description for the store.
*/
private _description?;
/**
* The algorithm family of the ETag.
*/
private _eTagAlgorithmFamily?;
/**
* An S3 location that is used to store files that have failed a direct upload.
*/
private _fallbackLocation?;
/**
* A name for the store.
*/
private _name;
/**
* The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
*/
private _propagatedSetLevelTags?;
/**
* The resource policy that controls S3 access on the store.
*/
private _s3AccessPolicy?;
/**
* Server-side encryption (SSE) settings for the store.
*/
private _sseConfig?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Tags for the store.
*/
private _tagsRaw?;
/**
* 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;
/**
* Location of the access logs.
*/
get accessLogLocation(): string | undefined;
/**
* Location of the access logs.
*/
set accessLogLocation(value: string | undefined);
/**
* A description for the store.
*/
get description(): string | undefined;
/**
* A description for the store.
*/
set description(value: string | undefined);
/**
* The algorithm family of the ETag.
*/
get eTagAlgorithmFamily(): string | undefined;
/**
* The algorithm family of the ETag.
*/
set eTagAlgorithmFamily(value: string | undefined);
/**
* An S3 location that is used to store files that have failed a direct upload.
*/
get fallbackLocation(): string | undefined;
/**
* An S3 location that is used to store files that have failed a direct upload.
*/
set fallbackLocation(value: string | undefined);
/**
* A name for the store.
*/
get name(): string;
/**
* A name for the store.
*/
set name(value: string);
/**
* The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
*/
get propagatedSetLevelTags(): Array<string> | undefined;
/**
* The tags keys to propagate to the S3 objects associated with read sets in the sequence store.
*/
set propagatedSetLevelTags(value: Array<string> | undefined);
/**
* The resource policy that controls S3 access on the store.
*/
get s3AccessPolicy(): any | cdk.IResolvable | undefined;
/**
* The resource policy that controls S3 access on the store.
*/
set s3AccessPolicy(value: any | cdk.IResolvable | undefined);
/**
* Server-side encryption (SSE) settings for the store.
*/
get sseConfig(): cdk.IResolvable | CfnSequenceStore.SseConfigProperty | undefined;
/**
* Server-side encryption (SSE) settings for the store.
*/
set sseConfig(value: cdk.IResolvable | CfnSequenceStore.SseConfigProperty | undefined);
/**
* Tags for the store.
*/
get tagsRaw(): Record<string, string> | undefined;
/**
* Tags for the store.
*/
set tagsRaw(value: Record<string, string> | undefined);
/**
* The store's ARN.
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
/**
* When the store was created.
*
* @cloudformationAttribute CreationTime
*/
get attrCreationTime(): string;
/**
* This is ARN of the access point associated with the S3 bucket storing read sets.
*
* @cloudformationAttribute S3AccessPointArn
*/
get attrS3AccessPointArn(): string;
/**
* The S3 URI of the sequence store.
*
* @cloudformationAttribute S3Uri
*/
get attrS3Uri(): string;
/**
* The store's ID.
*
* @cloudformationAttribute SequenceStoreId
*/
get attrSequenceStoreId(): string;
/**
* Status of the sequence store.
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
/**
* The status message of the sequence store.
*
* @cloudformationAttribute StatusMessage
*/
get attrStatusMessage(): string;
/**
* The last-updated time of the Sequence Store.
*
* @cloudformationAttribute UpdateTime
*/
get attrUpdateTime(): string;
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;
/**
* A description for the store.
*/
private _description?;
/**
* A name for the store.
*/
private _name;
/**
* The genome reference for the store's variants.
*/
private _reference;
/**
* Server-side encryption (SSE) settings for the store.
*/
private _sseConfig?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Tags for the store.
*/
private _tagsRaw?;
/**
* 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;
/**
* A description for the store.
*/
get description(): string | undefined;
/**
* A description for the store.
*/
set description(value: string | undefined);
/**
* A name for the store.
*/
get name(): string;
/**
* A name for the store.
*/
set name(value: string);
/**
* The genome reference for the store's variants.
*/
get reference(): cdk.IResolvable | CfnVariantStore.ReferenceItemProperty;
/**
* The genome reference for the store's variants.
*/
set reference(value: cdk.IResolvable | CfnVariantStore.ReferenceItemProperty);
/**
* Server-side encryption (SSE) settings for the store.
*/
get sseConfig(): cdk.IResolvable | CfnVariantStore.SseConfigProperty | undefined;
/**
* Server-side encryption (SSE) settings for the store.
*/
set sseConfig(value: cdk.IResolvable | CfnVariantStore.SseConfigProperty | undefined);
/**
* Tags for the store.
*/
get tagsRaw(): Record<string, string> | undefined;
/**
* Tags for the store.
*/
set tagsRaw(value: Record<string, string> | undefined);
/**
* When the store was created.
*
* @cloudformationAttribute CreationTime
*/
get attrCreationTime(): string;
/**
* The store's ID.
*
* @cloudformationAttribute Id
*/
get attrId(): string;
/**
* The store's status.
*
* @cloudformationAttribute Status
*/
get attrStatus(): string;
/**
* The store's status message.
*
* @cloudformationAttribute StatusMessage
*/
get attrStatusMessage(): string;
/**
* The store's ARN.
*
* @cloudformationAttribute StoreArn
*/
get attrStoreArn(): string;
/**
* The store's size in bytes.
*
* @cloudformationAttribute StoreSizeBytes
*/
get attrStoreSizeBytes(): cdk.IResolvable;
/**
* When the store was updated.
*
* @cloudformationAttribute UpdateTime
*/
get attrUpdateTime(): string;
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;
private _accelerators?;
/**
* Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.
*/
private _containerRegistryMap?;
private _containerRegistryMapUri?;
/**
* Contains information about a source code repository that hosts the workflow definition files.
*/
private _definitionRepository?;
/**
* The URI of a definition for the workflow.
*/
private _definitionUri?;
/**
* The parameter's description.
*/
private _description?;
/**
* An engine for the workflow.
*/
private _engine?;
/**
* The path of the main definition file for the workflow.
*/
private _main?;
/**
* The workflow's name.
*/
private _name?;
/**
* The workflow's parameter template.
*/
private _parameterTemplate?;
/**
* Path to the primary workflow parameter template JSON file inside the repository.
*/
private _parameterTemplatePath?;
/**
* The markdown content for the workflow's README file.
*/
private _readmeMarkdown?;
/**
* The path to the workflow README markdown file within the repository.
*/
private _readmePath?;
/**
* The S3 URI of the README file for the workflow.
*/
private _readmeUri?;
/**
* The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.
*/
private _storageCapacity?;
private _storageType?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Tags for the workflow.
*/
private _tagsRaw?;
/**
* Optional workflow bucket owner ID to verify the workflow bucket.
*/
private _workflowBucketOwnerId?;
/**
* 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;
get accelerators(): string | undefined;
set accelerators(value: string | undefined);
/**
* Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.
*/
get containerRegistryMap(): CfnWorkflow.ContainerRegistryMapProperty | cdk.IResolvable | undefined;
/**
* Use a container registry map to specify mappings between the ECR private repository and one or more upstream registries.
*/
set containerRegistryMap(value: CfnWorkflow.ContainerRegistryMapProperty | cdk.IResolvable | undefined);
get containerRegistryMapUri(): string | undefined;
set containerRegistryMapUri(value: string | undefined);
/**
* Contains information about a source code repository that hosts the workflow definition files.
*/
get definitionRepository(): CfnWorkflow.DefinitionRepositoryProperty | cdk.IResolvable | undefined;
/**
* Contains information about a source code repository that hosts the workflow definition files.
*/
set definitionRepository(value: CfnWorkflow.DefinitionRepositoryProperty | cdk.IResolvable | undefined);
/**
* The URI of a definition for the workflow.
*/
get definitionUri(): string | undefined;
/**
* The URI of a definition for the workflow.
*/
set definitionUri(value: string | undefined);
/**
* The parameter's description.
*/
get description(): string | undefined;
/**
* The parameter's description.
*/
set description(value: string | undefined);
/**
* An engine for the workflow.
*/
get engine(): string | undefined;
/**
* An engine for the workflow.
*/
set engine(value: string | undefined);
/**
* The path of the main definition file for the workflow.
*/
get main(): string | undefined;
/**
* The path of the main definition file for the workflow.
*/
set main(value: string | undefined);
/**
* The workflow's name.
*/
get name(): string | undefined;
/**
* The workflow's name.
*/
set name(value: string | undefined);
/**
* The workflow's parameter template.
*/
get parameterTemplate(): cdk.IResolvable | Record<string, cdk.IResolvable | CfnWorkflow.WorkflowParameterProperty> | undefined;
/**
* The workflow's parameter template.
*/
set parameterTemplate(value: cdk.IResolvable | Record<string, cdk.IResolvable | CfnWorkflow.WorkflowParameterProperty> | undefined);
/**
* Path to the primary workflow parameter template JSON file inside the repository.
*/
get parameterTemplatePath(): string | undefined;
/**
* Path to the primary workflow parameter template JSON file inside the repository.
*/
set parameterTemplatePath(value: string | undefined);
/**
* The markdown content for the workflow's R