TimestreamInfluxDB / Client / create_db_cluster

create_db_cluster#

TimestreamInfluxDB.Client.create_db_cluster(**kwargs)#

Creates a new Timestream for InfluxDB cluster.

See also: AWS API Documentation

Request Syntax

response = client.create_db_cluster(
    name='string',
    username='string',
    password='string',
    organization='string',
    bucket='string',
    port=123,
    dbParameterGroupIdentifier='string',
    dbInstanceType='db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge',
    dbStorageType='InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    allocatedStorage=123,
    networkType='IPV4'|'DUAL',
    publiclyAccessible=True|False,
    vpcSubnetIds=[
        'string',
    ],
    vpcSecurityGroupIds=[
        'string',
    ],
    deploymentType='MULTI_NODE_READ_REPLICAS',
    failoverMode='AUTOMATIC'|'NO_FAILOVER',
    logDeliveryConfiguration={
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • name (string) –

    [REQUIRED]

    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.

  • username (string) – 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.

  • password (string) –

    [REQUIRED]

    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.

  • organization (string) – The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.

  • bucket (string) – 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.

  • port (integer) –

    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

  • dbParameterGroupIdentifier (string) – 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.

  • dbInstanceType (string) –

    [REQUIRED]

    The Timestream for InfluxDB DB instance type to run InfluxDB on.

  • dbStorageType (string) –

    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

  • allocatedStorage (integer) –

    [REQUIRED]

    The amount of storage to allocate for your DB storage type in GiB (gibibytes).

  • networkType (string) – 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.

  • publiclyAccessible (boolean) – Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.

  • vpcSubnetIds (list) –

    [REQUIRED]

    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.

    • (string) –

  • vpcSecurityGroupIds (list) –

    [REQUIRED]

    A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.

    • (string) –

  • deploymentType (string) –

    [REQUIRED]

    Specifies the type of cluster to create.

  • failoverMode (string) – Specifies the behavior of failure recovery when the primary node of the cluster fails.

  • logDeliveryConfiguration (dict) –

    Configuration for sending InfluxDB engine logs to a specified S3 bucket.

    • s3Configuration (dict) – [REQUIRED]

      Configuration for S3 bucket log delivery.

      • bucketName (string) – [REQUIRED]

        The name of the S3 bucket to deliver logs to.

      • enabled (boolean) – [REQUIRED]

        Indicates whether log delivery to the S3 bucket is enabled.

  • tags (dict) –

    A list of key-value pairs to associate with the DB instance.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'dbClusterId': 'string',
    'dbClusterStatus': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED'
}

Response Structure

  • (dict) –

    • dbClusterId (string) –

      A service-generated unique identifier.

    • dbClusterStatus (string) –

      The status of the DB cluster.

Exceptions