CreateDbClusterCommand

Suggest an Edit

Creates a new Timestream for InfluxDB cluster.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TimestreamInfluxDBClient, CreateDbClusterCommand } from "@aws-sdk/client-timestream-influxdb"; // ES Modules import
// const { TimestreamInfluxDBClient, CreateDbClusterCommand } = require("@aws-sdk/client-timestream-influxdb"); // CommonJS import
const client = new TimestreamInfluxDBClient(config);
const input = { // CreateDbClusterInput
  name: "STRING_VALUE", // required
  username: "STRING_VALUE",
  password: "STRING_VALUE", // required
  organization: "STRING_VALUE",
  bucket: "STRING_VALUE",
  port: Number("int"),
  dbParameterGroupIdentifier: "STRING_VALUE",
  dbInstanceType: "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
  dbStorageType: "InfluxIOIncludedT1" || "InfluxIOIncludedT2" || "InfluxIOIncludedT3",
  allocatedStorage: Number("int"), // required
  networkType: "IPV4" || "DUAL",
  publiclyAccessible: true || false,
  vpcSubnetIds: [ // VpcSubnetIdList // required
    "STRING_VALUE",
  ],
  vpcSecurityGroupIds: [ // VpcSecurityGroupIdList // required
    "STRING_VALUE",
  ],
  deploymentType: "MULTI_NODE_READ_REPLICAS", // required
  failoverMode: "AUTOMATIC" || "NO_FAILOVER",
  logDeliveryConfiguration: { // LogDeliveryConfiguration
    s3Configuration: { // S3Configuration
      bucketName: "STRING_VALUE", // required
      enabled: true || false, // required
    },
  },
  tags: { // RequestTagMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateDbClusterCommand(input);
const response = await client.send(command);
// { // CreateDbClusterOutput
//   dbClusterId: "STRING_VALUE",
//   dbClusterStatus: "CREATING" || "UPDATING" || "DELETING" || "AVAILABLE" || "FAILED" || "DELETED",
// };

CreateDbClusterCommand Input

See CreateDbClusterCommandInput for more details

Parameter
Type
Description
allocatedStorage
Required
number | undefined

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

dbInstanceType
Required
DbInstanceType | undefined

The Timestream for InfluxDB DB instance type to run InfluxDB on.

deploymentType
Required
ClusterDeploymentType | undefined

Specifies the type of cluster to create.

name
Required
string | undefined

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

password
Required
string | undefined

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 Secrets Manager in your account.

vpcSecurityGroupIds
Required
string[] | undefined

A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.

vpcSubnetIds
Required
string[] | undefined

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

bucket
string | undefined

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.

dbParameterGroupIdentifier
string | undefined

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

dbStorageType
DbStorageType | undefined

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

You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:

  • Influx I/O Included 3000 IOPS

  • Influx I/O Included 12000 IOPS

  • Influx I/O Included 16000 IOPS

failoverMode
FailoverMode | undefined

Specifies the behavior of failure recovery when the primary node of the cluster fails.

logDeliveryConfiguration
LogDeliveryConfiguration | undefined

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

networkType
NetworkType | undefined

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.

organization
string | undefined

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

port
number | undefined

The port number on which InfluxDB accepts connections.

Valid Values: 1024-65535

Default: 8086

Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680

publiclyAccessible
boolean | undefined

Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.

tags
Record<string, string> | undefined

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

username
string | undefined

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 Secrets Manager in your account.

CreateDbClusterCommand Output

See CreateDbClusterCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
dbClusterId
string | undefined

A service-generated unique identifier.

dbClusterStatus
ClusterStatus | undefined

The status of the DB cluster.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

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

InternalServerException
server

The request processing has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The requested resource was not found or does not exist.

ServiceQuotaExceededException
client

The request exceeds the service quota.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy the constraints specified by Timestream for InfluxDB.

TimestreamInfluxDBServiceException
Base exception class for all service exceptions from TimestreamInfluxDB service.