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::EMRContainers::VirtualCluster
<a name="aws-resource-emrcontainers-virtualcluster"></a>

The `AWS::EMRContainers::VirtualCluster` resource specifies a virtual cluster. A virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list, and delete virtual clusters. They do not consume any additional resources in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

## Syntax
<a name="aws-resource-emrcontainers-virtualcluster-syntax"></a>

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

### JSON
<a name="aws-resource-emrcontainers-virtualcluster-syntax.json"></a>

```
{
  "Type" : "AWS::EMRContainers::VirtualCluster",
  "Properties" : {
      "[ContainerProvider](#cfn-emrcontainers-virtualcluster-containerprovider)" : ContainerProvider,
      "[Name](#cfn-emrcontainers-virtualcluster-name)" : String,
      "[SecurityConfigurationId](#cfn-emrcontainers-virtualcluster-securityconfigurationid)" : String,
      "[Tags](#cfn-emrcontainers-virtualcluster-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-emrcontainers-virtualcluster-syntax.yaml"></a>

```
Type: AWS::EMRContainers::VirtualCluster
Properties:
  [ContainerProvider](#cfn-emrcontainers-virtualcluster-containerprovider): 
    ContainerProvider
  [Name](#cfn-emrcontainers-virtualcluster-name): String
  [SecurityConfigurationId](#cfn-emrcontainers-virtualcluster-securityconfigurationid): String
  [Tags](#cfn-emrcontainers-virtualcluster-tags): 
    - Tag
```

## Properties
<a name="aws-resource-emrcontainers-virtualcluster-properties"></a>

`ContainerProvider`  <a name="cfn-emrcontainers-virtualcluster-containerprovider"></a>
The container provider of the virtual cluster.  
*Required*: Yes  
*Type*: [ContainerProvider](aws-properties-emrcontainers-virtualcluster-containerprovider.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-emrcontainers-virtualcluster-name"></a>
The name of the virtual cluster.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[\.\-_/#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)

`SecurityConfigurationId`  <a name="cfn-emrcontainers-virtualcluster-securityconfigurationid"></a>
The ID of the security configuration.  
*Required*: No  
*Type*: String  
*Pattern*: `[0-9a-z]+`  
*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-emrcontainers-virtualcluster-tags"></a>
An array of key-value pairs to apply to this resource.  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-emrcontainers-virtualcluster-tag.md)  
*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-emrcontainers-virtualcluster-return-values"></a>

### Ref
<a name="aws-resource-emrcontainers-virtualcluster-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the virtual cluster.

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

### Fn::GetAtt
<a name="aws-resource-emrcontainers-virtualcluster-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/UserGuide/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-emrcontainers-virtualcluster-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the project, such as `arn:aws:emr-containers:us-east-1:123456789012:/virtualclusters/ab4rp1abcs8xz47n3x0example`.

`Id`  <a name="Id-fn::getatt"></a>
The ID of the virtual cluster, such as `ab4rp1abcs8xz47n3x0example`.

## Examples
<a name="aws-resource-emrcontainers-virtualcluster--examples"></a>



### Specifies a virtual cluster
<a name="aws-resource-emrcontainers-virtualcluster--examples--Specifies_a_virtual_cluster"></a>

#### JSON
<a name="aws-resource-emrcontainers-virtualcluster--examples--Specifies_a_virtual_cluster--json"></a>

```
{
   "Resources": {
      "TestVirtualCluster": {
         "Type": "AWS::EMRContainers::VirtualCluster",
         "Properties": {
            "Name": "VirtualClusterName",
            "ContainerProvider": {
               "Type": "EKS",
               "Id": "EKSClusterName",
               "Info": {
                  "EksInfo": {
                     "Namespace": "EKSNamespace"
                  }
               }
            },
            "Tags": [
               {
                  "Key": "Key1",
                  "Value": "Value1"
               }
            ]
         }
      }
   },
   "Outputs": {
      "PrimaryId": {
         "Value": null
      }
   }
}
```

#### YAML
<a name="aws-resource-emrcontainers-virtualcluster--examples--Specifies_a_virtual_cluster--yaml"></a>

```
Resources:
  TestVirtualCluster:
    Type: 'AWS::EMRContainers::VirtualCluster'
    Properties:
      Name: 'VirtualClusterName'
      ContainerProvider:
        Type: 'EKS'
        Id: 'EKSClusterName'
        Info:
          EksInfo:
            Namespace: 'EKSNamespace'
      Tags:
        - Key: Key1
          Value: Value1
Outputs:
  PrimaryId:
    Value: !Ref TestVirtualCluster
```

# AWS::EMRContainers::VirtualCluster ContainerInfo
<a name="aws-properties-emrcontainers-virtualcluster-containerinfo"></a>

The information about the container used for a job run or a managed endpoint.

## Syntax
<a name="aws-properties-emrcontainers-virtualcluster-containerinfo-syntax"></a>

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

### JSON
<a name="aws-properties-emrcontainers-virtualcluster-containerinfo-syntax.json"></a>

```
{
  "[EksInfo](#cfn-emrcontainers-virtualcluster-containerinfo-eksinfo)" : EksInfo
}
```

### YAML
<a name="aws-properties-emrcontainers-virtualcluster-containerinfo-syntax.yaml"></a>

```
  [EksInfo](#cfn-emrcontainers-virtualcluster-containerinfo-eksinfo): 
    EksInfo
```

## Properties
<a name="aws-properties-emrcontainers-virtualcluster-containerinfo-properties"></a>

`EksInfo`  <a name="cfn-emrcontainers-virtualcluster-containerinfo-eksinfo"></a>
The information about the Amazon EKS cluster.  
*Required*: Yes  
*Type*: [EksInfo](aws-properties-emrcontainers-virtualcluster-eksinfo.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EMRContainers::VirtualCluster ContainerProvider
<a name="aws-properties-emrcontainers-virtualcluster-containerprovider"></a>

The information about the container provider.

## Syntax
<a name="aws-properties-emrcontainers-virtualcluster-containerprovider-syntax"></a>

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

### JSON
<a name="aws-properties-emrcontainers-virtualcluster-containerprovider-syntax.json"></a>

```
{
  "[Id](#cfn-emrcontainers-virtualcluster-containerprovider-id)" : String,
  "[Info](#cfn-emrcontainers-virtualcluster-containerprovider-info)" : ContainerInfo,
  "[Type](#cfn-emrcontainers-virtualcluster-containerprovider-type)" : String
}
```

### YAML
<a name="aws-properties-emrcontainers-virtualcluster-containerprovider-syntax.yaml"></a>

```
  [Id](#cfn-emrcontainers-virtualcluster-containerprovider-id): String
  [Info](#cfn-emrcontainers-virtualcluster-containerprovider-info): 
    ContainerInfo
  [Type](#cfn-emrcontainers-virtualcluster-containerprovider-type): String
```

## Properties
<a name="aws-properties-emrcontainers-virtualcluster-containerprovider-properties"></a>

`Id`  <a name="cfn-emrcontainers-virtualcluster-containerprovider-id"></a>
The ID of the container cluster.  
*Minimum*: 1  
*Maximum*: 100  
*Pattern*: `^[0-9A-Za-z][A-Za-z0-9\-_]*`  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[0-9A-Za-z][A-Za-z0-9\-_]*`  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Info`  <a name="cfn-emrcontainers-virtualcluster-containerprovider-info"></a>
The information about the container cluster.  
*Required*: Yes  
*Type*: [ContainerInfo](aws-properties-emrcontainers-virtualcluster-containerinfo.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Type`  <a name="cfn-emrcontainers-virtualcluster-containerprovider-type"></a>
The type of the container provider. Amazon EKS is the only supported type as of now.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `EKS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EMRContainers::VirtualCluster EksInfo
<a name="aws-properties-emrcontainers-virtualcluster-eksinfo"></a>

The information about the Amazon EKS cluster.

## Syntax
<a name="aws-properties-emrcontainers-virtualcluster-eksinfo-syntax"></a>

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

### JSON
<a name="aws-properties-emrcontainers-virtualcluster-eksinfo-syntax.json"></a>

```
{
  "[Namespace](#cfn-emrcontainers-virtualcluster-eksinfo-namespace)" : String
}
```

### YAML
<a name="aws-properties-emrcontainers-virtualcluster-eksinfo-syntax.yaml"></a>

```
  [Namespace](#cfn-emrcontainers-virtualcluster-eksinfo-namespace): String
```

## Properties
<a name="aws-properties-emrcontainers-virtualcluster-eksinfo-properties"></a>

`Namespace`  <a name="cfn-emrcontainers-virtualcluster-eksinfo-namespace"></a>
The namespaces of the EKS cluster.  
*Minimum*: 1  
*Maximum*: 63  
*Pattern*: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::EMRContainers::VirtualCluster Tag
<a name="aws-properties-emrcontainers-virtualcluster-tag"></a>

A map of key-value pairs.

## Syntax
<a name="aws-properties-emrcontainers-virtualcluster-tag-syntax"></a>

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

### JSON
<a name="aws-properties-emrcontainers-virtualcluster-tag-syntax.json"></a>

```
{
  "[Key](#cfn-emrcontainers-virtualcluster-tag-key)" : String,
  "[Value](#cfn-emrcontainers-virtualcluster-tag-value)" : String
}
```

### YAML
<a name="aws-properties-emrcontainers-virtualcluster-tag-syntax.yaml"></a>

```
  [Key](#cfn-emrcontainers-virtualcluster-tag-key): String
  [Value](#cfn-emrcontainers-virtualcluster-tag-value): String
```

## Properties
<a name="aws-properties-emrcontainers-virtualcluster-tag-properties"></a>

`Key`  <a name="cfn-emrcontainers-virtualcluster-tag-key"></a>
The key to use in the tag.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-emrcontainers-virtualcluster-tag-value"></a>
The value of the tag.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)