commonMain.aws.sdk.kotlin.services.timestreaminfluxdb.model.CreateDbInstanceRequest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of timestreaminfluxdb-jvm Show documentation
Show all versions of timestreaminfluxdb-jvm Show documentation
The AWS SDK for Kotlin client for Timestream InfluxDB
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.timestreaminfluxdb.model
import aws.smithy.kotlin.runtime.SdkDsl
public class CreateDbInstanceRequest private constructor(builder: Builder) {
/**
* The amount of storage to allocate for your DB storage type in GiB (gibibytes).
*/
public val allocatedStorage: kotlin.Int? = builder.allocatedStorage
/**
* 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.
*/
public val bucket: kotlin.String? = builder.bucket
/**
* The Timestream for InfluxDB DB instance type to run InfluxDB on.
*/
public val dbInstanceType: aws.sdk.kotlin.services.timestreaminfluxdb.model.DbInstanceType? = builder.dbInstanceType
/**
* 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.
*/
public val dbParameterGroupIdentifier: kotlin.String? = builder.dbParameterGroupIdentifier
/**
* 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
*/
public val dbStorageType: aws.sdk.kotlin.services.timestreaminfluxdb.model.DbStorageType? = builder.dbStorageType
/**
* Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
*/
public val deploymentType: aws.sdk.kotlin.services.timestreaminfluxdb.model.DeploymentType? = builder.deploymentType
/**
* Configuration for sending InfluxDB engine logs to a specified S3 bucket.
*/
public val logDeliveryConfiguration: aws.sdk.kotlin.services.timestreaminfluxdb.model.LogDeliveryConfiguration? = builder.logDeliveryConfiguration
/**
* 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.
*/
public val name: kotlin.String? = builder.name
/**
* The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
*/
public val organization: kotlin.String? = builder.organization
/**
* 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.
*/
public val password: kotlin.String? = builder.password
/**
* Configures the DB instance with a public IP to facilitate access.
*/
public val publiclyAccessible: kotlin.Boolean? = builder.publiclyAccessible
/**
* A list of key-value pairs to associate with the DB instance.
*/
public val tags: Map? = builder.tags
/**
* 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.
*/
public val username: kotlin.String? = builder.username
/**
* A list of VPC security group IDs to associate with the DB instance.
*/
public val vpcSecurityGroupIds: List? = builder.vpcSecurityGroupIds
/**
* 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.
*/
public val vpcSubnetIds: List? = builder.vpcSubnetIds
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.timestreaminfluxdb.model.CreateDbInstanceRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CreateDbInstanceRequest(")
append("allocatedStorage=$allocatedStorage,")
append("bucket=$bucket,")
append("dbInstanceType=$dbInstanceType,")
append("dbParameterGroupIdentifier=$dbParameterGroupIdentifier,")
append("dbStorageType=$dbStorageType,")
append("deploymentType=$deploymentType,")
append("logDeliveryConfiguration=$logDeliveryConfiguration,")
append("name=$name,")
append("organization=$organization,")
append("password=*** Sensitive Data Redacted ***,")
append("publiclyAccessible=$publiclyAccessible,")
append("tags=$tags,")
append("username=*** Sensitive Data Redacted ***,")
append("vpcSecurityGroupIds=$vpcSecurityGroupIds,")
append("vpcSubnetIds=$vpcSubnetIds")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = allocatedStorage ?: 0
result = 31 * result + (bucket?.hashCode() ?: 0)
result = 31 * result + (dbInstanceType?.hashCode() ?: 0)
result = 31 * result + (dbParameterGroupIdentifier?.hashCode() ?: 0)
result = 31 * result + (dbStorageType?.hashCode() ?: 0)
result = 31 * result + (deploymentType?.hashCode() ?: 0)
result = 31 * result + (logDeliveryConfiguration?.hashCode() ?: 0)
result = 31 * result + (name?.hashCode() ?: 0)
result = 31 * result + (organization?.hashCode() ?: 0)
result = 31 * result + (password?.hashCode() ?: 0)
result = 31 * result + (publiclyAccessible?.hashCode() ?: 0)
result = 31 * result + (tags?.hashCode() ?: 0)
result = 31 * result + (username?.hashCode() ?: 0)
result = 31 * result + (vpcSecurityGroupIds?.hashCode() ?: 0)
result = 31 * result + (vpcSubnetIds?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as CreateDbInstanceRequest
if (allocatedStorage != other.allocatedStorage) return false
if (bucket != other.bucket) return false
if (dbInstanceType != other.dbInstanceType) return false
if (dbParameterGroupIdentifier != other.dbParameterGroupIdentifier) return false
if (dbStorageType != other.dbStorageType) return false
if (deploymentType != other.deploymentType) return false
if (logDeliveryConfiguration != other.logDeliveryConfiguration) return false
if (name != other.name) return false
if (organization != other.organization) return false
if (password != other.password) return false
if (publiclyAccessible != other.publiclyAccessible) return false
if (tags != other.tags) return false
if (username != other.username) return false
if (vpcSecurityGroupIds != other.vpcSecurityGroupIds) return false
if (vpcSubnetIds != other.vpcSubnetIds) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.timestreaminfluxdb.model.CreateDbInstanceRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The amount of storage to allocate for your DB storage type in GiB (gibibytes).
*/
public var allocatedStorage: kotlin.Int? = null
/**
* 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.
*/
public var bucket: kotlin.String? = null
/**
* The Timestream for InfluxDB DB instance type to run InfluxDB on.
*/
public var dbInstanceType: aws.sdk.kotlin.services.timestreaminfluxdb.model.DbInstanceType? = null
/**
* 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.
*/
public var dbParameterGroupIdentifier: kotlin.String? = null
/**
* 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
*/
public var dbStorageType: aws.sdk.kotlin.services.timestreaminfluxdb.model.DbStorageType? = null
/**
* Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
*/
public var deploymentType: aws.sdk.kotlin.services.timestreaminfluxdb.model.DeploymentType? = null
/**
* Configuration for sending InfluxDB engine logs to a specified S3 bucket.
*/
public var logDeliveryConfiguration: aws.sdk.kotlin.services.timestreaminfluxdb.model.LogDeliveryConfiguration? = null
/**
* 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.
*/
public var name: kotlin.String? = null
/**
* The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
*/
public var organization: kotlin.String? = null
/**
* 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.
*/
public var password: kotlin.String? = null
/**
* Configures the DB instance with a public IP to facilitate access.
*/
public var publiclyAccessible: kotlin.Boolean? = null
/**
* A list of key-value pairs to associate with the DB instance.
*/
public var tags: Map? = null
/**
* 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.
*/
public var username: kotlin.String? = null
/**
* A list of VPC security group IDs to associate with the DB instance.
*/
public var vpcSecurityGroupIds: List? = null
/**
* 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.
*/
public var vpcSubnetIds: List? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.timestreaminfluxdb.model.CreateDbInstanceRequest) : this() {
this.allocatedStorage = x.allocatedStorage
this.bucket = x.bucket
this.dbInstanceType = x.dbInstanceType
this.dbParameterGroupIdentifier = x.dbParameterGroupIdentifier
this.dbStorageType = x.dbStorageType
this.deploymentType = x.deploymentType
this.logDeliveryConfiguration = x.logDeliveryConfiguration
this.name = x.name
this.organization = x.organization
this.password = x.password
this.publiclyAccessible = x.publiclyAccessible
this.tags = x.tags
this.username = x.username
this.vpcSecurityGroupIds = x.vpcSecurityGroupIds
this.vpcSubnetIds = x.vpcSubnetIds
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.timestreaminfluxdb.model.CreateDbInstanceRequest = CreateDbInstanceRequest(this)
/**
* construct an [aws.sdk.kotlin.services.timestreaminfluxdb.model.LogDeliveryConfiguration] inside the given [block]
*/
public fun logDeliveryConfiguration(block: aws.sdk.kotlin.services.timestreaminfluxdb.model.LogDeliveryConfiguration.Builder.() -> kotlin.Unit) {
this.logDeliveryConfiguration = aws.sdk.kotlin.services.timestreaminfluxdb.model.LogDeliveryConfiguration.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}