/AWS1/CL_TSI=>CREATEDBINSTANCE()¶
About CreateDbInstance¶
Creates a new Timestream for InfluxDB DB instance.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/TSIDBINSTANCENAME /AWS1/TSIDBINSTANCENAME¶
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.
IV_PASSWORD TYPE /AWS1/TSIPASSWORD /AWS1/TSIPASSWORD¶
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 AWS SecretManager in your account.
IV_DBINSTANCETYPE TYPE /AWS1/TSIDBINSTANCETYPE /AWS1/TSIDBINSTANCETYPE¶
The Timestream for InfluxDB DB instance type to run InfluxDB on.
IT_VPCSUBNETIDS TYPE /AWS1/CL_TSIVPCSUBNETIDLIST_W=>TT_VPCSUBNETIDLIST TT_VPCSUBNETIDLIST¶
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.
IT_VPCSECURITYGROUPIDS TYPE /AWS1/CL_TSIVPCSECGRPIDLIST_W=>TT_VPCSECURITYGROUPIDLIST TT_VPCSECURITYGROUPIDLIST¶
A list of VPC security group IDs to associate with the DB instance.
IV_ALLOCATEDSTORAGE TYPE /AWS1/TSIALLOCATEDSTORAGE /AWS1/TSIALLOCATEDSTORAGE¶
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
Optional arguments:¶
IV_USERNAME TYPE /AWS1/TSIUSERNAME /AWS1/TSIUSERNAME¶
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.
IV_ORGANIZATION TYPE /AWS1/TSIORGANIZATION /AWS1/TSIORGANIZATION¶
The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
IV_BUCKET TYPE /AWS1/TSIBUCKET /AWS1/TSIBUCKET¶
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.
IV_PUBLICLYACCESSIBLE TYPE /AWS1/TSIBOOLEAN /AWS1/TSIBOOLEAN¶
Configures the DB instance with a public IP to facilitate access.
IV_DBSTORAGETYPE TYPE /AWS1/TSIDBSTORAGETYPE /AWS1/TSIDBSTORAGETYPE¶
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
IV_DBPARAMETERGROUPID TYPE /AWS1/TSIDBPARAMETERGROUPID /AWS1/TSIDBPARAMETERGROUPID¶
The 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.
IV_DEPLOYMENTTYPE TYPE /AWS1/TSIDEPLOYMENTTYPE /AWS1/TSIDEPLOYMENTTYPE¶
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
IO_LOGDELIVERYCONFIGURATION TYPE REF TO /AWS1/CL_TSILOGDELIVERYCONF /AWS1/CL_TSILOGDELIVERYCONF¶
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
IT_TAGS TYPE /AWS1/CL_TSIREQUESTTAGMAP_W=>TT_REQUESTTAGMAP TT_REQUESTTAGMAP¶
A list of key-value pairs to associate with the DB instance.