AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . emr-containers ]

update-virtual-cluster

Description

Updates a virtual cluster. Virtual cluster is a managed entity on Amazon EMR on EKS. You can create, update, 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

Synopsis

  update-virtual-cluster
--id <value>
[--scheduler-configuration <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--id (string)

The ID of the virtual cluster to update.

--scheduler-configuration (structure)

The scheduler configuration to apply to the virtual cluster. The new configuration fully replaces the existing one. If you omit a field, the corresponding limit is removed.

maxInQueueJobRuns -> (integer)

The maximum number of job runs that can be in the PENDING or SUBMITTED state at any time for the virtual cluster. When the queue is full, the service rejects StartJobRun requests with a ValidationException . If you omit this field, the service applies no queue-depth limit.

maxConcurrentJobRuns -> (integer)

The maximum number of job runs that can be in the RUNNING state at any time for the virtual cluster. As running slots free up, queued job runs start automatically. If you omit this field, the service applies no concurrency limit.

Shorthand Syntax:

maxInQueueJobRuns=integer,maxConcurrentJobRuns=integer

JSON Syntax:

{
  "maxInQueueJobRuns": integer,
  "maxConcurrentJobRuns": integer
}

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

virtualCluster -> (structure)

The updated 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. Amazon EKS is the only supported type as of now.

id -> (string)

The ID of the container cluster.

info -> (tagged union structure)

The information about the container cluster.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: eksInfo.

eksInfo -> (structure)

The information about the Amazon EKS cluster.

namespace -> (string)

The namespaces of the Amazon EKS cluster.

nodeLabel -> (string)

The nodeLabel of the nodes where the resources of this virtual cluster can get scheduled. It requires relevant scaling and policy engine addons.

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)

securityConfigurationId -> (string)

The ID of the security configuration.

sessionEnabled -> (boolean)

Specifies whether the virtual cluster has session support enabled.

schedulerConfiguration -> (structure)

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.

maxInQueueJobRuns -> (integer)

The maximum number of job runs that can be in the PENDING or SUBMITTED state at any time for the virtual cluster. When the queue is full, the service rejects StartJobRun requests with a ValidationException . If you omit this field, the service applies no queue-depth limit.

maxConcurrentJobRuns -> (integer)

The maximum number of job runs that can be in the RUNNING state at any time for the virtual cluster. As running slots free up, queued job runs start automatically. If you omit this field, the service applies no concurrency limit.

schedulerStatus -> (structure)

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

currentInQueueJobRuns -> (integer)

The number of job runs currently waiting in the queue (PENDING or SUBMITTED ) for the virtual cluster.

currentConcurrentJobRuns -> (integer)

The number of job runs currently in the RUNNING state for the virtual cluster.