TimestreamInfluxDB / Client / delete_db_instance

delete_db_instance

TimestreamInfluxDB.Client.delete_db_instance(**kwargs)

Deletes a Timestream for InfluxDB DB instance.

See also: AWS API Documentation

Request Syntax

response = client.delete_db_instance(
    identifier='string'
)

Parameters:

identifier (string) –

[REQUIRED]

The id of the DB instance.

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',
    '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) –

    The customer-supplied name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and 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.

  • 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

• TimestreamInfluxDB.Client.exceptions.ValidationException

• TimestreamInfluxDB.Client.exceptions.AccessDeniedException

• TimestreamInfluxDB.Client.exceptions.InternalServerException

• TimestreamInfluxDB.Client.exceptions.ConflictException

• TimestreamInfluxDB.Client.exceptions.ResourceNotFoundException

• TimestreamInfluxDB.Client.exceptions.ThrottlingException