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 . docdb-elastic ]

update-cluster

Description

Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window

See also: AWS API Documentation

Synopsis

  update-cluster
[--admin-user-password <value>]
[--auth-type <value>]
[--client-token <value>]
--cluster-arn <value>
[--preferred-maintenance-window <value>]
[--shard-capacity <value>]
[--shard-count <value>]
[--subnet-ids <value>]
[--vpc-security-group-ids <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>]

Options

--admin-user-password (string)

The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints : Must contain from 8 to 100 characters.

--auth-type (string)

The authentication type for the Elastic DocumentDB cluster.

Possible values:

• PLAIN_TEXT
• SECRET_ARN

--client-token (string)

The client token for the Elastic DocumentDB cluster.

--cluster-arn (string)

The arn of the Elastic DocumentDB cluster.

--preferred-maintenance-window (string)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

Default : a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints : Minimum 30-minute window.

--shard-capacity (integer)

The capacity of each shard in the Elastic DocumentDB cluster.

--shard-count (integer)

The number of shards to create in the Elastic DocumentDB cluster.

--subnet-ids (list)

The number of shards to create in the Elastic DocumentDB cluster.

(string)

Syntax:

"string" "string" ...

--vpc-security-group-ids (list)

A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.

(string)

Syntax:

"string" "string" ...

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

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

Output

cluster -> (structure)

Returns information about the updated Elastic DocumentDB cluster.

adminUserName -> (string)

The name of the Elastic DocumentDB cluster administrator.

authType -> (string)

The authentication type for the Elastic DocumentDB cluster.

clusterArn -> (string)

The arn of the Elastic DocumentDB cluster.

clusterEndpoint -> (string)

The URL used to connect to the Elastic DocumentDB cluster.

clusterName -> (string)

The name of the Elastic DocumentDB cluster.

createTime -> (string)

The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

kmsKeyId -> (string)

The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

preferredMaintenanceWindow -> (string)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format : ddd:hh24:mi-ddd:hh24:mi

shardCapacity -> (integer)

The capacity of each shard in the Elastic DocumentDB cluster.

shardCount -> (integer)

The number of shards in the Elastic DocumentDB cluster.

status -> (string)

The status of the Elastic DocumentDB cluster.

subnetIds -> (list)

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

(string)

vpcSecurityGroupIds -> (list)

A list of EC2 VPC security groups associated with this cluster.

(string)