create_db_instance ¶

def create_db_instance(
    self,
    name: "capo_timestream_influxdb.types.db_instance_name.DbInstanceName",
    password: "capo_timestream_influxdb.types.password.Password",
    db_instance_type: "capo_timestream_influxdb.types.db_instance_type.DbInstanceType",
    vpc_subnet_ids: "capo_timestream_influxdb.types.vpc_subnet_id_list.VpcSubnetIdList",
    vpc_security_group_ids: "capo_timestream_influxdb.types.vpc_security_group_id_list.VpcSecurityGroupIdList",
    allocated_storage: "capo_timestream_influxdb.types.allocated_storage.AllocatedStorage",
    *,
    config_overrides: Optional[TimestreamInfluxDBClientConfig] = None,
    username: Optional["capo_timestream_influxdb.types.username.Username"] = None,
    organization: Optional[
        "capo_timestream_influxdb.types.organization.Organization"
    ] = None,
    bucket: Optional["capo_timestream_influxdb.types.bucket.Bucket"] = None,
    publicly_accessible: Optional[bool] = None,
    db_storage_type: Optional[
        "capo_timestream_influxdb.types.db_storage_type.DbStorageType"
    ] = None,
    db_parameter_group_identifier: Optional[
        "capo_timestream_influxdb.types.db_parameter_group_identifier.DbParameterGroupIdentifier"
    ] = None,
    deployment_type: Optional[
        "capo_timestream_influxdb.types.deployment_type.DeploymentType"
    ] = None,
    log_delivery_configuration: Optional[
        "capo_timestream_influxdb.types.log_delivery_configuration.LogDeliveryConfiguration"
    ] = None,
    maintenance_schedule: Optional[
        "capo_timestream_influxdb.types.maintenance_schedule.MaintenanceSchedule"
    ] = None,
    tags: Optional[
        "capo_timestream_influxdb.types.request_tag_map.RequestTagMap"
    ] = None,
    port: Optional["capo_timestream_influxdb.types.port.Port"] = None,
    network_type: Optional[
        "capo_timestream_influxdb.types.network_type.NetworkType"
    ] = None,
    db_backup_configurations: Optional[
        "capo_timestream_influxdb.types.db_backup_configuration_input_list.DbBackupConfigurationInputList"
    ] = None,
    kms_key_id: Optional[
        "capo_timestream_influxdb.types.kms_key_id.KmsKeyId"
    ] = None,
) -> "capo_timestream_influxdb.types.create_db_instance_output.CreateDbInstanceOutput":
    """<p>Creates a new Timestream for InfluxDB DB instance.</p>

    Args:
        name: <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: <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: <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: <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: <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: <p>The Timestream for InfluxDB DB instance type to run InfluxDB on.</p>
        vpc_subnet_ids: <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: <p>A list of VPC security group IDs to associate with the DB instance.</p>
        publicly_accessible: <p>Configures the DB instance with a public IP to facilitate access.</p>
        db_storage_type: <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: <p>The amount of storage to allocate for your DB storage type in GiB (gibibytes).</p>
        db_parameter_group_identifier: <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: <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: <p>Configuration for sending InfluxDB engine logs to a specified S3 bucket.</p>
        maintenance_schedule: <p>Specifies the maintenance schedule for the DB instance, including the preferred maintenance window and timezone.</p>
        tags: <p>A list of key-value pairs to associate with the DB instance.</p>
        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: <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: <p>A list of backup configurations to enable automated backups for the DB instance.</p>
        kms_key_id: <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>

    Raises:
        capo_timestream_influxdb.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_timestream_influxdb.errors.conflict_exception.ConflictException: <p>The request conflicts with an existing resource in Timestream for InfluxDB.</p>
        capo_timestream_influxdb.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_timestream_influxdb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found or does not exist.</p>
        capo_timestream_influxdb.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request exceeds the service quota.</p>
        capo_timestream_influxdb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_timestream_influxdb.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by Timestream for InfluxDB.</p>
        capo_timestream_influxdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_timestream_influxdb.types.create_db_instance_input.CreateDbInstanceInput]",
    ) -> OperationResponse[
        "capo_timestream_influxdb.types.create_db_instance_output.CreateDbInstanceOutput"
    ]:
        import capo_timestream_influxdb._operations.amazon_timestream_influx_db.create_db_instance

        output, http_response = (
            capo_timestream_influxdb._operations.amazon_timestream_influx_db.create_db_instance.create_db_instance(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_timestream_influxdb.types.create_db_instance_input.CreateDbInstanceInput",
    ) -> dict[str, Any]:
        import capo_timestream_influxdb.types.create_db_instance_input

        return capo_timestream_influxdb.types.create_db_instance_input.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateDbInstance", redact_input=_redact_input),
    )
    input_: capo_timestream_influxdb.types.create_db_instance_input.CreateDbInstanceInput = {
        "name": name,
        "password": password,
        "db_instance_type": db_instance_type,
        "vpc_subnet_ids": vpc_subnet_ids,
        "vpc_security_group_ids": vpc_security_group_ids,
        "allocated_storage": allocated_storage,
    }
    if username is not None:
        input_["username"] = username
    if organization is not None:
        input_["organization"] = organization
    if bucket is not None:
        input_["bucket"] = bucket
    if publicly_accessible is not None:
        input_["publicly_accessible"] = publicly_accessible
    if db_storage_type is not None:
        input_["db_storage_type"] = db_storage_type
    if db_parameter_group_identifier is not None:
        input_["db_parameter_group_identifier"] = db_parameter_group_identifier
    if deployment_type is not None:
        input_["deployment_type"] = deployment_type
    if log_delivery_configuration is not None:
        input_["log_delivery_configuration"] = log_delivery_configuration
    if maintenance_schedule is not None:
        input_["maintenance_schedule"] = maintenance_schedule
    if tags is not None:
        input_["tags"] = tags
    if port is not None:
        input_["port"] = port
    if network_type is not None:
        input_["network_type"] = network_type
    if db_backup_configurations is not None:
        input_["db_backup_configurations"] = db_backup_configurations
    if kms_key_id is not None:
        input_["kms_key_id"] = kms_key_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output