Skip to content

UpdateDbInstanceOutput

Source code in docs_src/capo_timestream_influxdb/types/update_db_instance_output.py
class UpdateDbInstanceOutput(TypedDict, closed=True):
    id: "capo_timestream_influxdb.types.db_instance_id.DbInstanceId"
    """<p>A service-generated unique identifier.</p>"""
    name: "capo_timestream_influxdb.types.db_instance_name.DbInstanceName"
    """<p>This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.</p>"""
    arn: "capo_timestream_influxdb.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the DB instance.</p>"""
    status: NotRequired["capo_timestream_influxdb.types.status.Status"]
    """<p>The status of the DB instance.</p>"""
    endpoint: NotRequired["str"]
    """<p>The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.</p>"""
    port: NotRequired["capo_timestream_influxdb.types.port.Port"]
    """<p>The port number on which InfluxDB accepts connections.</p>"""
    network_type: NotRequired["capo_timestream_influxdb.types.network_type.NetworkType"]
    """<p>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.</p>"""
    db_instance_type: NotRequired[
        "capo_timestream_influxdb.types.db_instance_type.DbInstanceType"
    ]
    """<p>The Timestream for InfluxDB instance type that InfluxDB runs on.</p>"""
    db_storage_type: NotRequired[
        "capo_timestream_influxdb.types.db_storage_type.DbStorageType"
    ]
    """<p>The Timestream for InfluxDB DB storage type that InfluxDB stores data on.</p>"""
    allocated_storage: NotRequired[
        "capo_timestream_influxdb.types.allocated_storage.AllocatedStorage"
    ]
    """<p>The amount of storage allocated for your DB storage type (in gibibytes).</p>"""
    deployment_type: NotRequired[
        "capo_timestream_influxdb.types.deployment_type.DeploymentType"
    ]
    """<p>Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.</p>"""
    vpc_subnet_ids: "capo_timestream_influxdb.types.vpc_subnet_id_list.VpcSubnetIdList"
    """<p>A list of VPC subnet IDs associated with the DB instance.</p>"""
    publicly_accessible: NotRequired["bool"]
    """<p>Indicates if the DB instance has a public IP to facilitate access.</p>"""
    vpc_security_group_ids: NotRequired[
        "capo_timestream_influxdb.types.vpc_security_group_id_list.VpcSecurityGroupIdList"
    ]
    """<p>A list of VPC security group IDs associated with the DB instance.</p>"""
    db_parameter_group_identifier: NotRequired[
        "capo_timestream_influxdb.types.db_parameter_group_identifier.DbParameterGroupIdentifier"
    ]
    """<p>The id of the DB parameter group assigned to your DB instance.</p>"""
    availability_zone: NotRequired["str"]
    """<p>The Availability Zone in which the DB instance resides.</p>"""
    secondary_availability_zone: NotRequired["str"]
    """<p>The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.</p>"""
    log_delivery_configuration: NotRequired[
        "capo_timestream_influxdb.types.log_delivery_configuration.LogDeliveryConfiguration"
    ]
    """<p>Configuration for sending InfluxDB engine logs to send to specified S3 bucket.</p>"""
    influx_auth_parameters_secret_arn: NotRequired["str"]
    """<p>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.</p>"""
    db_cluster_id: NotRequired[
        "capo_timestream_influxdb.types.db_cluster_id.DbClusterId"
    ]
    """<p>Specifies the DbCluster to which this DbInstance belongs to.</p>"""
    instance_mode: NotRequired[
        "capo_timestream_influxdb.types.instance_mode.InstanceMode"
    ]
    """<p>Specifies the DbInstance's role in the cluster.</p>"""
    instance_modes: NotRequired[
        "capo_timestream_influxdb.types.instance_mode_list.InstanceModeList"
    ]
    """<p>Specifies the DbInstance's roles in the cluster.</p>"""
    maintenance_schedule: NotRequired[
        "capo_timestream_influxdb.types.maintenance_schedule.MaintenanceSchedule"
    ]
    """<p>The maintenance schedule for the DB instance.</p>"""
    last_maintenance_time: NotRequired["datetime.datetime"]
    """<p>The timestamp of the last completed maintenance operation on the DB instance.</p>"""
    next_maintenance_time: NotRequired["datetime.datetime"]
    """<p>The timestamp of the next scheduled maintenance operation on the DB instance.</p>"""
    db_backup_configurations: NotRequired[
        "capo_timestream_influxdb.types.db_backup_configuration_output_list.DbBackupConfigurationOutputList"
    ]
    """<p>The backup configurations for the DB instance.</p>"""
    kms_key_id: NotRequired["capo_timestream_influxdb.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Web Services KMS key ARN used for encryption of the DB instance.</p>"""

allocated_storage instance-attribute

allocated_storage: NotRequired[AllocatedStorage]

The amount of storage allocated for your DB storage type (in gibibytes).

arn instance-attribute

arn: Arn

The Amazon Resource Name (ARN) of the DB instance.

availability_zone instance-attribute

availability_zone: NotRequired[str]

The Availability Zone in which the DB instance resides.

db_backup_configurations instance-attribute

db_backup_configurations: NotRequired[DbBackupConfigurationOutputList]

The backup configurations for the DB instance.

db_cluster_id instance-attribute

db_cluster_id: NotRequired[DbClusterId]

Specifies the DbCluster to which this DbInstance belongs to.

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 instance.

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[DeploymentType]

Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

endpoint instance-attribute

endpoint: NotRequired[str]

The endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

id instance-attribute

A service-generated unique identifier.

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.

instance_mode instance-attribute

instance_mode: NotRequired[InstanceMode]

Specifies the DbInstance's role in the cluster.

instance_modes instance-attribute

instance_modes: NotRequired[InstanceModeList]

Specifies the DbInstance's roles in the cluster.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The Amazon Web Services KMS key ARN used for encryption of the DB instance.

last_maintenance_time instance-attribute

last_maintenance_time: NotRequired[datetime]

The timestamp of the last completed maintenance operation on the DB instance.

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 instance.

name instance-attribute

This customer-supplied name uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

network_type instance-attribute

network_type: NotRequired[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.

next_maintenance_time instance-attribute

next_maintenance_time: NotRequired[datetime]

The timestamp of the next scheduled maintenance operation on the DB instance.

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 instance has a public IP to facilitate access.

secondary_availability_zone instance-attribute

secondary_availability_zone: NotRequired[str]

The Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance.

status instance-attribute

status: NotRequired[Status]

The status of the DB instance.

vpc_security_group_ids instance-attribute

vpc_security_group_ids: NotRequired[VpcSecurityGroupIdList]

A list of VPC security group IDs associated with the DB instance.

vpc_subnet_ids instance-attribute

vpc_subnet_ids: VpcSubnetIdList

A list of VPC subnet IDs associated with the DB instance.