View a markdown version of this page

VirtualCluster - Amazon EMR on EKS

VirtualCluster

This entity describes a virtual cluster. A virtual cluster is a Kubernetes namespace that Amazon EMR is registered with. Amazon EMR uses virtual clusters to run jobs and host endpoints. Multiple virtual clusters can be backed by the same physical cluster. However, each virtual cluster maps to one namespace on an Amazon EKS cluster. Virtual clusters do not create any active resources that contribute to your bill or that require lifecycle management outside the service.

Contents

arn

The ARN of the 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]+$

Required: No

containerProvider

The container provider of the virtual cluster.

Type: ContainerProvider object

Required: No

createdAt

The date and time when the virtual cluster is created.

Type: Timestamp

Required: No

id

The ID of the virtual cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [0-9a-z]+

Required: No

name

The name of the virtual cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Required: No

schedulerConfiguration

The scheduler configuration (concurrency and queue limits) applied to the virtual cluster. The service does not return this field when no scheduler limits are configured.

Type: SchedulerConfiguration object

Required: No

schedulerStatus

The current in-queue and concurrent job-run counts for the virtual cluster.

Type: SchedulerStatus object

Required: No

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

sessionEnabled

Specifies whether the virtual cluster has session support enabled.

Type: Boolean

Required: No

state

The state of the virtual cluster.

Type: String

Valid Values: RUNNING | TERMINATING | TERMINATED | ARRESTED

Required: No

tags

The assigned tags of 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: