# DbClusterSummary


Describes a summary of a Timestream for InfluxDB cluster.

## Contents


 ** arn **   <a name="tsinfluxdb-Type-DbClusterSummary-arn"></a>
The Amazon Resource Name (ARN) of the DB cluster.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1011.  
Pattern: `arn:aws[a-z\-]*:timestream\-influxdb:[a-z0-9\-]+:[0-9]{12}:(db\-instance|db\-cluster|db\-parameter\-group)/[a-zA-Z0-9]{3,64}`   
Required: Yes

 ** id **   <a name="tsinfluxdb-Type-DbClusterSummary-id"></a>
Service-generated unique identifier of the DB cluster to retrieve.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 64.  
Pattern: `[a-zA-Z0-9]+`   
Required: Yes

 ** name **   <a name="tsinfluxdb-Type-DbClusterSummary-name"></a>
Customer supplied name of the Timestream for InfluxDB cluster.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 40.  
Pattern: `[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*`   
Required: Yes

 ** allocatedStorage **   <a name="tsinfluxdb-Type-DbClusterSummary-allocatedStorage"></a>
The amount of storage allocated for your DB storage type (in gibibytes).  
Type: Integer  
Valid Range: Minimum value of 20. Maximum value of 15360.  
Required: No

 ** dbInstanceType **   <a name="tsinfluxdb-Type-DbClusterSummary-dbInstanceType"></a>
The Timestream for InfluxDB DB instance type that InfluxDB runs on.  
Type: String  
Valid 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`   
Required: No

 ** dbStorageType **   <a name="tsinfluxdb-Type-DbClusterSummary-dbStorageType"></a>
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.  
Type: String  
Valid Values: `InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3`   
Required: No

 ** deploymentType **   <a name="tsinfluxdb-Type-DbClusterSummary-deploymentType"></a>
Deployment type of the DB cluster  
Type: String  
Valid Values: `MULTI_NODE_READ_REPLICAS`   
Required: No

 ** endpoint **   <a name="tsinfluxdb-Type-DbClusterSummary-endpoint"></a>
The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.  
Type: String  
Required: No

 ** engineType **   <a name="tsinfluxdb-Type-DbClusterSummary-engineType"></a>
The engine type of your DB cluster.  
Type: String  
Valid Values: `INFLUXDB_V2 | INFLUXDB_V3_CORE | INFLUXDB_V3_ENTERPRISE`   
Required: No

 ** networkType **   <a name="tsinfluxdb-Type-DbClusterSummary-networkType"></a>
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.  
Type: String  
Valid Values: `IPV4 | DUAL`   
Required: No

 ** port **   <a name="tsinfluxdb-Type-DbClusterSummary-port"></a>
The port number on which InfluxDB accepts connections.  
Type: Integer  
Valid Range: Minimum value of 1024. Maximum value of 65535.  
Required: No

 ** readerEndpoint **   <a name="tsinfluxdb-Type-DbClusterSummary-readerEndpoint"></a>
The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.  
Type: String  
Required: No

 ** status **   <a name="tsinfluxdb-Type-DbClusterSummary-status"></a>
The status of the DB cluster.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | AVAILABLE | FAILED | DELETED | MAINTENANCE | UPDATING_INSTANCE_TYPE | REBOOTING | REBOOT_FAILED | PARTIALLY_AVAILABLE`   
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/timestream-influxdb-2023-01-27/DbClusterSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/timestream-influxdb-2023-01-27/DbClusterSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/timestream-influxdb-2023-01-27/DbClusterSummary)