DbClusterState class

Input properties used for looking up and filtering DbCluster resources.

Constructors

DbClusterState({Input<int?>? allocatedStorage, Input<String?>? arn, Input<String?>? bucket, Input<String?>? dbInstanceType, Input<String?>? dbParameterGroupIdentifier, Input<String?>? dbStorageType, Input<String?>? deploymentType, Input<String?>? endpoint, Input<String?>? engineType, Input<String?>? failoverMode, Input<String?>? influxAuthParametersSecretArn, Input<DbClusterLogDeliveryConfiguration?>? logDeliveryConfiguration, Input<DbClusterMaintenanceSchedule?>? maintenanceSchedule, Input<String?>? name, Input<String?>? networkType, Input<String?>? organization, Input<String?>? password, Input<int?>? port, Input<bool?>? publiclyAccessible, Input<String?>? readerEndpoint, Input<String?>? region, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<DbClusterTimeouts?>? timeouts, Input<String?>? username, Input<List<String>?>? vpcSecurityGroupIds, Input<List<String>?>? vpcSubnetIds})
Creates a new DbClusterState. allocatedStorage Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384. The argument dbStorageType places restrictions on this argument's minimum value. The following is a list of dbStorageType values and the corresponding minimum value for allocatedStorage: "InfluxIOIncludedT1": 20, "InfluxIOIncludedT2" and "InfluxIOIncludedT3": 400. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group). [arn] ARN of the Timestream for InfluxDB cluster. [bucket] 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. Along with organization, username, and password, this argument will be stored in the secret referred to by the influxAuthParametersSecretArnattribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group). [dbInstanceType] Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are:"db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", and "db.influx.16xlarge". This argument is updatable. [dbParameterGroupIdentifier] ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for dbParameterGroupIdentifier, removing dbParameterGroupIdentifierwill cause the cluster to be destroyed and recreated. [dbStorageType] 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. Valid options are:"InfluxIOIncludedT1", "InfluxIOIncludedT2", and "InfluxIOIncludedT3". If you use "InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for allocatedStorage is 400. deploymentType Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS". This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group). endpoint Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. engineType Database engine type of the DB cluster. failoverMode Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER". influxAuthParametersSecretArn ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. For InfluxDB V2 clusters, the secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. For InfluxDB V3 clusters, the secret contains the InfluxDB admin token. logDeliveryConfiguration Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable. maintenanceSchedule Maintenance schedule for the DB cluster, including the preferred maintenance window and timezone. This argument is updatable. This field is only supported for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group). name Name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (-) and cannot end with a hyphen. networkType Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. organization Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with bucket, username, and password, this argument will be stored in the secret referred to by the influxAuthParametersSecretArn attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group). password 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. Along with bucket, username, and organization, this argument will be stored in the secret referred to by the influxAuthParametersSecretArn attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group) as the AWS API rejects it. port The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable. publiclyAccessible Configures the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enabled public access, in addition to this argument. See "Usage with Public Internet Access Enabled" for an example configuration with all required resources for public internet access. readerEndpoint The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. tags Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. timeouts Optional. username 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. 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. Along with bucket, organization, and password, this argument will be stored in the secret referred to by the influxAuthParametersSecretArn attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group). vpcSecurityGroupIds List of VPC security group IDs to associate with the cluster. vpcSubnetIds List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
const
DbClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

allocatedStorage → Input<int?>?
Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384. The argument dbStorageType places restrictions on this argument's minimum value. The following is a list of dbStorageType values and the corresponding minimum value for allocatedStorage: "InfluxIOIncludedT1": 20, "InfluxIOIncludedT2" and "InfluxIOIncludedT3": 400`. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group).
final
arn → Input<String?>?
ARN of the Timestream for InfluxDB cluster.
final
bucket → Input<String?>?
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. Along with organization, username, and password, this argument will be stored in the secret referred to by the influxAuthParametersSecretArn attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group).
final
dbInstanceType → Input<String?>?
Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are: "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", and "db.influx.16xlarge". This argument is updatable.
final
dbParameterGroupIdentifier → Input<String?>?
ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for dbParameterGroupIdentifier, removing dbParameterGroupIdentifier will cause the cluster to be destroyed and recreated.
final
dbStorageType → Input<String?>?
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. Valid options are: "InfluxIOIncludedT1", "InfluxIOIncludedT2", and "InfluxIOIncludedT3". If you use "InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for allocatedStorage` is 400.
final
deploymentType → Input<String?>?
Specifies the type of cluster to create. Valid options are: "MULTI_NODE_READ_REPLICAS". This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group).
final
endpoint → Input<String?>?
Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
final
engineType → Input<String?>?
Database engine type of the DB cluster.
final
failoverMode → Input<String?>?
Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: "AUTOMATIC" and "NO_FAILOVER".
final
hashCode → int
The hash code for this object.
no setterinherited
influxAuthParametersSecretArn → Input<String?>?
ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. For InfluxDB V2 clusters, the secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. For InfluxDB V3 clusters, the secret contains the InfluxDB admin token.
final
logDeliveryConfiguration → Input<DbClusterLogDeliveryConfiguration?>?
Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.
final
maintenanceSchedule → Input<DbClusterMaintenanceSchedule?>?
Maintenance schedule for the DB cluster, including the preferred maintenance window and timezone. This argument is updatable. This field is only supported for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group).
final
name → Input<String?>?
Name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (-) and cannot end with a hyphen.
final
networkType → Input<String?>?
Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
final
organization → Input<String?>?
Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with bucket, username, and password, this argument will be stored in the secret referred to by the influxAuthParametersSecretArn attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group).
final
password → Input<String?>?
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. Along with bucket, username, and organization, this argument will be stored in the secret referred to by the influxAuthParametersSecretArn attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group) as the AWS API rejects it.
final
port → Input<int?>?
The port on which the cluster accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable.
final
publiclyAccessible → Input<bool?>?
Configures the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enabled public access, in addition to this argument. See "Usage with Public Internet Access Enabled" for an example configuration with all required resources for public internet access.
final
readerEndpoint → Input<String?>?
The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
timeouts → Input<DbClusterTimeouts?>?
final
username → Input<String?>?
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. 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. Along with bucket, organization, and password, this argument will be stored in the secret referred to by the influxAuthParametersSecretArn attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group).
final
vpcSecurityGroupIds → Input<List<String>?>?
List of VPC security group IDs to associate with the cluster.
final
vpcSubnetIds → Input<List<String>?>?
List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited