TimestreamInfluxDB / Client / update_db_instance

update_db_instance#

TimestreamInfluxDB.Client.update_db_instance(**kwargs)#

Updates a Timestream for InfluxDB DB instance.

See also: AWS API Documentation

Request Syntax

response = client.update_db_instance(
    identifier='string',
    logDeliveryConfiguration={
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    dbParameterGroupIdentifier='string',
    port=123,
    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',
    deploymentType='SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'
)
Parameters:

  • identifier (string) –

    [REQUIRED]

    The id of the DB instance.

  • logDeliveryConfiguration (dict) –

    Configuration for sending InfluxDB engine logs to send to 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.

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

  • port (integer) –

    The port number on which InfluxDB accepts connections.

    If you change the Port value, your database restarts immediately.

    Valid Values: 1024-65535

    Default: 8086

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

  • dbInstanceType (string) – The Timestream for InfluxDB DB instance type to run InfluxDB on.

  • deploymentType (string) – Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE',
    'endpoint': 'string',
    'port': 123,
    '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,
    'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
    'vpcSubnetIds': [
        'string',
    ],
    'publiclyAccessible': True|False,
    'vpcSecurityGroupIds': [
        'string',
    ],
    'dbParameterGroupIdentifier': 'string',
    'availabilityZone': 'string',
    'secondaryAvailabilityZone': 'string',
    'logDeliveryConfiguration': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'influxAuthParametersSecretArn': 'string'
}

Response Structure

  • (dict) –

    • id (string) –

      A service-generated unique identifier.

    • name (string) –

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

    • arn (string) –

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

    • status (string) –

      The status of the DB instance.

    • endpoint (string) –

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

    • port (integer) –

      The port number on which InfluxDB accepts connections.

    • dbInstanceType (string) –

      The Timestream for InfluxDB instance type that InfluxDB runs on.

    • dbStorageType (string) –

      The Timestream for InfluxDB DB storage type that InfluxDB stores data on.

    • allocatedStorage (integer) –

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

    • deploymentType (string) –

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

    • vpcSubnetIds (list) –

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

      • (string) –

    • publiclyAccessible (boolean) –

      Indicates if the DB instance has a public IP to facilitate access.

    • vpcSecurityGroupIds (list) –

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

      • (string) –

    • dbParameterGroupIdentifier (string) –

      The id of the DB parameter group assigned to your DB instance.

    • availabilityZone (string) –

      The Availability Zone in which the DB instance resides.

    • secondaryAvailabilityZone (string) –

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

    • logDeliveryConfiguration (dict) –

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

      • s3Configuration (dict) –

        Configuration for S3 bucket log delivery.

        • bucketName (string) –

          The name of the S3 bucket to deliver logs to.

        • enabled (boolean) –

          Indicates whether log delivery to the S3 bucket is enabled.

    • influxAuthParametersSecretArn (string) –

      The Amazon Resource Name (ARN) of the AWS 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.

Exceptions