CreateDbClusterInput
¶
Source code in docs_src/capo_timestream_influxdb/types/create_db_cluster_input.py
allocated_storage
instance-attribute
¶
allocated_storage: NotRequired[AllocatedStorage]
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
bucket
instance-attribute
¶
bucket: NotRequired[Bucket]
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.
db_backup_configurations
instance-attribute
¶
db_backup_configurations: NotRequired[DbBackupConfigurationInputList]
A list of backup configurations to enable automated backups for the DB cluster.
db_instance_type
instance-attribute
¶
db_instance_type: DbInstanceType
The Timestream for InfluxDB DB instance type to run InfluxDB on.
db_parameter_group_identifier
instance-attribute
¶
db_parameter_group_identifier: NotRequired[DbParameterGroupIdentifier]
The ID of the DB parameter group to assign to your DB cluster. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.
db_storage_type
instance-attribute
¶
db_storage_type: NotRequired[DbStorageType]
The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
You can choose between three different types of provisioned Influx IOPS Included storage according to your workload requirements:
-
Influx I/O Included 3000 IOPS
-
Influx I/O Included 12000 IOPS
-
Influx I/O Included 16000 IOPS
deployment_type
instance-attribute
¶
deployment_type: NotRequired[ClusterDeploymentType]
Specifies the type of cluster to create.
failover_mode
instance-attribute
¶
failover_mode: NotRequired[FailoverMode]
Specifies the behavior of failure recovery when the primary node of the cluster fails.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[KmsKeyId]
The Amazon Web Services KMS key identifier to use for encryption of the DB cluster. Can be a key ID, key ARN, alias name, or alias ARN.
log_delivery_configuration
instance-attribute
¶
log_delivery_configuration: NotRequired[LogDeliveryConfiguration]
Configuration for sending InfluxDB engine logs to a specified S3 bucket.
maintenance_schedule
instance-attribute
¶
maintenance_schedule: NotRequired[MaintenanceSchedule]
Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone.
name
instance-attribute
¶
name: DbClusterName
The 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. DB cluster names must be unique per customer and per region.
network_type
instance-attribute
¶
network_type: NotRequired[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
instance-attribute
¶
organization: NotRequired[Organization]
The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.
password
instance-attribute
¶
password: NotRequired[Password]
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.
port
instance-attribute
¶
port: NotRequired[Port]
The port number on which InfluxDB accepts connections.
Valid Values: 1024-65535
Default: 8086 for InfluxDB v2, 8181 for InfluxDB v3
Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680
publicly_accessible
instance-attribute
¶
publicly_accessible: NotRequired[bool]
Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
tags
instance-attribute
¶
tags: NotRequired[RequestTagMap]
A list of key-value pairs to associate with the DB instance.
username
instance-attribute
¶
username: NotRequired[Username]
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 Secrets Manager in your account.
vpc_security_group_ids
instance-attribute
¶
vpc_security_group_ids: VpcSecurityGroupIdList
A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.
vpc_subnet_ids
instance-attribute
¶
vpc_subnet_ids: VpcSubnetIdList
A list of VPC subnet IDs to associate with the DB cluster. Provide at least two VPC subnet IDs in different Availability Zones when deploying with a Multi-AZ standby.