Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . emr-containers ]

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-virtual-cluster
--id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--id (string)

The ID of the virtual cluster that will be described.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

virtualCluster -> (structure)

This output displays information about the specified virtual cluster.

id -> (string)

The ID of the virtual cluster.

name -> (string)

The name of the virtual cluster.

arn -> (string)

The ARN of the virtual cluster.

state -> (string)

The state of the virtual cluster.

containerProvider -> (structure)

The container provider of the virtual cluster.

type -> (string)

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

id -> (string)

The ID of the container cluster.

info -> (structure)

The information about the container cluster.

eksInfo -> (structure)

The information about the EKS cluster.

namespace -> (string)

The namespaces of the EKS cluster.

createdAt -> (timestamp)

The date and time when the virtual cluster is created.

tags -> (map)

The assigned tags of the virtual cluster.

key -> (string)

value -> (string)