AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Timestream::InfluxDBInstance

CfnInfluxDBInstance

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.

Import

import { CfnInfluxDBInstance } from 'aws-cdk-lib/aws-timestream';

Or use the module namespace:

import * as timestream from 'aws-cdk-lib/aws-timestream';
// timestream.CfnInfluxDBInstance

Properties

Configuration passed to the constructor as CfnInfluxDBInstanceProps.

allocatedStorageOptional
number

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

bucketOptional
string

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.

dbInstanceTypeOptional
string

The Timestream for InfluxDB DB instance type to run on.

dbParameterGroupIdentifierOptional
string

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.

dbStorageTypeOptional
string

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

deploymentTypeOptional
string

Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

logDeliveryConfigurationOptional
IResolvable | LogDeliveryConfigurationProperty

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

nameOptional
string

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.

networkTypeOptional
string

Network type of the InfluxDB Instance.

organizationOptional
string

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

passwordOptional
string

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.

portOptional
number

The port number on which InfluxDB accepts connections.

publiclyAccessibleOptional
boolean | IResolvable

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

Default: - false

tagsOptional
CfnTag[]

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

usernameOptional
string

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.

vpcSecurityGroupIdsOptional
string[]

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

vpcSubnetIdsOptional
string[]

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Timestream::InfluxDBInstanceView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-timestream
CFN TypeAWS::Timestream::InfluxDBInstance
Properties17

Related Constructs

Explore This Service

External Links