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

# 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 Amazon 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.amazonaws.cn/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.amazonaws.cn/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.amazonaws.cn/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.amazonaws.cn/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.amazonaws.cn/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.amazonaws.cn/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.amazonaws.cn/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.amazonaws.cn/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.