DbInstanceState class

Input properties used for looking up and filtering DbInstance resources.

Constructors

DbInstanceState({Input<int?>? allocatedStorage, Input<String?>? arn, Input<String?>? availabilityZone, Input<String?>? bucket, Input<String?>? dbInstanceType, Input<String?>? dbParameterGroupIdentifier, Input<String?>? dbStorageType, Input<String?>? deploymentType, Input<String?>? endpoint, Input<String?>? influxAuthParametersSecretArn, Input<DbInstanceLogDeliveryConfiguration?>? logDeliveryConfiguration, Input<DbInstanceMaintenanceSchedule?>? maintenanceSchedule, Input<String?>? name, Input<String?>? networkType, Input<String?>? organization, Input<String?>? password, Input<int?>? port, Input<bool?>? publiclyAccessible, Input<String?>? region, Input<String?>? secondaryAvailabilityZone, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<DbInstanceTimeouts?>? timeouts, Input<String?>? username, Input<List<String>?>? vpcSecurityGroupIds, Input<List<String>?>? vpcSubnetIds})
Creates a new DbInstanceState. allocatedStorage Amount of storage in GiB (gibibytes). The minimum value is 20, the maximum value is 16384. This argument is updatable. 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. [arn] ARN of the Timestream for InfluxDB Instance. [availabilityZone] Availability Zone in which the DB instance resides. [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. [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 DB instance. This argument is updatable. If added to an existing Timestream for InfluxDB instance or given a new value, will cause an in-place update to the instance. However, if an instance already has a value for dbParameterGroupIdentifier, removing dbParameterGroupIdentifierwill cause the instance 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. This argument is updatable. For a single instance, after this argument has been updated once, it can only be updated again after 6 hours have passed. deploymentType Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY". This argument is updatable. endpoint Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. influxAuthParametersSecretArn ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. logDeliveryConfiguration Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable. maintenanceSchedule Maintenance schedule for the DB instance, including the preferred maintenance window and timezone. This argument is updatable. name 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. The argument must start with a letter, cannot contain consecutive hyphens (-) and cannot end with a hyphen. networkType 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. 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. 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. port The port on which the instance accepts connections. Valid values: 1024-65535. Cannot be 2375-2376, 7788-7799, 8090, or 51678-51680. This argument is updatable. publiclyAccessible Configures the DB instance 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. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. secondaryAvailabilityZone Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. 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. vpcSecurityGroupIds List of VPC security group IDs to associate with the DB instance. vpcSubnetIds 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.
const
DbInstanceState.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. This argument is updatable. 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`.
final
arn → Input<String?>?
ARN of the Timestream for InfluxDB Instance.
final
availabilityZone → Input<String?>?
Availability Zone in which the DB instance resides.
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.
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 DB instance. This argument is updatable. If added to an existing Timestream for InfluxDB instance or given a new value, will cause an in-place update to the instance. However, if an instance already has a value for dbParameterGroupIdentifier, removing dbParameterGroupIdentifier will cause the instance 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. This argument is updatable. For a single instance, after this argument has been updated once, it can only be updated again after 6 hours have passed.
final
deploymentType → Input<String?>?
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: "SINGLE_AZ", "WITH_MULTIAZ_STANDBY". This argument is updatable.
final
endpoint → Input<String?>?
Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.
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. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
final
logDeliveryConfiguration → Input<DbInstanceLogDeliveryConfiguration?>?
Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.
final
maintenanceSchedule → Input<DbInstanceMaintenanceSchedule?>?
Maintenance schedule for the DB instance, including the preferred maintenance window and timezone. This argument is updatable.
final
name → Input<String?>?
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. The argument must start with a letter, cannot contain consecutive hyphens (-) and cannot end with a hyphen.
final
networkType → Input<String?>?
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.
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.
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.
final
port → Input<int?>?
The port on which the instance 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 instance 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
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
secondaryAvailabilityZone → Input<String?>?
Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.
final
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<DbInstanceTimeouts?>?
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.
final
vpcSecurityGroupIds → Input<List<String>?>?
List of VPC security group IDs to associate with the DB instance.
final
vpcSubnetIds → Input<List<String>?>?
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.
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