AWS::Timestream::InfluxDBCluster - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::Timestream::InfluxDBCluster

The AWS::Timestream::InfluxDBCluster resource specifies an Amazon Timestream for InfluxDB cluster. A cluster supports InfluxDB v2 with multi-node read replicas for high availability and read scaling, with a primary node and one or more read replicas distributed across availability zones. A cluster also supports InfluxDB v3 deployments in either Core (single-node for near real-time workloads) or Enterprise (multi-node with compaction for high-cardinality data and long-term analytics) configurations. You can configure instance types, storage, networking, failover behavior, and deployment type for your cluster.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Timestream::InfluxDBCluster",
  "Properties" : {
      "AllocatedStorage" : Integer,
      "Bucket" : String,
      "DbInstanceType" : String,
      "DbParameterGroupIdentifier" : String,
      "DbStorageType" : String,
      "DeploymentType" : String,
      "FailoverMode" : String,
      "LogDeliveryConfiguration" : LogDeliveryConfiguration,
      "Name" : String,
      "NetworkType" : String,
      "Organization" : String,
      "Password" : String,
      "Port" : Integer,
      "PubliclyAccessible" : Boolean,
      "Tags" : [ Tag, ... ],
      "Username" : String,
      "VpcSecurityGroupIds" : [ String, ... ],
      "VpcSubnetIds" : [ String, ... ]
    }
}

YAML

Type: AWS::Timestream::InfluxDBCluster
Properties:
  AllocatedStorage: Integer
  Bucket: String
  DbInstanceType: String
  DbParameterGroupIdentifier: String
  DbStorageType: String
  DeploymentType: String
  FailoverMode: String
  LogDeliveryConfiguration: 
    LogDeliveryConfiguration
  Name: String
  NetworkType: String
  Organization: String
  Password: String
  Port: Integer
  PubliclyAccessible: Boolean
  Tags: 
    - Tag
  Username: String
  VpcSecurityGroupIds: 
    - String
  VpcSubnetIds: 
    - String

Properties

AllocatedStorage

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

Required: No

Type: Integer

Minimum: 20

Maximum: 15360

Update requires: Replacement

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.

Required: No

Type: String

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

Minimum: 2

Maximum: 64

Update requires: Replacement

DbInstanceType

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

Required: No

Type: String

Allowed 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

Update requires: No interruption

DbParameterGroupIdentifier

The name or 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.

Required: No

Type: String

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

Minimum: 3

Maximum: 64

Update requires: No interruption

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

Required: No

Type: String

Allowed values: InfluxIOIncludedT1 | InfluxIOIncludedT2 | InfluxIOIncludedT3

Update requires: Replacement

DeploymentType

Specifies the type of cluster to create.

Required: No

Type: String

Allowed values: MULTI_NODE_READ_REPLICAS

Update requires: Replacement

FailoverMode

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

Required: No

Type: String

Allowed values: AUTOMATIC | NO_FAILOVER

Update requires: No interruption

LogDeliveryConfiguration

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

Required: No

Type: LogDeliveryConfiguration

Update requires: No interruption

Name

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. Cluster names must be unique per customer and per region.

Required: No

Type: String

Pattern: ^[a-zA-z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$

Minimum: 3

Maximum: 40

Update requires: Replacement

NetworkType

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.

Required: No

Type: String

Allowed values: IPV4 | DUAL

Update requires: Replacement

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.

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

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

Required: No

Type: String

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

Minimum: 8

Maximum: 64

Update requires: Replacement

Port

The port number on which InfluxDB accepts connections.

Required: No

Type: Integer

Minimum: 1024

Maximum: 65535

Update requires: No interruption

PubliclyAccessible

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

Required: No

Type: Boolean

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update requires: No interruption

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. 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.

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

VpcSecurityGroupIds

A list of VPC security group IDs to associate with the DB cluster.

Required: No

Type: Array of String

Minimum: 1

Maximum: 5

Update requires: Replacement

VpcSubnetIds

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.

Required: No

Type: Array of String

Minimum: 1

Maximum: 3

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the DB cluster.

Endpoint

The endpoint used to connect to the InfluxDB cluster. The default InfluxDB port is 8086.

EngineType

The database engine type of the DB cluster.

Id

A service-generated unique identifier for the InfluxDB cluster.

InfluxAuthParametersSecretArn

The Amazon Resource Name (ARN) of the Amazon 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.

ReaderEndpoint

The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

Status

The status of the DB cluster.