CreateDbInstance - Timestream for InfluxDB
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

CreateDbInstance

Creates a new Timestream for InfluxDB DB instance.

Important

When you enter passwords in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. For information about how to mitigate this risk, see Mitigate the risks of using the AWS CLI to store secrets.

Request Syntax

{
   "allocatedStorage": number,
   "bucket": "string",
   "dbInstanceType": "string",
   "dbParameterGroupIdentifier": "string",
   "dbStorageType": "string",
   "deploymentType": "string",
   "logDeliveryConfiguration": { 
      "s3Configuration": { 
         "bucketName": "string",
         "enabled": boolean
      }
   },
   "name": "string",
   "organization": "string",
   "password": "string",
   "publiclyAccessible": boolean,
   "tags": { 
      "string" : "string" 
   },
   "username": "string",
   "vpcSecurityGroupIds": [ "string" ],
   "vpcSubnetIds": [ "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.

allocatedStorage

The amount of storage to allocate for your DB storage type in GiB (gibibytes).

Type: Integer

Valid Range: Minimum value of 20. Maximum value of 16384.

Required: Yes

bucket

The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: ^[^_][^"]*$

Required: No

dbInstanceType

The Timestream for InfluxDB DB 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.16xlarge

Required: Yes

dbParameterGroupIdentifier

The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: ^[a-zA-Z0-9]+$

Required: No

dbStorageType

The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:

  • Influx IO Included 3000 IOPS

  • Influx IO Included 12000 IOPS

  • Influx IO Included 16000 IOPS

Type: String

Valid Values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3

Required: No

deploymentType

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

Type: String

Valid Values: SINGLE_AZ | WITH_MULTIAZ_STANDBY

Required: No

logDeliveryConfiguration

Configuration for sending InfluxDB engine logs to a specified S3 bucket.

Type: LogDeliveryConfiguration object

Required: No

name

The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.

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

organization

The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

password

The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 64.

Pattern: ^[a-zA-Z0-9]+$

Required: Yes

publiclyAccessible

Configures the DB instance with a public IP to facilitate access.

Type: Boolean

Required: No

tags

A list of key-value pairs to associate with the DB instance.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

username

The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

vpcSecurityGroupIds

A list of VPC security group IDs to associate 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]+$

Required: Yes

vpcSubnetIds

A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

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]+$

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

ConflictException

The request conflicts with an existing resource in Timestream for InfluxDB.

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

ServiceQuotaExceededException

The request exceeds the service quota.

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: