Skip to content

Describe Virtual Cluster

emrcontainers_describe_virtual_cluster R Documentation

Displays detailed information about a specified virtual cluster

Description

Displays detailed information about a 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_describe_virtual_cluster(id)

Arguments

id

[required] The ID of the virtual cluster that will be described.

Value

A list with the following syntax:

list(
  virtualCluster = 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"
  )
)

Request syntax

svc$describe_virtual_cluster(
  id = "string"
)