DbInstanceSummary
Contains a summary of a DB instance.
Contents
- arn
-
The Amazon Resource Name (ARN) of the DB instance.
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\-parameter\-group)/[a-zA-Z0-9]{3,64}$Required: Yes
- id
-
The service-generated unique identifier of the DB instance.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]+$Required: Yes
- name
-
This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and AWS CLI commands.
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
-
The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
Type: Integer
Valid Range: Minimum value of 20. Maximum value of 16384.
Required: No
- dbInstanceType
-
The Timestream for InfluxDB instance type to run InfluxDB 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.16xlargeRequired: No
- dbStorageType
-
The storage type for your DB instance.
Type: String
Valid Values:
InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3Required: No
- deploymentType
-
Single-Instance or with a MultiAZ Standby for High availability.
Type: String
Valid Values:
SINGLE_AZ | WITH_MULTIAZ_STANDBYRequired: No
- endpoint
-
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
Type: String
Required: No
- status
-
The status of the DB instance.
Type: String
Valid Values:
CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILEDRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
