<a id="cli-aws-timestream-influxdb-get-db-cluster"></a>

# get-db-cluster

## Description

Retrieves information about a Timestream for InfluxDB cluster.

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/timestream-influxdb-2023-01-27/GetDbCluster)

## Synopsis

```
  get-db-cluster
--db-cluster-id <value>
[--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]
[--cli-error-format <value>]
[--help]
```

## Options

`--db-cluster-id` (string) [required]

> Service-generated unique identifier of the DB cluster to retrieve.

> Constraints:

> * min: `3`
> * max: `64`
> * pattern: `[a-zA-Z0-9]+`

`--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. 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
* yaml
* yaml-stream
* off

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

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Output

id -> (string)

> Service-generated unique identifier of the DB cluster to retrieve.

> Constraints:

> * min: `3`
> * max: `64`
> * pattern: `[a-zA-Z0-9]+`

name -> (string)

> Customer-supplied name of the Timestream for InfluxDB cluster.

> Constraints:

> * min: `3`
> * max: `40`
> * pattern: `[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*`

arn -> (string)

> The Amazon Resource Name (ARN) of the DB cluster.

> Constraints:

> * min: `1`
> * max: `1011`
> * pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group|db\-backup)/[a-zA-Z0-9]{3,64}`

status -> (string)

> The status of the DB cluster.

> Possible values:

> * `CREATING`
> * `UPDATING`
> * `DELETING`
> * `AVAILABLE`
> * `FAILED`
> * `DELETED`
> * `MAINTENANCE`
> * `UPDATING_INSTANCE_TYPE`
> * `REBOOTING`
> * `REBOOT_FAILED`
> * `PARTIALLY_AVAILABLE`
> * `RESTORING`
> * `RESTORE_FAILED`

endpoint -> (string)

> The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.

readerEndpoint -> (string)

> The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

port -> (integer)

> The port number on which InfluxDB accepts connections.

> Constraints:

> * min: `1024`
> * max: `65535`

deploymentType -> (string)

> Deployment type of the DB cluster.

> Possible values:

> * `MULTI_NODE_READ_REPLICAS`

dbInstanceType -> (string)

> The Timestream for InfluxDB instance type that InfluxDB runs on.

> Possible values:

> * `db.influx.medium`
> * `db.influx.large`
> * `db.influx.xlarge`
> * `db.influx.2xlarge`
> * `db.influx.4xlarge`
> * `db.influx.8xlarge`
> * `db.influx.12xlarge`
> * `db.influx.16xlarge`
> * `db.influx.24xlarge`

networkType -> (string)

> Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

> Possible values:

> * `IPV4`
> * `DUAL`

dbStorageType -> (string)

> The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

> Possible values:

> * `InfluxIOIncludedT1`
> * `InfluxIOIncludedT2`
> * `InfluxIOIncludedT3`

allocatedStorage -> (integer)

> The amount of storage allocated for your DB storage type (in gibibytes).

> Constraints:

> * min: `20`
> * max: `15360`

engineType -> (string)

> The engine type of your DB cluster.

> Possible values:

> * `INFLUXDB_V2`
> * `INFLUXDB_V3_CORE`
> * `INFLUXDB_V3_ENTERPRISE`

publiclyAccessible -> (boolean)

> Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.

dbParameterGroupIdentifier -> (string)

> The ID of the DB parameter group assigned to your DB cluster.

> Constraints:

> * min: `3`
> * max: `64`
> * pattern: `[a-zA-Z0-9]+`

effectiveDbParameterGroupIdentifier -> (string)

> The ID of the DB parameter group actually applied to your DB cluster. When the service applies optimized defaults, it creates a service-managed DB parameter group and this field reflects that group, while dbParameterGroupIdentifier reflects the customer-provided DB parameter group. When no service-managed DB parameter group is applied, this value matches dbParameterGroupIdentifier.

> Constraints:

> * min: `3`
> * max: `64`
> * pattern: `[a-zA-Z0-9]+`

logDeliveryConfiguration -> (structure)

> Configuration for sending InfluxDB engine logs to send to specified S3 bucket.

> s3Configuration -> (structure) [required]

> > Configuration for S3 bucket log delivery.

> > bucketName -> (string) [required]

> > > The name of the S3 bucket to deliver logs to.

> > > Constraints:

> > > * min: `3`
> > > * max: `63`
> > > * pattern: `[0-9a-z]+[0-9a-z\.\-]*[0-9a-z]+`

> > enabled -> (boolean) [required]

> > > Indicates whether log delivery to the S3 bucket is enabled.

maintenanceSchedule -> (structure)

> The maintenance schedule for the DB cluster.

> timezone -> (string) [required]

> > The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.

> > Constraints:

> > * min: `1`
> > * max: `64`
> > * pattern: `(UTC|[A-Za-z_]+/[A-Za-z0-9_]+(/[A-Za-z0-9_]+)?)`

> preferredMaintenanceWindow -> (string) [required]

> > The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.

> > Constraints:

> > * min: `0`
> > * max: `19`
> > * pattern: `$|^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):[0-5]\d-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):([01]\d|2[0-3]):[0-5]\d`

lastMaintenanceTime -> (timestamp)

> The timestamp of the last completed maintenance operation on the DB cluster.

nextMaintenanceTime -> (timestamp)

> The timestamp of the next scheduled maintenance operation on the DB cluster.

influxAuthParametersSecretArn -> (string)

> The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

vpcSubnetIds -> (list)

> A list of VPC subnet IDs associated with the DB cluster.

> Constraints:

> * min: `1`
> * max: `6`

> (string)

> > Constraints:

> > * min: `0`
> > * max: `64`
> > * pattern: `subnet-[a-z0-9]+`

vpcSecurityGroupIds -> (list)

> A list of VPC security group IDs associated with the DB cluster.

> Constraints:

> * min: `1`
> * max: `5`

> (string)

> > Constraints:

> > * min: `0`
> > * max: `64`
> > * pattern: `sg-[a-z0-9]+`

failoverMode -> (string)

> The configured failover mode for the DB cluster.

> Possible values:

> * `AUTOMATIC`
> * `NO_FAILOVER`

clusterConfiguration -> (structure)

> Configuration for node modes in the DbCluster.

> Deprecated. Use deploymentConfiguration to view the cluster topology instead.

> ingestQueryInstances -> (integer)

> > The number of instances in the DbCluster which can both ingest and query.

> queryOnlyInstances -> (integer)

> > The number of instances in the DbCluster which can only query.

> dedicatedCompactor -> (boolean)

> > Indicates if the compactor instance is a standalone instance or not.

deploymentConfiguration -> (tagged union structure)

> The current compute topology of the cluster, as a set of node groups. The returned topology reflects the cluster’s actual provisioned nodes.

> #### NOTE
> This is a Tagged Union structure. Only one of the following top level keys can be set: `InfluxDBv3Enterprise`.

> InfluxDBv3Enterprise -> (structure)

> > The deployment configuration for an InfluxDB 3 Enterprise cluster.

> > nodeGroups -> (list) [required]

> > > The node groups that make up the cluster. Across all node groups, the cluster must include 1 to 4 nodes with the INGEST mode, 0 to 14 nodes with the QUERY mode, and exactly one node with the COMPACT mode.

> > > Constraints:

> > > * min: `1`
> > > * max: `10`

> > > (structure)

> > > > A group of one or more nodes in a Timestream for InfluxDB cluster that share the same instance modes and instance type. A cluster’s compute topology is defined as a list of node groups.

> > > > instanceModes -> (list) [required]

> > > > > The functions that the nodes in this group perform. Provide from 1 to 4 unique modes. Valid modes:

> > > > > * INGEST – Nodes in this mode ingest data. Across all node groups, INGEST nodes must total between 1 and 4.
> > > > > * QUERY – Nodes in this mode query data. Across all node groups, QUERY nodes must total between 0 and 14.
> > > > > * COMPACT – Nodes in this mode compact data. Exactly one node across all node groups must have this mode. If the cluster has more than three non-compaction nodes, place the COMPACT node in its own dedicated node group.
> > > > > * PROCESS – Nodes in this mode process data with the processing engine.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `4`

> > > > > (string)

> > > > > > Possible values:

> > > > > > * `PRIMARY`
> > > > > > * `STANDBY`
> > > > > > * `REPLICA`
> > > > > > * `INGEST`
> > > > > > * `QUERY`
> > > > > > * `COMPACT`
> > > > > > * `PROCESS`

> > > > instanceType -> (string) [required]

> > > > > The Timestream for InfluxDB DB instance type to run InfluxDB on for the nodes in this group.

> > > > > Possible values:

> > > > > * `db.influx.medium`
> > > > > * `db.influx.large`
> > > > > * `db.influx.xlarge`
> > > > > * `db.influx.2xlarge`
> > > > > * `db.influx.4xlarge`
> > > > > * `db.influx.8xlarge`
> > > > > * `db.influx.12xlarge`
> > > > > * `db.influx.16xlarge`
> > > > > * `db.influx.24xlarge`

> > > > count -> (integer) [required]

> > > > > The number of nodes in this group. Valid values are 1 to 13.

> > > > > Constraints:

> > > > > * min: `1`
> > > > > * max: `13`

dbBackupConfigurations -> (list)

> The backup configurations for the DB cluster.

> (structure)

> > Contains the configuration and status for an automated backup schedule.

> > type -> (string) [required]

> > > The type of automated backup schedule.

> > > Possible values:

> > > * `HOURLY`
> > > * `DAILY`
> > > * `WEEKLY`
> > > * `MONTHLY`
> > > * `CUSTOM_SCHEDULE`
> > > * `CONTINUOUS`

> > retentionDays -> (integer) [required]

> > > The number of days automated backups are retained.

> > > Constraints:

> > > * min: `1`
> > > * max: `365`

> > enabled -> (boolean) [required]

> > > Indicates whether this backup configuration is enabled.

> > customSchedule -> (string)

> > > The custom cron schedule expression for the backup, if applicable.

> > > Constraints:

> > > * min: `9`
> > > * max: `256`
> > > * pattern: `cron\(\S+ \S+ \S+ \S+ \S+ \S+\)`

> > nextAutomatedBackupTime -> (timestamp)

> > > The next scheduled time for an automated backup to be taken.

kmsKeyId -> (string)

> The Amazon Web Services KMS key ARN used for encryption of the DB cluster.

> Constraints:

> * min: `1`
> * max: `2048`
> * pattern: `[a-zA-Z0-9:/_\-]+`
