modify-global-cluster¶
Description¶
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
Note
This action only applies to Amazon DocumentDB clusters.
See also: AWS API Documentation
Synopsis¶
modify-global-cluster
--global-cluster-identifier <value>
[--new-global-cluster-identifier <value>]
[--deletion-protection | --no-deletion-protection]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--global-cluster-identifier (string)
The identifier for the global cluster being modified. This parameter isn’t case-sensitive.
Constraints:
Must match the identifier of an existing global cluster.
--new-global-cluster-identifier (string)
The new identifier for a global cluster when you modify a global cluster. This value is stored as a lowercase string.
Must contain from 1 to 63 letters, numbers, or hyphens The first character must be a letter Can’t end with a hyphen or contain two consecutive hyphens
Example:
my-cluster2
--deletion-protection | --no-deletion-protection (boolean)
Indicates if the global cluster has deletion protection enabled. The global cluster can’t be deleted when deletion protection is enabled.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
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
yaml
yaml-stream
--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.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Output¶
GlobalCluster -> (structure)
A data type representing an Amazon DocumentDB global cluster.
GlobalClusterIdentifier -> (string)
Contains a user-supplied global cluster identifier. This identifier is the unique key that identifies a global cluster.
GlobalClusterResourceId -> (string)
The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the cluster is accessed.
GlobalClusterArn -> (string)
The Amazon Resource Name (ARN) for the global cluster.
Status -> (string)
Specifies the current state of this global cluster.
Engine -> (string)
The Amazon DocumentDB database engine used by the global cluster.
EngineVersion -> (string)
Indicates the database engine version.
DatabaseName -> (string)
The default database name within the new global cluster.
StorageEncrypted -> (boolean)
The storage encryption setting for the global cluster.
DeletionProtection -> (boolean)
The deletion protection setting for the new global cluster.
GlobalClusterMembers -> (list)
The list of cluster IDs for secondary clusters within the global cluster. Currently limited to one item.
(structure)
A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.
DBClusterArn -> (string)
The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
Readers -> (list)
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global cluster.
(string)
IsWriter -> (boolean)
Specifies whether the Amazon DocumentDB cluster is the primary cluster (that is, has read-write capability) for the Amazon DocumentDB global cluster with which it is associated.