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< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>DbClusterTimeouts?> ? timeouts, Input<String?> ? username, Input<List< ? vpcSecurityGroupIds, Input<String> ?>List< ? vpcSubnetIds})String> ?> -
Creates a new DbClusterState.
allocatedStorageAmount of storage in GiB (gibibytes). The minimum value is20, the maximum value is16384. The argumentdbStorageTypeplaces restrictions on this argument's minimum value. The following is a list ofdbStorageTypevalues and the corresponding minimum value forallocatedStorage:"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 withorganization,username, andpassword, this argument will be stored in the secret referred to by theinfluxAuthParametersSecretArnattribute. 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 fordbParameterGroupIdentifier, removingdbParameterGroupIdentifierwill 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 forallocatedStorageis 400.deploymentTypeSpecifies 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).endpointEndpoint used to connect to InfluxDB. The default InfluxDB port is 8086.engineTypeDatabase engine type of the DB cluster.failoverModeSpecifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are:"AUTOMATIC"and"NO_FAILOVER".influxAuthParametersSecretArnARN 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.logDeliveryConfigurationConfiguration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.maintenanceScheduleMaintenance 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).nameName 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.networkTypeSpecifies 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.organizationName of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along withbucket,username, andpassword, this argument will be stored in the secret referred to by theinfluxAuthParametersSecretArnattribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group).passwordPassword 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 withbucket,username, andorganization, this argument will be stored in the secret referred to by theinfluxAuthParametersSecretArnattribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group) as the AWS API rejects it.portThe port on which the cluster accepts connections. Valid values:1024-65535. Cannot be2375-2376,7788-7799,8090, or51678-51680. This argument is updatable.publiclyAccessibleConfigures 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.readerEndpointThe endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.tagsMap of tags assigned to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.timeoutsOptional.usernameUsername 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 withbucket,organization, andpassword, this argument will be stored in the secret referred to by theinfluxAuthParametersSecretArnattribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 db parameter group).vpcSecurityGroupIdsList of VPC security group IDs to associate with the cluster.vpcSubnetIdsList 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 is16384. The argumentdbStorageTypeplaces restrictions on this argument's minimum value. The following is a list ofdbStorageTypevalues and the corresponding minimum value forallocatedStorage:"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, andpassword, this argument will be stored in the secret referred to by theinfluxAuthParametersSecretArnattribute. 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, removingdbParameterGroupIdentifierwill 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 forallocatedStorage` 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, andpassword, this argument will be stored in the secret referred to by theinfluxAuthParametersSecretArnattribute. 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, andorganization, this argument will be stored in the secret referred to by theinfluxAuthParametersSecretArnattribute. 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 be2375-2376,7788-7799,8090, or51678-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
-
Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration 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, andpassword, this argument will be stored in the secret referred to by theinfluxAuthParametersSecretArnattribute. 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