2025/02/17 - Timestream InfluxDB - 6 new4 updated api methods
Changes This release introduces APIs to manage DbClusters and adds support for read replicas
Deletes a Timestream for InfluxDB cluster.
See also: AWS API Documentation
Request Syntax
client.delete_db_cluster(
dbClusterId='string'
)
string
[REQUIRED]
Service-generated unique identifier of the DB cluster.
dict
Response Syntax
{
'dbClusterStatus': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED'
}
Response Structure
(dict) --
dbClusterStatus (string) --
The status of the DB cluster.
Retrieves information about a Timestream for InfluxDB cluster.
See also: AWS API Documentation
Request Syntax
client.get_db_cluster(
dbClusterId='string'
)
string
[REQUIRED]
Service-generated unique identifier of the DB cluster to retrieve.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED',
'endpoint': 'string',
'readerEndpoint': 'string',
'port': 123,
'deploymentType': 'MULTI_NODE_READ_REPLICAS',
'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',
'networkType': 'IPV4'|'DUAL',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'publiclyAccessible': True|False,
'dbParameterGroupIdentifier': 'string',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'influxAuthParametersSecretArn': 'string',
'vpcSubnetIds': [
'string',
],
'vpcSecurityGroupIds': [
'string',
],
'failoverMode': 'AUTOMATIC'|'NO_FAILOVER'
}
Response Structure
(dict) --
id (string) --
Service-generated unique identifier of the DB cluster to retrieve.
name (string) --
Customer-supplied name of the Timestream for InfluxDB cluster.
arn (string) --
The Amazon Resource Name (ARN) of the DB cluster.
status (string) --
The status of the DB cluster.
endpoint (string) --
The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
readerEndpoint (string) --
The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
port (integer) --
The port number on which InfluxDB accepts connections.
deploymentType (string) --
Deployment type of the DB cluster.
dbInstanceType (string) --
The Timestream for InfluxDB instance type that InfluxDB runs on.
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.
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).
publiclyAccessible (boolean) --
Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
dbParameterGroupIdentifier (string) --
The ID of the DB parameter group assigned to your DB cluster.
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 Amazon Web Services 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.
vpcSubnetIds (list) --
A list of VPC subnet IDs associated with the DB cluster.
(string) --
vpcSecurityGroupIds (list) --
A list of VPC security group IDs associated with the DB cluster.
(string) --
failoverMode (string) --
The configured failover mode for the DB cluster.
Creates a new Timestream for InfluxDB cluster.
See also: AWS API Documentation
Request Syntax
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'
}
)
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.
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 Amazon Web Services Secrets Manager in your account.
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 Amazon Web Services Secrets Manager in your account.
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.
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.
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
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.
string
[REQUIRED]
The Timestream for InfluxDB DB instance type to run InfluxDB on.
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
integer
[REQUIRED]
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
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.
boolean
Configures the Timestream for InfluxDB cluster with a public IP to facilitate access from outside the VPC.
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) --
list
[REQUIRED]
A list of VPC security group IDs to associate with the Timestream for InfluxDB cluster.
(string) --
string
[REQUIRED]
Specifies the type of cluster to create.
string
Specifies the behavior of failure recovery when the primary node of the cluster fails.
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.
dict
A list of key-value pairs to associate with the DB instance.
(string) --
(string) --
dict
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.
Returns a list of Timestream for InfluxDB clusters.
See also: AWS API Documentation
Request Syntax
client.list_db_instances_for_cluster(
dbClusterId='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
Service-generated unique identifier of the DB cluster.
string
The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
integer
The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE',
'endpoint': 'string',
'port': 123,
'networkType': 'IPV4'|'DUAL',
'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',
'instanceMode': 'PRIMARY'|'STANDBY'|'REPLICA'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of Timestream for InfluxDB instance summaries belonging to the cluster.
(dict) --
Contains a summary of a DB instance belonging to a DB cluster.
id (string) --
The service-generated unique identifier of the DB instance.
name (string) --
A service-generated name for the DB instance based on the customer-supplied name for the DB cluster.
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.
networkType (string) --
Specifies whether the network type 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.
dbInstanceType (string) --
The Timestream for InfluxDB instance type to run InfluxDB on.
dbStorageType (string) --
The storage type for your DB instance.
allocatedStorage (integer) --
The amount of storage allocated for your DB storage type in GiB (gibibytes).
deploymentType (string) --
Specifies the deployment type if applicable.
instanceMode (string) --
Specifies the DB instance's role in the cluster.
nextToken (string) --
Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
Updates a Timestream for InfluxDB cluster.
See also: AWS API Documentation
Request Syntax
client.update_db_cluster(
dbClusterId='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',
failoverMode='AUTOMATIC'|'NO_FAILOVER'
)
string
[REQUIRED]
Service-generated unique identifier of the DB cluster to update.
dict
The log delivery configuration to apply to the DB cluster.
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.
string
Update the DB cluster to use the specified DB parameter group.
integer
Update the DB cluster to use the specified port.
string
Update the DB cluster to use the specified DB instance Type.
string
Update the DB cluster's failover behavior.
dict
Response Syntax
{
'dbClusterStatus': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED'
}
Response Structure
(dict) --
dbClusterStatus (string) --
The status of the DB cluster.
Returns a list of Timestream for InfluxDB DB clusters.
See also: AWS API Documentation
Request Syntax
client.list_db_clusters(
nextToken='string',
maxResults=123
)
string
The pagination token. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
integer
The maximum number of items to return in the output. If the total number of items available is more than the value specified, a nextToken is provided in the output. To resume pagination, provide the nextToken value as an argument of a subsequent API invocation.
dict
Response Syntax
{
'items': [
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED',
'endpoint': 'string',
'readerEndpoint': 'string',
'port': 123,
'deploymentType': 'MULTI_NODE_READ_REPLICAS',
'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',
'networkType': 'IPV4'|'DUAL',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of Timestream for InfluxDB cluster summaries.
(dict) --
Describes a summary of a Timestream for InfluxDB cluster.
id (string) --
Service-generated unique identifier of the DB cluster to retrieve.
name (string) --
Customer supplied name of the Timestream for InfluxDB cluster.
arn (string) --
The Amazon Resource Name (ARN) of the DB cluster.
status (string) --
The status of the DB cluster.
endpoint (string) --
The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
readerEndpoint (string) --
The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
port (integer) --
The port number on which InfluxDB accepts connections.
deploymentType (string) --
Deployment type of the DB cluster
dbInstanceType (string) --
The Timestream for InfluxDB DB instance type that InfluxDB runs on.
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.
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).
nextToken (string) --
Token from a previous call of the operation. When this value is provided, the service returns results from where the previous response left off.
{'dbClusterId': 'string', 'instanceMode': 'PRIMARY | STANDBY | REPLICA'}
Creates a new Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
client.create_db_instance(
name='string',
username='string',
password='string',
organization='string',
bucket='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',
vpcSubnetIds=[
'string',
],
vpcSecurityGroupIds=[
'string',
],
publiclyAccessible=True|False,
dbStorageType='InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
allocatedStorage=123,
dbParameterGroupIdentifier='string',
deploymentType='SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
logDeliveryConfiguration={
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
tags={
'string': 'string'
},
port=123,
networkType='IPV4'|'DUAL'
)
string
[REQUIRED]
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.
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 Amazon Secrets Manager in your account.
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 Amazon Web Services SecretManager in your account.
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.
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.
string
[REQUIRED]
The Timestream for InfluxDB DB instance type to run InfluxDB on.
list
[REQUIRED]
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.
(string) --
list
[REQUIRED]
A list of VPC security group IDs to associate with the DB instance.
(string) --
boolean
Configures the DB instance with a public IP to facilitate access.
string
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
integer
[REQUIRED]
The amount of storage to allocate for your DB storage type in GiB (gibibytes).
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.
string
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
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.
dict
A list of key-value pairs to associate with the DB instance.
(string) --
(string) --
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
string
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.
dict
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,
'networkType': 'IPV4'|'DUAL',
'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',
'dbClusterId': 'string',
'instanceMode': 'PRIMARY'|'STANDBY'|'REPLICA'
}
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.
port (integer) --
The port number on which InfluxDB accepts connections. The default value is 8086.
networkType (string) --
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.
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 Amazon Web Services 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.
dbClusterId (string) --
Specifies the DbCluster to which this DbInstance belongs to.
instanceMode (string) --
Specifies the DbInstance's role in the cluster.
{'dbClusterId': 'string', 'instanceMode': 'PRIMARY | STANDBY | REPLICA'}
Deletes a Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
client.delete_db_instance(
identifier='string'
)
string
[REQUIRED]
The id of the DB instance.
dict
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,
'networkType': 'IPV4'|'DUAL',
'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',
'dbClusterId': 'string',
'instanceMode': 'PRIMARY'|'STANDBY'|'REPLICA'
}
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.
port (integer) --
The port number on which InfluxDB accepts connections.
networkType (string) --
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.
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 Amazon Web Services 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.
dbClusterId (string) --
Specifies the DbCluster to which this DbInstance belongs to.
instanceMode (string) --
Specifies the DbInstance's role in the cluster.
{'dbClusterId': 'string', 'instanceMode': 'PRIMARY | STANDBY | REPLICA'}
Returns a Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
client.get_db_instance(
identifier='string'
)
string
[REQUIRED]
The id of the DB instance.
dict
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,
'networkType': 'IPV4'|'DUAL',
'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',
'dbClusterId': 'string',
'instanceMode': 'PRIMARY'|'STANDBY'|'REPLICA'
}
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.
port (integer) --
The port number on which InfluxDB accepts connections.
networkType (string) --
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.
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 Amazon Web Services 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.
dbClusterId (string) --
Specifies the DbCluster to which this DbInstance belongs to.
instanceMode (string) --
Specifies the DbInstance's role in the cluster.
{'dbClusterId': 'string', 'instanceMode': 'PRIMARY | STANDBY | REPLICA'}
Updates a Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
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',
dbStorageType='InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
allocatedStorage=123
)
string
[REQUIRED]
The id of the DB instance.
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.
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.
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
string
The Timestream for InfluxDB DB instance type to run InfluxDB on.
string
Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.
string
The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
integer
The amount of storage to allocate for your DB storage type (in gibibytes).
dict
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,
'networkType': 'IPV4'|'DUAL',
'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',
'dbClusterId': 'string',
'instanceMode': 'PRIMARY'|'STANDBY'|'REPLICA'
}
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 Amazon Web Services 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.
networkType (string) --
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.
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 Amazon Web Services 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.
dbClusterId (string) --
Specifies the DbCluster to which this DbInstance belongs to.
instanceMode (string) --
Specifies the DbInstance's role in the cluster.