List Virtual Clusters

emrcontainers_list_virtual_clusters

R Documentation

Lists information about the specified virtual cluster

Description

Lists information about the specified 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.

Usage

emrcontainers_list_virtual_clusters(containerProviderId,
  containerProviderType, createdAfter, createdBefore, states, maxResults,
  nextToken, eksAccessEntryIntegrated)

Arguments

containerProviderId

The container provider ID of the virtual cluster.

containerProviderType

The container provider type of the virtual cluster. Amazon EKS is the only supported type as of now.

createdAfter

The date and time after which the virtual clusters are created.

createdBefore

The date and time before which the virtual clusters are created.

states

The states of the requested virtual clusters.

maxResults

The maximum number of virtual clusters that can be listed.

nextToken

The token for the next set of virtual clusters to return.

eksAccessEntryIntegrated

Optional Boolean that specifies whether the operation should return the virtual clusters that have the access entry integration enabled or disabled. If not specified, the operation returns all applicable virtual clusters.

Value

A list with the following syntax:

list(
  virtualClusters = list(
    list(
      id = "string",
      name = "string",
      arn = "string",
      state = "RUNNING"|"TERMINATING"|"TERMINATED"|"ARRESTED",
      containerProvider = list(
        type = "EKS",
        id = "string",
        info = list(
          eksInfo = list(
            namespace = "string"
          )
        )
      ),
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      tags = list(
        "string"
      ),
      securityConfigurationId = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_virtual_clusters(
  containerProviderId = "string",
  containerProviderType = "EKS",
  createdAfter = as.POSIXct(
    "2015-01-01"
  ),
  createdBefore = as.POSIXct(
    "2015-01-01"
  ),
  states = list(
    "RUNNING"|"TERMINATING"|"TERMINATED"|"ARRESTED"
  ),
  maxResults = 123,
  nextToken = "string",
  eksAccessEntryIntegrated = TRUE|FALSE
)