CreateDbInstanceRequest

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

Link copied to clipboard

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

Link copied to clipboard

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

Link copied to clipboard
val name: 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.

Link copied to clipboard

Specifies whether the networkType of the Timestream for InfluxDB instance is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val port: Int?

The port number on which InfluxDB accepts connections.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String