GetDbClusterOutput
¶
Source code in docs_src/capo_timestream_influxdb/types/get_db_cluster_output.py
allocated_storage
instance-attribute
¶
allocated_storage: NotRequired[AllocatedStorage]
The amount of storage allocated for your DB storage type (in gibibytes).
cluster_configuration
instance-attribute
¶
cluster_configuration: NotRequired[ClusterConfiguration]
Configuration for node modes in the DbCluster.
db_backup_configurations
instance-attribute
¶
db_backup_configurations: NotRequired[DbBackupConfigurationOutputList]
The backup configurations for the DB cluster.
db_instance_type
instance-attribute
¶
db_instance_type: NotRequired[DbInstanceType]
The Timestream for InfluxDB instance type that InfluxDB runs on.
db_parameter_group_identifier
instance-attribute
¶
db_parameter_group_identifier: NotRequired[DbParameterGroupIdentifier]
The ID of the DB parameter group assigned to your DB cluster.
db_storage_type
instance-attribute
¶
db_storage_type: NotRequired[DbStorageType]
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
deployment_type
instance-attribute
¶
deployment_type: NotRequired[ClusterDeploymentType]
Deployment type of the DB cluster.
effective_db_parameter_group_identifier
instance-attribute
¶
effective_db_parameter_group_identifier: NotRequired[DbParameterGroupIdentifier]
The ID of the DB parameter group actually applied to your DB cluster. When the service applies optimized defaults, it creates a service-managed DB parameter group and this field reflects that group, while dbParameterGroupIdentifier reflects the customer-provided DB parameter group. When no service-managed DB parameter group is applied, this value matches dbParameterGroupIdentifier.
endpoint
instance-attribute
¶
endpoint: NotRequired[str]
The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
engine_type
instance-attribute
¶
engine_type: NotRequired[EngineType]
The engine type of your DB cluster.
failover_mode
instance-attribute
¶
failover_mode: NotRequired[FailoverMode]
The configured failover mode for the DB cluster.
id
instance-attribute
¶
id: DbClusterId
Service-generated unique identifier of the DB cluster to retrieve.
influx_auth_parameters_secret_arn
instance-attribute
¶
influx_auth_parameters_secret_arn: NotRequired[str]
The Amazon Resource Name (ARN) of the 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.
kms_key_id
instance-attribute
¶
kms_key_id: NotRequired[KmsKeyId]
The Amazon Web Services KMS key ARN used for encryption of the DB cluster.
last_maintenance_time
instance-attribute
¶
last_maintenance_time: NotRequired[datetime]
The timestamp of the last completed maintenance operation on the DB cluster.
log_delivery_configuration
instance-attribute
¶
log_delivery_configuration: NotRequired[LogDeliveryConfiguration]
Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
maintenance_schedule
instance-attribute
¶
maintenance_schedule: NotRequired[MaintenanceSchedule]
The maintenance schedule for the DB cluster.
name
instance-attribute
¶
name: DbClusterName
Customer-supplied name of the Timestream for InfluxDB cluster.
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.
next_maintenance_time
instance-attribute
¶
next_maintenance_time: NotRequired[datetime]
The timestamp of the next scheduled maintenance operation on the DB cluster.
port
instance-attribute
¶
port: NotRequired[Port]
The port number on which InfluxDB accepts connections.
publicly_accessible
instance-attribute
¶
publicly_accessible: NotRequired[bool]
Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
reader_endpoint
instance-attribute
¶
reader_endpoint: NotRequired[str]
The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
vpc_security_group_ids
instance-attribute
¶
vpc_security_group_ids: NotRequired[VpcSecurityGroupIdList]
A list of VPC security group IDs associated with the DB cluster.
vpc_subnet_ids
instance-attribute
¶
vpc_subnet_ids: NotRequired[VpcSubnetIdList]
A list of VPC subnet IDs associated with the DB cluster.