AWS::Timestream::InfluxDBInstance - 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).

AWS::Timestream::InfluxDBInstance

A DB instance is an isolated database environment running in the cloud. It is the basic building block of Amazon Timestream for InfluxDB. A DB instance can contain multiple user-created databases (or organizations and buckets for the case of InfluxDb 2.x databases), and can be accessed using the same client tools and applications you might use to access a standalone self-managed InfluxDB instance.

Syntax

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

JSON

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

YAML

Type: AWS::Timestream::InfluxDBInstance
Properties:
  AllocatedStorage: Integer
  Bucket: String
  DbInstanceType: String
  DbParameterGroupIdentifier: String
  DbStorageType: String
  DeploymentType: String
  LogDeliveryConfiguration: 
    LogDeliveryConfiguration
  Name: String
  Organization: String
  Password: String
  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: 16384

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

Update requires: Replacement

DbParameterGroupIdentifier

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

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 whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

Required: No

Type: String

Allowed values: SINGLE_AZ | WITH_MULTIAZ_STANDBY

Update requires: Replacement

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

Required: No

Type: String

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

Minimum: 3

Maximum: 40

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

Required: No

Type: String

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

Minimum: 8

Maximum: 64

Update requires: Replacement

PubliclyAccessible

Configures the DB instance 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 instance.

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

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

VpcSecurityGroupIds

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

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

AvailabilityZone

The Availability Zone in which the DB instance resides.

Endpoint

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

Id

A service-generated unique identifier

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.

SecondaryAvailabilityZone

Describes an Availability Zone in which the InfluxDB instance is located

Status

The status of the DB instance.

Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED