This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS HealthOmics
<a name="AWS_Omics"></a>

**Resource types**
+ [AWS::Omics::AnnotationStore](aws-resource-omics-annotationstore.md)
+ [AWS::Omics::Configuration](aws-resource-omics-configuration.md)
+ [AWS::Omics::ReferenceStore](aws-resource-omics-referencestore.md)
+ [AWS::Omics::RunGroup](aws-resource-omics-rungroup.md)
+ [AWS::Omics::SequenceStore](aws-resource-omics-sequencestore.md)
+ [AWS::Omics::VariantStore](aws-resource-omics-variantstore.md)
+ [AWS::Omics::Workflow](aws-resource-omics-workflow.md)
+ [AWS::Omics::WorkflowVersion](aws-resource-omics-workflowversion.md)

# AWS::Omics::AnnotationStore
<a name="aws-resource-omics-annotationstore"></a>

**Important**  
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.

## Syntax
<a name="aws-resource-omics-annotationstore-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-omics-annotationstore-syntax.json"></a>

```
{
  "Type" : "AWS::Omics::AnnotationStore",
  "Properties" : {
      "[Description](#cfn-omics-annotationstore-description)" : String,
      "[Name](#cfn-omics-annotationstore-name)" : String,
      "[Reference](#cfn-omics-annotationstore-reference)" : ReferenceItem,
      "[SseConfig](#cfn-omics-annotationstore-sseconfig)" : SseConfig,
      "[StoreFormat](#cfn-omics-annotationstore-storeformat)" : String,
      "[StoreOptions](#cfn-omics-annotationstore-storeoptions)" : StoreOptions,
      "[Tags](#cfn-omics-annotationstore-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-omics-annotationstore-syntax.yaml"></a>

```
Type: AWS::Omics::AnnotationStore
Properties:
  [Description](#cfn-omics-annotationstore-description): String
  [Name](#cfn-omics-annotationstore-name): String
  [Reference](#cfn-omics-annotationstore-reference): 
    ReferenceItem
  [SseConfig](#cfn-omics-annotationstore-sseconfig): 
    SseConfig
  [StoreFormat](#cfn-omics-annotationstore-storeformat): String
  [StoreOptions](#cfn-omics-annotationstore-storeoptions): 
    StoreOptions
  [Tags](#cfn-omics-annotationstore-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-omics-annotationstore-properties"></a>

`Description`  <a name="cfn-omics-annotationstore-description"></a>
A description for the store.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-omics-annotationstore-name"></a>
The name of the Annotation Store.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([a-z]){1}([a-z0-9_]){2,254}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Reference`  <a name="cfn-omics-annotationstore-reference"></a>
The genome reference for the store's annotations.  
*Required*: No  
*Type*: [ReferenceItem](aws-properties-omics-annotationstore-referenceitem.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SseConfig`  <a name="cfn-omics-annotationstore-sseconfig"></a>
The store's server-side encryption (SSE) settings.  
*Required*: No  
*Type*: [SseConfig](aws-properties-omics-annotationstore-sseconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StoreFormat`  <a name="cfn-omics-annotationstore-storeformat"></a>
The annotation file format of the store.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `GFF | TSV | VCF`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StoreOptions`  <a name="cfn-omics-annotationstore-storeoptions"></a>
File parsing options for the annotation store.  
*Required*: No  
*Type*: [StoreOptions](aws-properties-omics-annotationstore-storeoptions.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-omics-annotationstore-tags"></a>
Tags for the store.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-omics-annotationstore-return-values"></a>

### Ref
<a name="aws-resource-omics-annotationstore-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the details of this resource. For example:

`{ "Ref": "AnnotationStore.Id" }``Ref` returns the id for the annotation store. 

### Fn::GetAtt
<a name="aws-resource-omics-annotationstore-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-omics-annotationstore-return-values-fn--getatt-fn--getatt"></a>

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
When the store was created.

`Id`  <a name="Id-fn::getatt"></a>
The store's ID.

`Status`  <a name="Status-fn::getatt"></a>
The store's status.

`StatusMessage`  <a name="StatusMessage-fn::getatt"></a>
The store's status message.

`StoreArn`  <a name="StoreArn-fn::getatt"></a>
The store's ARN.

`StoreSizeBytes`  <a name="StoreSizeBytes-fn::getatt"></a>
The store's size in bytes.

`UpdateTime`  <a name="UpdateTime-fn::getatt"></a>
When the store was updated.

# AWS::Omics::AnnotationStore ReferenceItem
<a name="aws-properties-omics-annotationstore-referenceitem"></a>

A genome reference.

## Syntax
<a name="aws-properties-omics-annotationstore-referenceitem-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-annotationstore-referenceitem-syntax.json"></a>

```
{
  "[ReferenceArn](#cfn-omics-annotationstore-referenceitem-referencearn)" : String
}
```

### YAML
<a name="aws-properties-omics-annotationstore-referenceitem-syntax.yaml"></a>

```
  [ReferenceArn](#cfn-omics-annotationstore-referenceitem-referencearn): String
```

## Properties
<a name="aws-properties-omics-annotationstore-referenceitem-properties"></a>

`ReferenceArn`  <a name="cfn-omics-annotationstore-referenceitem-referencearn"></a>
The reference's ARN.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:.+$`  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::AnnotationStore SseConfig
<a name="aws-properties-omics-annotationstore-sseconfig"></a>

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

## Syntax
<a name="aws-properties-omics-annotationstore-sseconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-annotationstore-sseconfig-syntax.json"></a>

```
{
  "[KeyArn](#cfn-omics-annotationstore-sseconfig-keyarn)" : String,
  "[Type](#cfn-omics-annotationstore-sseconfig-type)" : String
}
```

### YAML
<a name="aws-properties-omics-annotationstore-sseconfig-syntax.yaml"></a>

```
  [KeyArn](#cfn-omics-annotationstore-sseconfig-keyarn): String
  [Type](#cfn-omics-annotationstore-sseconfig-type): String
```

## Properties
<a name="aws-properties-omics-annotationstore-sseconfig-properties"></a>

`KeyArn`  <a name="cfn-omics-annotationstore-sseconfig-keyarn"></a>
An encryption key ARN.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-omics-annotationstore-sseconfig-type"></a>
The encryption type.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `KMS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::AnnotationStore StoreOptions
<a name="aws-properties-omics-annotationstore-storeoptions"></a>

The store's file parsing options.

## Syntax
<a name="aws-properties-omics-annotationstore-storeoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-annotationstore-storeoptions-syntax.json"></a>

```
{
  "[TsvStoreOptions](#cfn-omics-annotationstore-storeoptions-tsvstoreoptions)" : TsvStoreOptions
}
```

### YAML
<a name="aws-properties-omics-annotationstore-storeoptions-syntax.yaml"></a>

```
  [TsvStoreOptions](#cfn-omics-annotationstore-storeoptions-tsvstoreoptions): 
    TsvStoreOptions
```

## Properties
<a name="aws-properties-omics-annotationstore-storeoptions-properties"></a>

`TsvStoreOptions`  <a name="cfn-omics-annotationstore-storeoptions-tsvstoreoptions"></a>
Formatting options for a TSV file.  
*Required*: Yes  
*Type*: [TsvStoreOptions](aws-properties-omics-annotationstore-tsvstoreoptions.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::AnnotationStore TsvStoreOptions
<a name="aws-properties-omics-annotationstore-tsvstoreoptions"></a>

The store's parsing options.

## Syntax
<a name="aws-properties-omics-annotationstore-tsvstoreoptions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-annotationstore-tsvstoreoptions-syntax.json"></a>

```
{
  "[AnnotationType](#cfn-omics-annotationstore-tsvstoreoptions-annotationtype)" : String,
  "[FormatToHeader](#cfn-omics-annotationstore-tsvstoreoptions-formattoheader)" : {Key: Value, ...},
  "[Schema](#cfn-omics-annotationstore-tsvstoreoptions-schema)" : [ {Key: Value, ...}, ... ]
}
```

### YAML
<a name="aws-properties-omics-annotationstore-tsvstoreoptions-syntax.yaml"></a>

```
  [AnnotationType](#cfn-omics-annotationstore-tsvstoreoptions-annotationtype): String
  [FormatToHeader](#cfn-omics-annotationstore-tsvstoreoptions-formattoheader): 
    Key: Value
  [Schema](#cfn-omics-annotationstore-tsvstoreoptions-schema): 
    - 
    Key: Value
```

## Properties
<a name="aws-properties-omics-annotationstore-tsvstoreoptions-properties"></a>

`AnnotationType`  <a name="cfn-omics-annotationstore-tsvstoreoptions-annotationtype"></a>
The store's annotation type.  
*Required*: No  
*Type*: String  
*Allowed values*: `GENERIC | CHR_POS | CHR_POS_REF_ALT | CHR_START_END_ONE_BASE | CHR_START_END_REF_ALT_ONE_BASE | CHR_START_END_ZERO_BASE | CHR_START_END_REF_ALT_ZERO_BASE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FormatToHeader`  <a name="cfn-omics-annotationstore-tsvstoreoptions-formattoheader"></a>
The store's header key to column name mapping.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `1000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Schema`  <a name="cfn-omics-annotationstore-tsvstoreoptions-schema"></a>
The schema of an annotation store.  
*Required*: No  
*Type*: Array of Object  
*Minimum*: `1`  
*Maximum*: `5000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::Configuration
<a name="aws-resource-omics-configuration"></a>

Create a new configuration.

## Syntax
<a name="aws-resource-omics-configuration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-omics-configuration-syntax.json"></a>

```
{
  "Type" : "AWS::Omics::Configuration",
  "Properties" : {
      "[Description](#cfn-omics-configuration-description)" : String,
      "[Name](#cfn-omics-configuration-name)" : String,
      "[RunConfigurations](#cfn-omics-configuration-runconfigurations)" : RunConfigurations,
      "[Tags](#cfn-omics-configuration-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-omics-configuration-syntax.yaml"></a>

```
Type: AWS::Omics::Configuration
Properties:
  [Description](#cfn-omics-configuration-description): String
  [Name](#cfn-omics-configuration-name): String
  [RunConfigurations](#cfn-omics-configuration-runconfigurations): 
    RunConfigurations
  [Tags](#cfn-omics-configuration-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-omics-configuration-properties"></a>

`Description`  <a name="cfn-omics-configuration-description"></a>
Description for the configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-omics-configuration-name"></a>
User-friendly name for the configuration.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z0-9][A-Za-z0-9\-\._]*$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RunConfigurations`  <a name="cfn-omics-configuration-runconfigurations"></a>
Run-specific configuration settings.  
*Required*: Yes  
*Type*: [RunConfigurations](aws-properties-omics-configuration-runconfigurations.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-omics-configuration-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-omics-configuration-return-values"></a>

### Ref
<a name="aws-resource-omics-configuration-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-omics-configuration-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-omics-configuration-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
Unique resource identifier for the configuration.

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
Configuration creation timestamp.

`Status`  <a name="Status-fn::getatt"></a>
Current configuration status.

`Uuid`  <a name="Uuid-fn::getatt"></a>
Unique identifier for the configuration.

# AWS::Omics::Configuration RunConfigurations
<a name="aws-properties-omics-configuration-runconfigurations"></a>

Run-specific configuration settings.

## Syntax
<a name="aws-properties-omics-configuration-runconfigurations-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-configuration-runconfigurations-syntax.json"></a>

```
{
  "[VpcConfig](#cfn-omics-configuration-runconfigurations-vpcconfig)" : VpcConfig
}
```

### YAML
<a name="aws-properties-omics-configuration-runconfigurations-syntax.yaml"></a>

```
  [VpcConfig](#cfn-omics-configuration-runconfigurations-vpcconfig): 
    VpcConfig
```

## Properties
<a name="aws-properties-omics-configuration-runconfigurations-properties"></a>

`VpcConfig`  <a name="cfn-omics-configuration-runconfigurations-vpcconfig"></a>
VPC configuration for workflow runs.  
*Required*: No  
*Type*: [VpcConfig](aws-properties-omics-configuration-vpcconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::Configuration VpcConfig
<a name="aws-properties-omics-configuration-vpcconfig"></a>

VPC configuration for workflow runs.

## Syntax
<a name="aws-properties-omics-configuration-vpcconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-configuration-vpcconfig-syntax.json"></a>

```
{
  "[SecurityGroupIds](#cfn-omics-configuration-vpcconfig-securitygroupids)" : [ String, ... ],
  "[SubnetIds](#cfn-omics-configuration-vpcconfig-subnetids)" : [ String, ... ]
}
```

### YAML
<a name="aws-properties-omics-configuration-vpcconfig-syntax.yaml"></a>

```
  [SecurityGroupIds](#cfn-omics-configuration-vpcconfig-securitygroupids): 
    - String
  [SubnetIds](#cfn-omics-configuration-vpcconfig-subnetids): 
    - String
```

## Properties
<a name="aws-properties-omics-configuration-vpcconfig-properties"></a>

`SecurityGroupIds`  <a name="cfn-omics-configuration-vpcconfig-securitygroupids"></a>
List of security group IDs. Maximum of 5 security groups allowed.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `5`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SubnetIds`  <a name="cfn-omics-configuration-vpcconfig-subnetids"></a>
List of subnet IDs. Maximum of 16 subnets allowed.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `16`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::ReferenceStore
<a name="aws-resource-omics-referencestore"></a>

Creates a reference store.

## Syntax
<a name="aws-resource-omics-referencestore-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-omics-referencestore-syntax.json"></a>

```
{
  "Type" : "AWS::Omics::ReferenceStore",
  "Properties" : {
      "[Description](#cfn-omics-referencestore-description)" : String,
      "[Name](#cfn-omics-referencestore-name)" : String,
      "[SseConfig](#cfn-omics-referencestore-sseconfig)" : SseConfig,
      "[Tags](#cfn-omics-referencestore-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-omics-referencestore-syntax.yaml"></a>

```
Type: AWS::Omics::ReferenceStore
Properties:
  [Description](#cfn-omics-referencestore-description): String
  [Name](#cfn-omics-referencestore-name): String
  [SseConfig](#cfn-omics-referencestore-sseconfig): 
    SseConfig
  [Tags](#cfn-omics-referencestore-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-omics-referencestore-properties"></a>

`Description`  <a name="cfn-omics-referencestore-description"></a>
A description for the store.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-omics-referencestore-name"></a>
A name for the store.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SseConfig`  <a name="cfn-omics-referencestore-sseconfig"></a>
Server-side encryption (SSE) settings for the store.  
*Required*: No  
*Type*: [SseConfig](aws-properties-omics-referencestore-sseconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-omics-referencestore-tags"></a>
Tags for the store.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-omics-referencestore-return-values"></a>

### Ref
<a name="aws-resource-omics-referencestore-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the details of this resource. For example:

`{ "Ref": "ReferenceStore.Arn" }``Ref` returns the arn for the reference store. 

### Fn::GetAtt
<a name="aws-resource-omics-referencestore-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-omics-referencestore-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
When the store was created.

`ReferenceStoreId`  <a name="ReferenceStoreId-fn::getatt"></a>
The store's ID.

# AWS::Omics::ReferenceStore SseConfig
<a name="aws-properties-omics-referencestore-sseconfig"></a>

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

## Syntax
<a name="aws-properties-omics-referencestore-sseconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-referencestore-sseconfig-syntax.json"></a>

```
{
  "[KeyArn](#cfn-omics-referencestore-sseconfig-keyarn)" : String,
  "[Type](#cfn-omics-referencestore-sseconfig-type)" : String
}
```

### YAML
<a name="aws-properties-omics-referencestore-sseconfig-syntax.yaml"></a>

```
  [KeyArn](#cfn-omics-referencestore-sseconfig-keyarn): String
  [Type](#cfn-omics-referencestore-sseconfig-type): String
```

## Properties
<a name="aws-properties-omics-referencestore-sseconfig-properties"></a>

`KeyArn`  <a name="cfn-omics-referencestore-sseconfig-keyarn"></a>
An encryption key ARN.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-omics-referencestore-sseconfig-type"></a>
The encryption type.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `KMS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::RunGroup
<a name="aws-resource-omics-rungroup"></a>

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.

## Syntax
<a name="aws-resource-omics-rungroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-omics-rungroup-syntax.json"></a>

```
{
  "Type" : "AWS::Omics::RunGroup",
  "Properties" : {
      "[MaxCpus](#cfn-omics-rungroup-maxcpus)" : Number,
      "[MaxDuration](#cfn-omics-rungroup-maxduration)" : Number,
      "[MaxGpus](#cfn-omics-rungroup-maxgpus)" : Number,
      "[MaxRuns](#cfn-omics-rungroup-maxruns)" : Number,
      "[Name](#cfn-omics-rungroup-name)" : String,
      "[Tags](#cfn-omics-rungroup-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-omics-rungroup-syntax.yaml"></a>

```
Type: AWS::Omics::RunGroup
Properties:
  [MaxCpus](#cfn-omics-rungroup-maxcpus): Number
  [MaxDuration](#cfn-omics-rungroup-maxduration): Number
  [MaxGpus](#cfn-omics-rungroup-maxgpus): Number
  [MaxRuns](#cfn-omics-rungroup-maxruns): Number
  [Name](#cfn-omics-rungroup-name): String
  [Tags](#cfn-omics-rungroup-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-omics-rungroup-properties"></a>

`MaxCpus`  <a name="cfn-omics-rungroup-maxcpus"></a>
The group's maximum CPU count setting.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `100000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxDuration`  <a name="cfn-omics-rungroup-maxduration"></a>
The group's maximum duration setting in minutes.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `100000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxGpus`  <a name="cfn-omics-rungroup-maxgpus"></a>
 The maximum GPUs that can be used by a run group.   
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `100000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaxRuns`  <a name="cfn-omics-rungroup-maxruns"></a>
The group's maximum concurrent run setting.  
*Required*: No  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `100000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-omics-rungroup-name"></a>
The group's name.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-omics-rungroup-tags"></a>
Tags for the group.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-omics-rungroup-return-values"></a>

### Ref
<a name="aws-resource-omics-rungroup-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the details of this resource. For example:

`{ "Ref": "RunGroup.CreationTime" }``Ref` returns the timestamp for a run group. 

### Fn::GetAtt
<a name="aws-resource-omics-rungroup-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-omics-rungroup-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The run group's ARN.

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
When the run group was created.

`Id`  <a name="Id-fn::getatt"></a>
The run group's ID.

# AWS::Omics::SequenceStore
<a name="aws-resource-omics-sequencestore"></a>

Creates a sequence store.

## Syntax
<a name="aws-resource-omics-sequencestore-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-omics-sequencestore-syntax.json"></a>

```
{
  "Type" : "AWS::Omics::SequenceStore",
  "Properties" : {
      "[AccessLogLocation](#cfn-omics-sequencestore-accessloglocation)" : String,
      "[Description](#cfn-omics-sequencestore-description)" : String,
      "[ETagAlgorithmFamily](#cfn-omics-sequencestore-etagalgorithmfamily)" : String,
      "[FallbackLocation](#cfn-omics-sequencestore-fallbacklocation)" : String,
      "[Name](#cfn-omics-sequencestore-name)" : String,
      "[PropagatedSetLevelTags](#cfn-omics-sequencestore-propagatedsetleveltags)" : [ String, ... ],
      "[S3AccessPolicy](#cfn-omics-sequencestore-s3accesspolicy)" : Json,
      "[SseConfig](#cfn-omics-sequencestore-sseconfig)" : SseConfig,
      "[Tags](#cfn-omics-sequencestore-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-omics-sequencestore-syntax.yaml"></a>

```
Type: AWS::Omics::SequenceStore
Properties:
  [AccessLogLocation](#cfn-omics-sequencestore-accessloglocation): String
  [Description](#cfn-omics-sequencestore-description): String
  [ETagAlgorithmFamily](#cfn-omics-sequencestore-etagalgorithmfamily): String
  [FallbackLocation](#cfn-omics-sequencestore-fallbacklocation): String
  [Name](#cfn-omics-sequencestore-name): String
  [PropagatedSetLevelTags](#cfn-omics-sequencestore-propagatedsetleveltags): 
    - String
  [S3AccessPolicy](#cfn-omics-sequencestore-s3accesspolicy): Json
  [SseConfig](#cfn-omics-sequencestore-sseconfig): 
    SseConfig
  [Tags](#cfn-omics-sequencestore-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-omics-sequencestore-properties"></a>

`AccessLogLocation`  <a name="cfn-omics-sequencestore-accessloglocation"></a>
Location of the access logs.  
*Required*: No  
*Type*: String  
*Pattern*: `^$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,800})/)?$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-omics-sequencestore-description"></a>
A description for the store.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ETagAlgorithmFamily`  <a name="cfn-omics-sequencestore-etagalgorithmfamily"></a>
The algorithm family of the ETag.  
*Required*: No  
*Type*: String  
*Allowed values*: `MD5up | SHA256up | SHA512up`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FallbackLocation`  <a name="cfn-omics-sequencestore-fallbacklocation"></a>
 An S3 location that is used to store files that have failed a direct upload.   
*Required*: No  
*Type*: String  
*Pattern*: `^$|^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/?((.{1,1024})/)?$`  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-omics-sequencestore-name"></a>
A name for the store.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PropagatedSetLevelTags`  <a name="cfn-omics-sequencestore-propagatedsetleveltags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1 | 0`  
*Maximum*: `128 | 50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3AccessPolicy`  <a name="cfn-omics-sequencestore-s3accesspolicy"></a>
Property description not available.  
*Required*: No  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SseConfig`  <a name="cfn-omics-sequencestore-sseconfig"></a>
Server-side encryption (SSE) settings for the store.  
*Required*: No  
*Type*: [SseConfig](aws-properties-omics-sequencestore-sseconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-omics-sequencestore-tags"></a>
Tags for the store.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-omics-sequencestore-return-values"></a>

### Ref
<a name="aws-resource-omics-sequencestore-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the details of this resource. For example:

`{ "Ref": "SequenceStore.CreationTime" }``Ref` returns the timestamp for when the sequence store was created. 

### Fn::GetAtt
<a name="aws-resource-omics-sequencestore-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-omics-sequencestore-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The store's ARN.

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
When the store was created.

`S3AccessPointArn`  <a name="S3AccessPointArn-fn::getatt"></a>
This is ARN of the access point associated with the S3 bucket storing read sets.

`S3Uri`  <a name="S3Uri-fn::getatt"></a>
The S3 URI of the sequence store.

`SequenceStoreId`  <a name="SequenceStoreId-fn::getatt"></a>
The store's ID.

`Status`  <a name="Status-fn::getatt"></a>
Status of the sequence store.

`StatusMessage`  <a name="StatusMessage-fn::getatt"></a>
The status message of the sequence store.

`UpdateTime`  <a name="UpdateTime-fn::getatt"></a>
The last-updated time of the Sequence Store.

# AWS::Omics::SequenceStore SseConfig
<a name="aws-properties-omics-sequencestore-sseconfig"></a>

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

## Syntax
<a name="aws-properties-omics-sequencestore-sseconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-sequencestore-sseconfig-syntax.json"></a>

```
{
  "[KeyArn](#cfn-omics-sequencestore-sseconfig-keyarn)" : String,
  "[Type](#cfn-omics-sequencestore-sseconfig-type)" : String
}
```

### YAML
<a name="aws-properties-omics-sequencestore-sseconfig-syntax.yaml"></a>

```
  [KeyArn](#cfn-omics-sequencestore-sseconfig-keyarn): String
  [Type](#cfn-omics-sequencestore-sseconfig-type): String
```

## Properties
<a name="aws-properties-omics-sequencestore-sseconfig-properties"></a>

`KeyArn`  <a name="cfn-omics-sequencestore-sseconfig-keyarn"></a>
An encryption key ARN.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-omics-sequencestore-sseconfig-type"></a>
The encryption type.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `KMS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::VariantStore
<a name="aws-resource-omics-variantstore"></a>

Create a store for variant data.

## Syntax
<a name="aws-resource-omics-variantstore-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-omics-variantstore-syntax.json"></a>

```
{
  "Type" : "AWS::Omics::VariantStore",
  "Properties" : {
      "[Description](#cfn-omics-variantstore-description)" : String,
      "[Name](#cfn-omics-variantstore-name)" : String,
      "[Reference](#cfn-omics-variantstore-reference)" : ReferenceItem,
      "[SseConfig](#cfn-omics-variantstore-sseconfig)" : SseConfig,
      "[Tags](#cfn-omics-variantstore-tags)" : {Key: Value, ...}
    }
}
```

### YAML
<a name="aws-resource-omics-variantstore-syntax.yaml"></a>

```
Type: AWS::Omics::VariantStore
Properties:
  [Description](#cfn-omics-variantstore-description): String
  [Name](#cfn-omics-variantstore-name): String
  [Reference](#cfn-omics-variantstore-reference): 
    ReferenceItem
  [SseConfig](#cfn-omics-variantstore-sseconfig): 
    SseConfig
  [Tags](#cfn-omics-variantstore-tags): 
    Key: Value
```

## Properties
<a name="aws-resource-omics-variantstore-properties"></a>

`Description`  <a name="cfn-omics-variantstore-description"></a>
A description for the store.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `500`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-omics-variantstore-name"></a>
A name for the store.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([a-z]){1}([a-z0-9_]){2,254}`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Reference`  <a name="cfn-omics-variantstore-reference"></a>
The genome reference for the store's variants.  
*Required*: Yes  
*Type*: [ReferenceItem](aws-properties-omics-variantstore-referenceitem.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SseConfig`  <a name="cfn-omics-variantstore-sseconfig"></a>
Server-side encryption (SSE) settings for the store.  
*Required*: No  
*Type*: [SseConfig](aws-properties-omics-variantstore-sseconfig.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-omics-variantstore-tags"></a>
Tags for the store.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-omics-variantstore-return-values"></a>

### Ref
<a name="aws-resource-omics-variantstore-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the details of this resource. For example:

 `{ "Ref": "VariantStore.Status" }` 

For the Amazon Omics resource`VariantStore.Status`, `Ref` returns the status of the variant store.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-omics-variantstore-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-omics-variantstore-return-values-fn--getatt-fn--getatt"></a>

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
When the store was created.

`Id`  <a name="Id-fn::getatt"></a>
The store's ID.

`Status`  <a name="Status-fn::getatt"></a>
 The store's status. 

`StatusMessage`  <a name="StatusMessage-fn::getatt"></a>
The store's status message.

`StoreArn`  <a name="StoreArn-fn::getatt"></a>
The store's ARN.

`StoreSizeBytes`  <a name="StoreSizeBytes-fn::getatt"></a>
The store's size in bytes.

`UpdateTime`  <a name="UpdateTime-fn::getatt"></a>
When the store was updated.

# AWS::Omics::VariantStore ReferenceItem
<a name="aws-properties-omics-variantstore-referenceitem"></a>

The read set's genome reference ARN.

## Syntax
<a name="aws-properties-omics-variantstore-referenceitem-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-variantstore-referenceitem-syntax.json"></a>

```
{
  "[ReferenceArn](#cfn-omics-variantstore-referenceitem-referencearn)" : String
}
```

### YAML
<a name="aws-properties-omics-variantstore-referenceitem-syntax.yaml"></a>

```
  [ReferenceArn](#cfn-omics-variantstore-referenceitem-referencearn): String
```

## Properties
<a name="aws-properties-omics-variantstore-referenceitem-properties"></a>

`ReferenceArn`  <a name="cfn-omics-variantstore-referenceitem-referencearn"></a>
 The reference's ARN.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:.+$`  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::VariantStore SseConfig
<a name="aws-properties-omics-variantstore-sseconfig"></a>

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

## Syntax
<a name="aws-properties-omics-variantstore-sseconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-variantstore-sseconfig-syntax.json"></a>

```
{
  "[KeyArn](#cfn-omics-variantstore-sseconfig-keyarn)" : String,
  "[Type](#cfn-omics-variantstore-sseconfig-type)" : String
}
```

### YAML
<a name="aws-properties-omics-variantstore-sseconfig-syntax.yaml"></a>

```
  [KeyArn](#cfn-omics-variantstore-sseconfig-keyarn): String
  [Type](#cfn-omics-variantstore-sseconfig-type): String
```

## Properties
<a name="aws-properties-omics-variantstore-sseconfig-properties"></a>

`KeyArn`  <a name="cfn-omics-variantstore-sseconfig-keyarn"></a>
An encryption key ARN.  
*Required*: No  
*Type*: String  
*Pattern*: `arn:([^: ]*):([^: ]*):([^: ]*):([0-9]{12}):([^: ]*)`  
*Minimum*: `20`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-omics-variantstore-sseconfig-type"></a>
The encryption type.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `KMS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::Workflow
<a name="aws-resource-omics-workflow"></a>

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://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*.

## Syntax
<a name="aws-resource-omics-workflow-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-omics-workflow-syntax.json"></a>

```
{
  "Type" : "AWS::Omics::Workflow",
  "Properties" : {
      "[Accelerators](#cfn-omics-workflow-accelerators)" : String,
      "[ContainerRegistryMap](#cfn-omics-workflow-containerregistrymap)" : ContainerRegistryMap,
      "[ContainerRegistryMapUri](#cfn-omics-workflow-containerregistrymapuri)" : String,
      "[DefinitionRepository](#cfn-omics-workflow-definitionrepository)" : DefinitionRepository,
      "[DefinitionUri](#cfn-omics-workflow-definitionuri)" : String,
      "[Description](#cfn-omics-workflow-description)" : String,
      "[Engine](#cfn-omics-workflow-engine)" : String,
      "[Main](#cfn-omics-workflow-main)" : String,
      "[Name](#cfn-omics-workflow-name)" : String,
      "[ParameterTemplate](#cfn-omics-workflow-parametertemplate)" : {Key: Value, ...},
      "[ParameterTemplatePath](#cfn-omics-workflow-parametertemplatepath)" : String,
      "[readmeMarkdown](#cfn-omics-workflow-readmemarkdown)" : String,
      "[readmePath](#cfn-omics-workflow-readmepath)" : String,
      "[readmeUri](#cfn-omics-workflow-readmeuri)" : String,
      "[StorageCapacity](#cfn-omics-workflow-storagecapacity)" : Number,
      "[StorageType](#cfn-omics-workflow-storagetype)" : String,
      "[Tags](#cfn-omics-workflow-tags)" : {Key: Value, ...},
      "[WorkflowBucketOwnerId](#cfn-omics-workflow-workflowbucketownerid)" : String
    }
}
```

### YAML
<a name="aws-resource-omics-workflow-syntax.yaml"></a>

```
Type: AWS::Omics::Workflow
Properties:
  [Accelerators](#cfn-omics-workflow-accelerators): String
  [ContainerRegistryMap](#cfn-omics-workflow-containerregistrymap): 
    ContainerRegistryMap
  [ContainerRegistryMapUri](#cfn-omics-workflow-containerregistrymapuri): String
  [DefinitionRepository](#cfn-omics-workflow-definitionrepository): 
    DefinitionRepository
  [DefinitionUri](#cfn-omics-workflow-definitionuri): String
  [Description](#cfn-omics-workflow-description): String
  [Engine](#cfn-omics-workflow-engine): String
  [Main](#cfn-omics-workflow-main): String
  [Name](#cfn-omics-workflow-name): String
  [ParameterTemplate](#cfn-omics-workflow-parametertemplate): 
    Key: Value
  [ParameterTemplatePath](#cfn-omics-workflow-parametertemplatepath): String
  [readmeMarkdown](#cfn-omics-workflow-readmemarkdown): String
  [readmePath](#cfn-omics-workflow-readmepath): String
  [readmeUri](#cfn-omics-workflow-readmeuri): String
  [StorageCapacity](#cfn-omics-workflow-storagecapacity): Number
  [StorageType](#cfn-omics-workflow-storagetype): String
  [Tags](#cfn-omics-workflow-tags): 
    Key: Value
  [WorkflowBucketOwnerId](#cfn-omics-workflow-workflowbucketownerid): String
```

## Properties
<a name="aws-resource-omics-workflow-properties"></a>

`Accelerators`  <a name="cfn-omics-workflow-accelerators"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `GPU`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ContainerRegistryMap`  <a name="cfn-omics-workflow-containerregistrymap"></a>
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*.  
*Required*: No  
*Type*: [ContainerRegistryMap](aws-properties-omics-workflow-containerregistrymap.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ContainerRegistryMapUri`  <a name="cfn-omics-workflow-containerregistrymapuri"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `750`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DefinitionRepository`  <a name="cfn-omics-workflow-definitionrepository"></a>
Contains information about a source code repository that hosts the workflow definition files.  
*Required*: No  
*Type*: [DefinitionRepository](aws-properties-omics-workflow-definitionrepository.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DefinitionUri`  <a name="cfn-omics-workflow-definitionuri"></a>
The URI of a definition for the workflow.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Description`  <a name="cfn-omics-workflow-description"></a>
The parameter's description.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Engine`  <a name="cfn-omics-workflow-engine"></a>
An engine for the workflow.  
*Required*: No  
*Type*: String  
*Allowed values*: `WDL | NEXTFLOW | CWL`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Main`  <a name="cfn-omics-workflow-main"></a>
The path of the main definition file for the workflow.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-omics-workflow-name"></a>
The workflow's name.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ParameterTemplate`  <a name="cfn-omics-workflow-parametertemplate"></a>
The workflow's parameter template.  
*Required*: No  
*Type*: Object of [WorkflowParameter](aws-properties-omics-workflow-workflowparameter.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ParameterTemplatePath`  <a name="cfn-omics-workflow-parametertemplatepath"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\S]+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`readmeMarkdown`  <a name="cfn-omics-workflow-readmemarkdown"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`readmePath`  <a name="cfn-omics-workflow-readmepath"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`readmeUri`  <a name="cfn-omics-workflow-readmeuri"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StorageCapacity`  <a name="cfn-omics-workflow-storagecapacity"></a>
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.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `100000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StorageType`  <a name="cfn-omics-workflow-storagetype"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `STATIC | DYNAMIC`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-omics-workflow-tags"></a>
Tags for the workflow.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`WorkflowBucketOwnerId`  <a name="cfn-omics-workflow-workflowbucketownerid"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9]{12}$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-omics-workflow-return-values"></a>

### Ref
<a name="aws-resource-omics-workflow-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the details of this resource. For example:

`{ "Ref": "Workflow.Type" }``Ref` returns the type of workflow. 

### Fn::GetAtt
<a name="aws-resource-omics-workflow-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-omics-workflow-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN for the workflow.

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
When the workflow was created.

`Id`  <a name="Id-fn::getatt"></a>
The workflow's ID.

`Status`  <a name="Status-fn::getatt"></a>
The workflow's status.

`Type`  <a name="Type-fn::getatt"></a>
The workflow's type.

`Uuid`  <a name="Uuid-fn::getatt"></a>
Property description not available.

# AWS::Omics::Workflow ContainerRegistryMap
<a name="aws-properties-omics-workflow-containerregistrymap"></a>

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*.

## Syntax
<a name="aws-properties-omics-workflow-containerregistrymap-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflow-containerregistrymap-syntax.json"></a>

```
{
  "[ImageMappings](#cfn-omics-workflow-containerregistrymap-imagemappings)" : [ ImageMapping, ... ],
  "[RegistryMappings](#cfn-omics-workflow-containerregistrymap-registrymappings)" : [ RegistryMapping, ... ]
}
```

### YAML
<a name="aws-properties-omics-workflow-containerregistrymap-syntax.yaml"></a>

```
  [ImageMappings](#cfn-omics-workflow-containerregistrymap-imagemappings): 
    - ImageMapping
  [RegistryMappings](#cfn-omics-workflow-containerregistrymap-registrymappings): 
    - RegistryMapping
```

## Properties
<a name="aws-properties-omics-workflow-containerregistrymap-properties"></a>

`ImageMappings`  <a name="cfn-omics-workflow-containerregistrymap-imagemappings"></a>
Image mappings specify path mappings between the ECR private repository and their corresponding external repositories.  
*Required*: No  
*Type*: Array of [ImageMapping](aws-properties-omics-workflow-imagemapping.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RegistryMappings`  <a name="cfn-omics-workflow-containerregistrymap-registrymappings"></a>
Mapping that provides the ECR repository path where upstream container images are pulled and synchronized.  
*Required*: No  
*Type*: Array of [RegistryMapping](aws-properties-omics-workflow-registrymapping.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::Workflow DefinitionRepository
<a name="aws-properties-omics-workflow-definitionrepository"></a>

Contains information about a source code repository that hosts the workflow definition files.

## Syntax
<a name="aws-properties-omics-workflow-definitionrepository-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflow-definitionrepository-syntax.json"></a>

```
{
  "[connectionArn](#cfn-omics-workflow-definitionrepository-connectionarn)" : String,
  "[excludeFilePatterns](#cfn-omics-workflow-definitionrepository-excludefilepatterns)" : [ String, ... ],
  "[fullRepositoryId](#cfn-omics-workflow-definitionrepository-fullrepositoryid)" : String,
  "[sourceReference](#cfn-omics-workflow-definitionrepository-sourcereference)" : SourceReference
}
```

### YAML
<a name="aws-properties-omics-workflow-definitionrepository-syntax.yaml"></a>

```
  [connectionArn](#cfn-omics-workflow-definitionrepository-connectionarn): String
  [excludeFilePatterns](#cfn-omics-workflow-definitionrepository-excludefilepatterns): 
    - String
  [fullRepositoryId](#cfn-omics-workflow-definitionrepository-fullrepositoryid): String
  [sourceReference](#cfn-omics-workflow-definitionrepository-sourcereference): 
    SourceReference
```

## Properties
<a name="aws-properties-omics-workflow-definitionrepository-properties"></a>

`connectionArn`  <a name="cfn-omics-workflow-definitionrepository-connectionarn"></a>
The Amazon Resource Name (ARN) of the connection to the source code repository.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`excludeFilePatterns`  <a name="cfn-omics-workflow-definitionrepository-excludefilepatterns"></a>
A list of file patterns to exclude when retrieving the workflow definition from the repository.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`fullRepositoryId`  <a name="cfn-omics-workflow-definitionrepository-fullrepositoryid"></a>
The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.  
*Required*: No  
*Type*: String  
*Pattern*: `.+/.+`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`sourceReference`  <a name="cfn-omics-workflow-definitionrepository-sourcereference"></a>
The source reference for the repository, such as a branch name, tag, or commit ID.  
*Required*: No  
*Type*: [SourceReference](aws-properties-omics-workflow-sourcereference.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::Workflow ImageMapping
<a name="aws-properties-omics-workflow-imagemapping"></a>

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. 

## Syntax
<a name="aws-properties-omics-workflow-imagemapping-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflow-imagemapping-syntax.json"></a>

```
{
  "[DestinationImage](#cfn-omics-workflow-imagemapping-destinationimage)" : String,
  "[SourceImage](#cfn-omics-workflow-imagemapping-sourceimage)" : String
}
```

### YAML
<a name="aws-properties-omics-workflow-imagemapping-syntax.yaml"></a>

```
  [DestinationImage](#cfn-omics-workflow-imagemapping-destinationimage): String
  [SourceImage](#cfn-omics-workflow-imagemapping-sourceimage): String
```

## Properties
<a name="aws-properties-omics-workflow-imagemapping-properties"></a>

`DestinationImage`  <a name="cfn-omics-workflow-imagemapping-destinationimage"></a>
Specifies the URI of the corresponding image in the private ECR registry.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `750`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceImage`  <a name="cfn-omics-workflow-imagemapping-sourceimage"></a>
Specifies the URI of the source image in the upstream registry.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `750`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::Workflow RegistryMapping
<a name="aws-properties-omics-workflow-registrymapping"></a>

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.

## Syntax
<a name="aws-properties-omics-workflow-registrymapping-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflow-registrymapping-syntax.json"></a>

```
{
  "[EcrAccountId](#cfn-omics-workflow-registrymapping-ecraccountid)" : String,
  "[EcrRepositoryPrefix](#cfn-omics-workflow-registrymapping-ecrrepositoryprefix)" : String,
  "[UpstreamRegistryUrl](#cfn-omics-workflow-registrymapping-upstreamregistryurl)" : String,
  "[UpstreamRepositoryPrefix](#cfn-omics-workflow-registrymapping-upstreamrepositoryprefix)" : String
}
```

### YAML
<a name="aws-properties-omics-workflow-registrymapping-syntax.yaml"></a>

```
  [EcrAccountId](#cfn-omics-workflow-registrymapping-ecraccountid): String
  [EcrRepositoryPrefix](#cfn-omics-workflow-registrymapping-ecrrepositoryprefix): String
  [UpstreamRegistryUrl](#cfn-omics-workflow-registrymapping-upstreamregistryurl): String
  [UpstreamRepositoryPrefix](#cfn-omics-workflow-registrymapping-upstreamrepositoryprefix): String
```

## Properties
<a name="aws-properties-omics-workflow-registrymapping-properties"></a>

`EcrAccountId`  <a name="cfn-omics-workflow-registrymapping-ecraccountid"></a>
Account ID of the account that owns the upstream container image.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9]+$`  
*Minimum*: `12`  
*Maximum*: `12`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EcrRepositoryPrefix`  <a name="cfn-omics-workflow-registrymapping-ecrrepositoryprefix"></a>
The repository prefix to use in the ECR private repository.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UpstreamRegistryUrl`  <a name="cfn-omics-workflow-registrymapping-upstreamregistryurl"></a>
The URI of the upstream registry.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `750`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UpstreamRepositoryPrefix`  <a name="cfn-omics-workflow-registrymapping-upstreamrepositoryprefix"></a>
The repository prefix of the corresponding repository in the upstream registry.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `2`  
*Maximum*: `30`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::Workflow SourceReference
<a name="aws-properties-omics-workflow-sourcereference"></a>

Contains information about the source reference in a code repository, such as a branch, tag, or commit.

## Syntax
<a name="aws-properties-omics-workflow-sourcereference-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflow-sourcereference-syntax.json"></a>

```
{
  "[type](#cfn-omics-workflow-sourcereference-type)" : String,
  "[value](#cfn-omics-workflow-sourcereference-value)" : String
}
```

### YAML
<a name="aws-properties-omics-workflow-sourcereference-syntax.yaml"></a>

```
  [type](#cfn-omics-workflow-sourcereference-type): String
  [value](#cfn-omics-workflow-sourcereference-value): String
```

## Properties
<a name="aws-properties-omics-workflow-sourcereference-properties"></a>

`type`  <a name="cfn-omics-workflow-sourcereference-type"></a>
The type of source reference, such as branch, tag, or commit.  
*Required*: No  
*Type*: String  
*Allowed values*: `BRANCH | TAG | COMMIT`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`value`  <a name="cfn-omics-workflow-sourcereference-value"></a>
The value of the source reference, such as the branch name, tag name, or commit ID.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::Workflow WorkflowParameter
<a name="aws-properties-omics-workflow-workflowparameter"></a>

A workflow parameter.

## Syntax
<a name="aws-properties-omics-workflow-workflowparameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflow-workflowparameter-syntax.json"></a>

```
{
  "[Description](#cfn-omics-workflow-workflowparameter-description)" : String,
  "[Optional](#cfn-omics-workflow-workflowparameter-optional)" : Boolean
}
```

### YAML
<a name="aws-properties-omics-workflow-workflowparameter-syntax.yaml"></a>

```
  [Description](#cfn-omics-workflow-workflowparameter-description): String
  [Optional](#cfn-omics-workflow-workflowparameter-optional): Boolean
```

## Properties
<a name="aws-properties-omics-workflow-workflowparameter-properties"></a>

`Description`  <a name="cfn-omics-workflow-workflowparameter-description"></a>
The parameter's description.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Optional`  <a name="cfn-omics-workflow-workflowparameter-optional"></a>
Whether the parameter is optional.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::WorkflowVersion
<a name="aws-resource-omics-workflowversion"></a>

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.

**Note**  
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*.

## Syntax
<a name="aws-resource-omics-workflowversion-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-omics-workflowversion-syntax.json"></a>

```
{
  "Type" : "AWS::Omics::WorkflowVersion",
  "Properties" : {
      "[Accelerators](#cfn-omics-workflowversion-accelerators)" : String,
      "[ContainerRegistryMap](#cfn-omics-workflowversion-containerregistrymap)" : ContainerRegistryMap,
      "[ContainerRegistryMapUri](#cfn-omics-workflowversion-containerregistrymapuri)" : String,
      "[DefinitionRepository](#cfn-omics-workflowversion-definitionrepository)" : DefinitionRepository,
      "[DefinitionUri](#cfn-omics-workflowversion-definitionuri)" : String,
      "[Description](#cfn-omics-workflowversion-description)" : String,
      "[Engine](#cfn-omics-workflowversion-engine)" : String,
      "[Main](#cfn-omics-workflowversion-main)" : String,
      "[ParameterTemplate](#cfn-omics-workflowversion-parametertemplate)" : {Key: Value, ...},
      "[ParameterTemplatePath](#cfn-omics-workflowversion-parametertemplatepath)" : String,
      "[readmeMarkdown](#cfn-omics-workflowversion-readmemarkdown)" : String,
      "[readmePath](#cfn-omics-workflowversion-readmepath)" : String,
      "[readmeUri](#cfn-omics-workflowversion-readmeuri)" : String,
      "[StorageCapacity](#cfn-omics-workflowversion-storagecapacity)" : Number,
      "[StorageType](#cfn-omics-workflowversion-storagetype)" : String,
      "[Tags](#cfn-omics-workflowversion-tags)" : {Key: Value, ...},
      "[VersionName](#cfn-omics-workflowversion-versionname)" : String,
      "[WorkflowBucketOwnerId](#cfn-omics-workflowversion-workflowbucketownerid)" : String,
      "[WorkflowId](#cfn-omics-workflowversion-workflowid)" : String
    }
}
```

### YAML
<a name="aws-resource-omics-workflowversion-syntax.yaml"></a>

```
Type: AWS::Omics::WorkflowVersion
Properties:
  [Accelerators](#cfn-omics-workflowversion-accelerators): String
  [ContainerRegistryMap](#cfn-omics-workflowversion-containerregistrymap): 
    ContainerRegistryMap
  [ContainerRegistryMapUri](#cfn-omics-workflowversion-containerregistrymapuri): String
  [DefinitionRepository](#cfn-omics-workflowversion-definitionrepository): 
    DefinitionRepository
  [DefinitionUri](#cfn-omics-workflowversion-definitionuri): String
  [Description](#cfn-omics-workflowversion-description): String
  [Engine](#cfn-omics-workflowversion-engine): String
  [Main](#cfn-omics-workflowversion-main): String
  [ParameterTemplate](#cfn-omics-workflowversion-parametertemplate): 
    Key: Value
  [ParameterTemplatePath](#cfn-omics-workflowversion-parametertemplatepath): String
  [readmeMarkdown](#cfn-omics-workflowversion-readmemarkdown): String
  [readmePath](#cfn-omics-workflowversion-readmepath): String
  [readmeUri](#cfn-omics-workflowversion-readmeuri): String
  [StorageCapacity](#cfn-omics-workflowversion-storagecapacity): Number
  [StorageType](#cfn-omics-workflowversion-storagetype): String
  [Tags](#cfn-omics-workflowversion-tags): 
    Key: Value
  [VersionName](#cfn-omics-workflowversion-versionname): String
  [WorkflowBucketOwnerId](#cfn-omics-workflowversion-workflowbucketownerid): String
  [WorkflowId](#cfn-omics-workflowversion-workflowid): String
```

## Properties
<a name="aws-resource-omics-workflowversion-properties"></a>

`Accelerators`  <a name="cfn-omics-workflowversion-accelerators"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `GPU`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ContainerRegistryMap`  <a name="cfn-omics-workflowversion-containerregistrymap"></a>
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*.  
*Required*: No  
*Type*: [ContainerRegistryMap](aws-properties-omics-workflowversion-containerregistrymap.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ContainerRegistryMapUri`  <a name="cfn-omics-workflowversion-containerregistrymapuri"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `750`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DefinitionRepository`  <a name="cfn-omics-workflowversion-definitionrepository"></a>
Contains information about a source code repository that hosts the workflow definition files.  
*Required*: No  
*Type*: [DefinitionRepository](aws-properties-omics-workflowversion-definitionrepository.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DefinitionUri`  <a name="cfn-omics-workflowversion-definitionuri"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Description`  <a name="cfn-omics-workflowversion-description"></a>
The description of the workflow version.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Engine`  <a name="cfn-omics-workflowversion-engine"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `WDL | NEXTFLOW | CWL`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Main`  <a name="cfn-omics-workflowversion-main"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ParameterTemplate`  <a name="cfn-omics-workflowversion-parametertemplate"></a>
Property description not available.  
*Required*: No  
*Type*: Object of [WorkflowParameter](aws-properties-omics-workflowversion-workflowparameter.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ParameterTemplatePath`  <a name="cfn-omics-workflowversion-parametertemplatepath"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\S]+$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`readmeMarkdown`  <a name="cfn-omics-workflowversion-readmemarkdown"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`readmePath`  <a name="cfn-omics-workflowversion-readmepath"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`readmeUri`  <a name="cfn-omics-workflowversion-readmeuri"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^s3://([a-z0-9][a-z0-9-.]{1,61}[a-z0-9])/((.{1,1024}))$`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StorageCapacity`  <a name="cfn-omics-workflowversion-storagecapacity"></a>
Property description not available.  
*Required*: No  
*Type*: Number  
*Minimum*: `0`  
*Maximum*: `100000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StorageType`  <a name="cfn-omics-workflowversion-storagetype"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Allowed values*: `STATIC | DYNAMIC`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-omics-workflowversion-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Object of String  
*Pattern*: `.+`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VersionName`  <a name="cfn-omics-workflowversion-versionname"></a>
The name of the workflow version.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[A-Za-z0-9][A-Za-z0-9\-\._]*$`  
*Minimum*: `1`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`WorkflowBucketOwnerId`  <a name="cfn-omics-workflowversion-workflowbucketownerid"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9]{12}$`  
*Minimum*: `1`  
*Maximum*: `12`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`WorkflowId`  <a name="cfn-omics-workflowversion-workflowid"></a>
The workflow's ID.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[0-9]+$`  
*Minimum*: `1`  
*Maximum*: `18`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-omics-workflowversion-return-values"></a>

### Ref
<a name="aws-resource-omics-workflowversion-return-values-ref"></a>

### Fn::GetAtt
<a name="aws-resource-omics-workflowversion-return-values-fn--getatt"></a>

#### 
<a name="aws-resource-omics-workflowversion-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
ARN of the workflow version.

`CreationTime`  <a name="CreationTime-fn::getatt"></a>
The creation time of the workflow version.

`Status`  <a name="Status-fn::getatt"></a>
The status of the workflow version.

`Type`  <a name="Type-fn::getatt"></a>
The type of the workflow version.

`Uuid`  <a name="Uuid-fn::getatt"></a>
Property description not available.

# AWS::Omics::WorkflowVersion ContainerRegistryMap
<a name="aws-properties-omics-workflowversion-containerregistrymap"></a>

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*.

## Syntax
<a name="aws-properties-omics-workflowversion-containerregistrymap-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflowversion-containerregistrymap-syntax.json"></a>

```
{
  "[ImageMappings](#cfn-omics-workflowversion-containerregistrymap-imagemappings)" : [ ImageMapping, ... ],
  "[RegistryMappings](#cfn-omics-workflowversion-containerregistrymap-registrymappings)" : [ RegistryMapping, ... ]
}
```

### YAML
<a name="aws-properties-omics-workflowversion-containerregistrymap-syntax.yaml"></a>

```
  [ImageMappings](#cfn-omics-workflowversion-containerregistrymap-imagemappings): 
    - ImageMapping
  [RegistryMappings](#cfn-omics-workflowversion-containerregistrymap-registrymappings): 
    - RegistryMapping
```

## Properties
<a name="aws-properties-omics-workflowversion-containerregistrymap-properties"></a>

`ImageMappings`  <a name="cfn-omics-workflowversion-containerregistrymap-imagemappings"></a>
Image mappings specify path mappings between the ECR private repository and their corresponding external repositories.  
*Required*: No  
*Type*: Array of [ImageMapping](aws-properties-omics-workflowversion-imagemapping.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RegistryMappings`  <a name="cfn-omics-workflowversion-containerregistrymap-registrymappings"></a>
Mapping that provides the ECR repository path where upstream container images are pulled and synchronized.  
*Required*: No  
*Type*: Array of [RegistryMapping](aws-properties-omics-workflowversion-registrymapping.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::WorkflowVersion DefinitionRepository
<a name="aws-properties-omics-workflowversion-definitionrepository"></a>

Contains information about a source code repository that hosts the workflow definition files.

## Syntax
<a name="aws-properties-omics-workflowversion-definitionrepository-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflowversion-definitionrepository-syntax.json"></a>

```
{
  "[connectionArn](#cfn-omics-workflowversion-definitionrepository-connectionarn)" : String,
  "[excludeFilePatterns](#cfn-omics-workflowversion-definitionrepository-excludefilepatterns)" : [ String, ... ],
  "[fullRepositoryId](#cfn-omics-workflowversion-definitionrepository-fullrepositoryid)" : String,
  "[sourceReference](#cfn-omics-workflowversion-definitionrepository-sourcereference)" : SourceReference
}
```

### YAML
<a name="aws-properties-omics-workflowversion-definitionrepository-syntax.yaml"></a>

```
  [connectionArn](#cfn-omics-workflowversion-definitionrepository-connectionarn): String
  [excludeFilePatterns](#cfn-omics-workflowversion-definitionrepository-excludefilepatterns): 
    - String
  [fullRepositoryId](#cfn-omics-workflowversion-definitionrepository-fullrepositoryid): String
  [sourceReference](#cfn-omics-workflowversion-definitionrepository-sourcereference): 
    SourceReference
```

## Properties
<a name="aws-properties-omics-workflowversion-definitionrepository-properties"></a>

`connectionArn`  <a name="cfn-omics-workflowversion-definitionrepository-connectionarn"></a>
The Amazon Resource Name (ARN) of the connection to the source code repository.  
*Required*: No  
*Type*: String  
*Pattern*: `^arn:aws(-[\\w]+)*:.+:.+:[0-9]{12}:.+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`excludeFilePatterns`  <a name="cfn-omics-workflowversion-definitionrepository-excludefilepatterns"></a>
A list of file patterns to exclude when retrieving the workflow definition from the repository.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `50`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`fullRepositoryId`  <a name="cfn-omics-workflowversion-definitionrepository-fullrepositoryid"></a>
The full repository identifier, including the repository owner and name. For example, 'repository-owner/repository-name'.  
*Required*: No  
*Type*: String  
*Pattern*: `.+/.+`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`sourceReference`  <a name="cfn-omics-workflowversion-definitionrepository-sourcereference"></a>
The source reference for the repository, such as a branch name, tag, or commit ID.  
*Required*: No  
*Type*: [SourceReference](aws-properties-omics-workflowversion-sourcereference.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::WorkflowVersion ImageMapping
<a name="aws-properties-omics-workflowversion-imagemapping"></a>

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. 

## Syntax
<a name="aws-properties-omics-workflowversion-imagemapping-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflowversion-imagemapping-syntax.json"></a>

```
{
  "[DestinationImage](#cfn-omics-workflowversion-imagemapping-destinationimage)" : String,
  "[SourceImage](#cfn-omics-workflowversion-imagemapping-sourceimage)" : String
}
```

### YAML
<a name="aws-properties-omics-workflowversion-imagemapping-syntax.yaml"></a>

```
  [DestinationImage](#cfn-omics-workflowversion-imagemapping-destinationimage): String
  [SourceImage](#cfn-omics-workflowversion-imagemapping-sourceimage): String
```

## Properties
<a name="aws-properties-omics-workflowversion-imagemapping-properties"></a>

`DestinationImage`  <a name="cfn-omics-workflowversion-imagemapping-destinationimage"></a>
Specifies the URI of the corresponding image in the private ECR registry.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `750`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceImage`  <a name="cfn-omics-workflowversion-imagemapping-sourceimage"></a>
Specifies the URI of the source image in the upstream registry.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `750`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::WorkflowVersion RegistryMapping
<a name="aws-properties-omics-workflowversion-registrymapping"></a>

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.

## Syntax
<a name="aws-properties-omics-workflowversion-registrymapping-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflowversion-registrymapping-syntax.json"></a>

```
{
  "[EcrAccountId](#cfn-omics-workflowversion-registrymapping-ecraccountid)" : String,
  "[EcrRepositoryPrefix](#cfn-omics-workflowversion-registrymapping-ecrrepositoryprefix)" : String,
  "[UpstreamRegistryUrl](#cfn-omics-workflowversion-registrymapping-upstreamregistryurl)" : String,
  "[UpstreamRepositoryPrefix](#cfn-omics-workflowversion-registrymapping-upstreamrepositoryprefix)" : String
}
```

### YAML
<a name="aws-properties-omics-workflowversion-registrymapping-syntax.yaml"></a>

```
  [EcrAccountId](#cfn-omics-workflowversion-registrymapping-ecraccountid): String
  [EcrRepositoryPrefix](#cfn-omics-workflowversion-registrymapping-ecrrepositoryprefix): String
  [UpstreamRegistryUrl](#cfn-omics-workflowversion-registrymapping-upstreamregistryurl): String
  [UpstreamRepositoryPrefix](#cfn-omics-workflowversion-registrymapping-upstreamrepositoryprefix): String
```

## Properties
<a name="aws-properties-omics-workflowversion-registrymapping-properties"></a>

`EcrAccountId`  <a name="cfn-omics-workflowversion-registrymapping-ecraccountid"></a>
Account ID of the account that owns the upstream container image.  
*Required*: No  
*Type*: String  
*Pattern*: `^[0-9]+$`  
*Minimum*: `12`  
*Maximum*: `12`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EcrRepositoryPrefix`  <a name="cfn-omics-workflowversion-registrymapping-ecrrepositoryprefix"></a>
The repository prefix to use in the ECR private repository.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UpstreamRegistryUrl`  <a name="cfn-omics-workflowversion-registrymapping-upstreamregistryurl"></a>
The URI of the upstream registry.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `1`  
*Maximum*: `750`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UpstreamRepositoryPrefix`  <a name="cfn-omics-workflowversion-registrymapping-upstreamrepositoryprefix"></a>
The repository prefix of the corresponding repository in the upstream registry.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `2`  
*Maximum*: `30`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::WorkflowVersion SourceReference
<a name="aws-properties-omics-workflowversion-sourcereference"></a>

Contains information about the source reference in a code repository, such as a branch, tag, or commit.

## Syntax
<a name="aws-properties-omics-workflowversion-sourcereference-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflowversion-sourcereference-syntax.json"></a>

```
{
  "[type](#cfn-omics-workflowversion-sourcereference-type)" : String,
  "[value](#cfn-omics-workflowversion-sourcereference-value)" : String
}
```

### YAML
<a name="aws-properties-omics-workflowversion-sourcereference-syntax.yaml"></a>

```
  [type](#cfn-omics-workflowversion-sourcereference-type): String
  [value](#cfn-omics-workflowversion-sourcereference-value): String
```

## Properties
<a name="aws-properties-omics-workflowversion-sourcereference-properties"></a>

`type`  <a name="cfn-omics-workflowversion-sourcereference-type"></a>
The type of source reference, such as branch, tag, or commit.  
*Required*: No  
*Type*: String  
*Allowed values*: `BRANCH | TAG | COMMIT`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`value`  <a name="cfn-omics-workflowversion-sourcereference-value"></a>
The value of the source reference, such as the branch name, tag name, or commit ID.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Omics::WorkflowVersion WorkflowParameter
<a name="aws-properties-omics-workflowversion-workflowparameter"></a>

A workflow parameter.

## Syntax
<a name="aws-properties-omics-workflowversion-workflowparameter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-omics-workflowversion-workflowparameter-syntax.json"></a>

```
{
  "[Description](#cfn-omics-workflowversion-workflowparameter-description)" : String,
  "[Optional](#cfn-omics-workflowversion-workflowparameter-optional)" : Boolean
}
```

### YAML
<a name="aws-properties-omics-workflowversion-workflowparameter-syntax.yaml"></a>

```
  [Description](#cfn-omics-workflowversion-workflowparameter-description): String
  [Optional](#cfn-omics-workflowversion-workflowparameter-optional): Boolean
```

## Properties
<a name="aws-properties-omics-workflowversion-workflowparameter-properties"></a>

`Description`  <a name="cfn-omics-workflowversion-workflowparameter-description"></a>
The parameter's description.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\p{L}||\p{M}||\p{Z}||\p{S}||\p{N}||\p{P}]+$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Optional`  <a name="cfn-omics-workflowversion-workflowparameter-optional"></a>
Whether the parameter is optional.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)