AWS::EMRContainers::VirtualCluster - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::EMRContainers::VirtualCluster

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

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

JSON

{
  "Type" : "AWS::EMRContainers::VirtualCluster",
  "Properties" : {
      "ContainerProvider" : ContainerProvider,
      "Name" : String,
      "SecurityConfigurationId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::EMRContainers::VirtualCluster
Properties:
  ContainerProvider: 
    ContainerProvider
  Name: String
  SecurityConfigurationId: String
  Tags: 
    - Tag

Properties

ContainerProvider

The container provider of the virtual cluster.

Required: Yes

Type: ContainerProvider

Update requires: Replacement

Name

The name of the virtual cluster.

Required: Yes

Type: String

Pattern: [\.\-_/#A-Za-z0-9]+

Minimum: 1

Maximum: 64

Update requires: Replacement

SecurityConfigurationId

The ID of the security configuration.

Required: No

Type: String

Pattern: [0-9a-z]+

Minimum: 1

Maximum: 64

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

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

Fn::GetAtt

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 Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the project, such as arn:aws:emr-containers:us-east-1:123456789012:/virtualclusters/ab4rp1abcs8xz47n3x0example.

Id

The ID of the virtual cluster, such as ab4rp1abcs8xz47n3x0example.

Examples

Specifies a virtual cluster

JSON

{
   "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

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