aws-cdk-lib.aws_timestream.CfnInfluxDBInstanceProps

CfnInfluxDBInstanceProps Struct

Properties for defining a CfnInfluxDBInstance.

Source

Generated code

Type last changed

v2.258.0 · 4 Jun 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_timestream as timestream } from 'aws-cdk-lib';
const cfnInfluxDBInstanceProps: timestream.CfnInfluxDBInstanceProps = {
  allocatedStorage: 123,
  bucket: 'bucket',
  dbInstanceType: 'dbInstanceType',
  dbParameterGroupIdentifier: 'dbParameterGroupIdentifier',
  dbStorageType: 'dbStorageType',
  deploymentType: 'deploymentType',
  logDeliveryConfiguration: {
    s3Configuration: {
      bucketName: 'bucketName',
      enabled: false,
    },
  },
  maintenanceSchedule: {
    preferredMaintenanceWindow: 'preferredMaintenanceWindow',
    timezone: 'timezone',
  },
  name: 'name',
  networkType: 'networkType',
  organization: 'organization',
  password: 'password',
  port: 123,
  publiclyAccessible: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  username: 'username',
  vpcSecurityGroupIds: ['vpcSecurityGroupIds'],
  vpcSubnetIds: ['vpcSubnetIds'],
};

Properties

allocatedStoragenumberallocated_storageint | floatallocatedStorageNumberAllocatedStoragedoubleAllocatedStorage*float64#

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

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

dbInstanceTypestringdb_instance_typestrdbInstanceTypeStringDbInstanceTypestringDbInstanceType*string#

The Timestream for InfluxDB DB instance type to run on.

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

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

deploymentTypestringdeployment_typestrdeploymentTypeStringDeploymentTypestringDeploymentType*string#

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

logDeliveryConfigurationIResolvable | CfnInfluxDBInstance.LogDeliveryConfigurationPropertylog_delivery_configurationtyping.Union[IResolvable, LogDeliveryConfigurationProperty]logDeliveryConfigurationIResolvableLogDeliveryConfigurationIResolvableLogDeliveryConfigurationinterface{}#

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

maintenanceScheduleIResolvable | CfnInfluxDBInstance.MaintenanceSchedulePropertymaintenance_scheduletyping.Union[IResolvable, MaintenanceScheduleProperty]maintenanceScheduleIResolvableMaintenanceScheduleIResolvableMaintenanceScheduleinterface{}#

The maintenance schedule for the InfluxDB instance.

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

networkTypestringnetwork_typestrnetworkTypeStringNetworkTypestringNetworkType*string#

Network type of the InfluxDB Instance.

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

passwordstringpasswordstrpasswordStringPasswordstringPassword*string#

The password of the initial admin user created in InfluxDB.

notes

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.

portnumberportint | floatportNumberPortdoublePort*float64#

The port number on which InfluxDB accepts connections.

publiclyAccessibleboolean | IResolvablepublicly_accessibletyping.Union[bool, IResolvable]publiclyAccessibleBooleanPubliclyAccessibleboolPubliclyAccessibleinterface{}= false#

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

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

usernamestringusernamestrusernameStringUsernamestringUsername*string#

The username of the initial admin user created in InfluxDB.

notes

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.

vpcSecurityGroupIdsstring[]vpc_security_group_idstyping.List[str]vpcSecurityGroupIdsList<String>VpcSecurityGroupIdsstring[]VpcSecurityGroupIds*[]*string#

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

vpcSubnetIdsstring[]vpc_subnet_idstyping.List[str]vpcSubnetIdsList<String>VpcSubnetIdsstring[]VpcSubnetIds*[]*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.

Used as props by

• CfnInfluxDBInstance