Skip to content

CreateDbInstanceInput

Source code in docs_src/capo_timestream_influxdb/types/create_db_instance_input.py
class CreateDbInstanceInput(TypedDict, closed=True):
    name: "capo_timestream_influxdb.types.db_instance_name.DbInstanceName"
    """<p>The 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.</p>"""
    username: NotRequired["capo_timestream_influxdb.types.username.Username"]
    """<p>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 Amazon Secrets Manager in your account.</p>"""
    password: "capo_timestream_influxdb.types.password.Password"
    """<p>The password of the initial admin user created in InfluxDB v2. 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.</p>"""
    organization: NotRequired[
        "capo_timestream_influxdb.types.organization.Organization"
    ]
    """<p>The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.</p>"""
    bucket: NotRequired["capo_timestream_influxdb.types.bucket.Bucket"]
    """<p>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.</p>"""
    db_instance_type: "capo_timestream_influxdb.types.db_instance_type.DbInstanceType"
    """<p>The Timestream for InfluxDB DB instance type to run InfluxDB on.</p>"""
    vpc_subnet_ids: "capo_timestream_influxdb.types.vpc_subnet_id_list.VpcSubnetIdList"
    """<p>A 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.</p>"""
    vpc_security_group_ids: "capo_timestream_influxdb.types.vpc_security_group_id_list.VpcSecurityGroupIdList"
    """<p>A list of VPC security group IDs to associate with the DB instance.</p>"""
    publicly_accessible: NotRequired["bool"]
    """<p>Configures the DB instance with a public IP to facilitate access.</p>"""
    db_storage_type: NotRequired[
        "capo_timestream_influxdb.types.db_storage_type.DbStorageType"
    ]
    """<p>The Timestream for InfluxDB DB storage type to read and write InfluxDB data.</p> <p>You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:</p> <ul> <li> <p>Influx IO Included 3000 IOPS</p> </li> <li> <p>Influx IO Included 12000 IOPS</p> </li> <li> <p>Influx IO Included 16000 IOPS</p> </li> </ul>"""
    allocated_storage: (
        "capo_timestream_influxdb.types.allocated_storage.AllocatedStorage"
    )
    """<p>The amount of storage to allocate for your DB storage type in GiB (gibibytes).</p>"""
    db_parameter_group_identifier: NotRequired[
        "capo_timestream_influxdb.types.db_parameter_group_identifier.DbParameterGroupIdentifier"
    ]
    """<p>The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.</p>"""
    deployment_type: NotRequired[
        "capo_timestream_influxdb.types.deployment_type.DeploymentType"
    ]
    """<p>Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.</p>"""
    log_delivery_configuration: NotRequired[
        "capo_timestream_influxdb.types.log_delivery_configuration.LogDeliveryConfiguration"
    ]
    """<p>Configuration for sending InfluxDB engine logs to a specified S3 bucket.</p>"""
    maintenance_schedule: NotRequired[
        "capo_timestream_influxdb.types.maintenance_schedule.MaintenanceSchedule"
    ]
    """<p>Specifies the maintenance schedule for the DB instance, including the preferred maintenance window and timezone.</p>"""
    tags: NotRequired["capo_timestream_influxdb.types.request_tag_map.RequestTagMap"]
    """<p>A list of key-value pairs to associate with the DB instance.</p>"""
    port: "capo_timestream_influxdb.types.port.Port"
    """<p>The port number on which InfluxDB accepts connections.</p> <p>Valid Values: 1024-65535</p> <p>Default: 8086</p> <p>Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680</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_backup_configurations: NotRequired[
        "capo_timestream_influxdb.types.db_backup_configuration_input_list.DbBackupConfigurationInputList"
    ]
    """<p>A list of backup configurations to enable automated backups for the DB instance.</p>"""
    kms_key_id: NotRequired["capo_timestream_influxdb.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Web Services KMS key identifier to use for encryption of the DB instance. Can be a key ID, key ARN, alias name, or alias ARN.</p>"""

allocated_storage instance-attribute

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

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

deployment_type instance-attribute

deployment_type: NotRequired[DeploymentType]

Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The Amazon Web Services KMS key identifier to use for encryption of the DB instance. 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 instance, including the preferred maintenance window and timezone.

name instance-attribute

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

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.

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: Password

The password of the initial admin user created in InfluxDB v2. 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: Port

The port number on which InfluxDB accepts connections.

Valid Values: 1024-65535

Default: 8086

Constraints: The value can't be 2375-2376, 7788-7799, 8090, or 51678-51680

publicly_accessible instance-attribute

publicly_accessible: NotRequired[bool]

Configures the DB instance with a public IP to facilitate access.

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

vpc_subnet_ids instance-attribute

vpc_subnet_ids: VpcSubnetIdList

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