CreateVirtualCluster
Creates a virtual cluster. 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 resource 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.
Request Syntax
POST /virtualclusters HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"containerProvider": {
"id": "string
",
"info": { ... },
"type": "string
"
},
"name": "string
",
"securityConfigurationId": "string
",
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientToken
-
The client token of the virtual cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
.*\S.*
Required: Yes
- containerProvider
-
The container provider of the virtual cluster.
Type: ContainerProvider object
Required: Yes
- name
-
The specified name of the virtual cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_/#A-Za-z0-9]+
Required: Yes
- securityConfigurationId
-
The ID of the security configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9a-z]+
Required: No
-
The tags assigned to the virtual cluster.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
.*\S.*
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
.*\S.*
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"arn": "string",
"id": "string",
"name": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- arn
-
This output contains the ARN of virtual cluster.
Type: String
Length Constraints: Minimum length of 60. Maximum length of 1024.
Pattern:
^arn:(aws[a-zA-Z0-9-]*):emr-containers:.+:(\d{12}):\/virtualclusters\/[0-9a-zA-Z]+$
- id
-
This output contains the virtual cluster ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[0-9a-z]+
- name
-
This output contains the name of the virtual cluster.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_/#A-Za-z0-9]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- EKSRequestThrottledException
-
The request exceeded the Amazon EKS API operation limits.
HTTP Status Code: 429
- InternalServerException
-
This is an internal server exception.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
- ValidationException
-
There are invalid parameters in the client request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: