GetDbInstance
Returns a Timestream for InfluxDB DB instance.
Request Syntax
{
"identifier": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- identifier
-
The id of the DB instance.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]+$Required: Yes
Response Syntax
{
"allocatedStorage": number,
"arn": "string",
"availabilityZone": "string",
"dbInstanceType": "string",
"dbParameterGroupIdentifier": "string",
"dbStorageType": "string",
"deploymentType": "string",
"endpoint": "string",
"id": "string",
"influxAuthParametersSecretArn": "string",
"logDeliveryConfiguration": {
"s3Configuration": {
"bucketName": "string",
"enabled": boolean
}
},
"name": "string",
"publiclyAccessible": boolean,
"secondaryAvailabilityZone": "string",
"status": "string",
"vpcSecurityGroupIds": [ "string" ],
"vpcSubnetIds": [ "string" ]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- allocatedStorage
-
The amount of storage allocated for your DB storage type (in gibibytes).
Type: Integer
Valid Range: Minimum value of 20. Maximum value of 16384.
- 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}$ - availabilityZone
-
The Availability Zone in which the DB instance resides.
Type: String
- dbInstanceType
-
The Timestream for InfluxDB 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 - dbParameterGroupIdentifier
-
The id of the DB parameter group assigned to your DB instance.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]+$ - dbStorageType
-
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
Type: String
Valid Values:
InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3 - deploymentType
-
Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
Type: String
Valid Values:
SINGLE_AZ | WITH_MULTIAZ_STANDBY - endpoint
-
The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
Type: String
- id
-
A service-generated unique identifier.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 64.
Pattern:
^[a-zA-Z0-9]+$ - influxAuthParametersSecretArn
-
The Amazon Resource Name (ARN) of the AWS 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.
Type: String
- logDeliveryConfiguration
-
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
Type: LogDeliveryConfiguration object
- name
-
The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and 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]+)*$ - publiclyAccessible
-
Indicates if the DB instance has a public IP to facilitate access.
Type: Boolean
- secondaryAvailabilityZone
-
The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
Type: String
- status
-
The status of the DB instance.
Type: String
Valid Values:
CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED - vpcSecurityGroupIds
-
A list of VPC security group IDs associated with the DB instance.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 5 items.
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
^sg-[a-z0-9]+$ - vpcSubnetIds
-
A list of VPC subnet IDs associated with the DB instance.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 3 items.
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
^subnet-[a-z0-9]+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource was not found or does not exist.
HTTP Status Code: 400
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
- ValidationException
-
The input fails to satisfy the constraints specified by Timestream for InfluxDB.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
