2026/10/30 - Timestream InfluxDB - 6 updated api methods
Changes Add DeploymentConfiguration field to CreateDbCluster and UpdateDbCluster APIs to support creation of heterogenous InfluxDB v3 Enterprise clusters.
{'deploymentConfiguration': {'InfluxDBv3Enterprise': {'nodeGroups': [{'count': 'integer',
'instanceModes': ['PRIMARY '
'| '
'STANDBY '
'| '
'REPLICA '
'| '
'INGEST '
'| '
'QUERY '
'| '
'COMPACT '
'| '
'PROCESS'],
'instanceType': 'db.influx.medium '
'| '
'db.influx.large '
'| '
'db.influx.xlarge '
'| '
'db.influx.2xlarge '
'| '
'db.influx.4xlarge '
'| '
'db.influx.8xlarge '
'| '
'db.influx.12xlarge '
'| '
'db.influx.16xlarge '
'| '
'db.influx.24xlarge'}]}}}
Creates a new on-demand backup of a Timestream for InfluxDB resource.
See also: AWS API Documentation
Request Syntax
client.create_db_backup(
name='string',
dbResourceId='string',
retentionDays=123,
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the backup. Must be unique within the account and region.
string
[REQUIRED]
The id of the DB instance or DB cluster to back up.
integer
The number of days to retain the backup. Valid values are 1 to 3650.
dict
A list of key-value pairs to associate with the backup.
(string) --
(string) --
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
'createdAt': datetime(2015, 1, 1),
'expiresAfter': 'string',
'dbResourceId': 'string',
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'ON_DEMAND'|'CONTINUOUS',
'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'|'MULTI_NODE_READ_REPLICAS',
'kmsKeyId': 'string',
'clusterConfiguration': {
'ingestQueryInstances': 123,
'queryOnlyInstances': 123,
'dedicatedCompactor': True|False
},
'deploymentConfiguration': {
'InfluxDBv3Enterprise': {
'nodeGroups': [
{
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'instanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
'count': 123
},
]
}
},
'dbParameterGroupId': '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'|'db.influx.24xlarge',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'failoverMode': 'AUTOMATIC'|'NO_FAILOVER',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'vpcSubnetIds': [
'string',
],
'vpcSecurityGroupIds': [
'string',
],
'publiclyAccessible': True|False,
'port': 123,
'networkType': 'IPV4'|'DUAL',
'influxAuthParametersSecretArn': 'string',
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
}
}
Response Structure
(dict) --
id (string) --
Service-generated unique identifier of the backup.
name (string) --
The customer-provided name of the backup.
arn (string) --
The Amazon Resource Name (ARN) of the backup.
status (string) --
The current status of the backup.
createdAt (datetime) --
The time when the backup was created.
expiresAfter (string) --
The date after which the backup will be automatically deleted.
dbResourceId (string) --
The identifier of the DB resource that the backup was created from.
type (string) --
The type of backup.
engineType (string) --
The engine type of the resource that the backup was created from.
deploymentType (string) --
The deployment type of the resource that the backup was created from.
kmsKeyId (string) --
The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.
clusterConfiguration (dict) --
The cluster configuration of the resource at the time of backup.
Deprecated. Use deploymentConfiguration to view the cluster topology instead.
ingestQueryInstances (integer) --
The number of instances in the DbCluster which can both ingest and query.
queryOnlyInstances (integer) --
The number of instances in the DbCluster which can only query.
dedicatedCompactor (boolean) --
Indicates if the compactor instance is a standalone instance or not.
deploymentConfiguration (dict) --
The deployment configuration of the resource at the time of backup.
InfluxDBv3Enterprise (dict) --
The deployment configuration for an InfluxDB 3 Enterprise cluster.
nodeGroups (list) --
The node groups that make up the cluster. Across all node groups, the cluster must include 1 to 4 nodes with the INGEST mode, 0 to 14 nodes with the QUERY mode, and exactly one node with the COMPACT mode.
(dict) --
A group of one or more nodes in a Timestream for InfluxDB cluster that share the same instance modes and instance type. A cluster's compute topology is defined as a list of node groups.
instanceModes (list) --
The functions that the nodes in this group perform. Provide from 1 to 4 unique modes. Valid modes:
INGEST – Nodes in this mode ingest data. Across all node groups, INGEST nodes must total between 1 and 4.
QUERY – Nodes in this mode query data. Across all node groups, QUERY nodes must total between 0 and 14.
COMPACT – Nodes in this mode compact data. Exactly one node across all node groups must have this mode. If the cluster has more than three non-compaction nodes, place the COMPACT node in its own dedicated node group.
PROCESS – Nodes in this mode process data with the processing engine.
(string) --
instanceType (string) --
The Timestream for InfluxDB DB instance type to run InfluxDB on for the nodes in this group.
count (integer) --
The number of nodes in this group. Valid values are 1 to 13.
dbParameterGroupId (string) --
The identifier of the DB parameter group associated with the backup.
dbInstanceType (string) --
The DB instance type of the resource at the time of backup.
logDeliveryConfiguration (dict) --
The log delivery configuration of the resource at the time of backup.
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.
failoverMode (string) --
The failover mode of the resource at the time of backup.
dbStorageType (string) --
The storage type of the resource at the time of backup.
allocatedStorage (integer) --
The allocated storage of the resource at the time of backup, in GiB.
vpcSubnetIds (list) --
The VPC subnet IDs associated with the resource at the time of backup.
(string) --
vpcSecurityGroupIds (list) --
The VPC security group IDs associated with the resource at the time of backup.
(string) --
publiclyAccessible (boolean) --
Indicates whether the resource was publicly accessible at the time of backup.
port (integer) --
The port number of the resource at the time of backup.
networkType (string) --
The network type of the resource at the time of backup.
influxAuthParametersSecretArn (string) --
The ARN of the Secrets Manager secret containing the InfluxDB auth parameters.
maintenanceSchedule (dict) --
The maintenance schedule of the resource at the time of backup.
timezone (string) --
The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
preferredMaintenanceWindow (string) --
The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
{'deploymentConfiguration': {'InfluxDBv3Enterprise': {'nodeGroups': [{'count': 'integer',
'instanceModes': ['PRIMARY '
'| '
'STANDBY '
'| '
'REPLICA '
'| '
'INGEST '
'| '
'QUERY '
'| '
'COMPACT '
'| '
'PROCESS'],
'instanceType': 'db.influx.medium '
'| '
'db.influx.large '
'| '
'db.influx.xlarge '
'| '
'db.influx.2xlarge '
'| '
'db.influx.4xlarge '
'| '
'db.influx.8xlarge '
'| '
'db.influx.12xlarge '
'| '
'db.influx.16xlarge '
'| '
'db.influx.24xlarge'}]}}}
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'|'db.influx.24xlarge',
dbStorageType='InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
allocatedStorage=123,
networkType='IPV4'|'DUAL',
publiclyAccessible=True|False,
vpcSubnetIds=[
'string',
],
vpcSecurityGroupIds=[
'string',
],
deploymentType='MULTI_NODE_READ_REPLICAS',
deploymentConfiguration={
'InfluxDBv3Enterprise': {
'nodeGroups': [
{
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'instanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
'count': 123
},
]
}
},
failoverMode='AUTOMATIC'|'NO_FAILOVER',
logDeliveryConfiguration={
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
maintenanceSchedule={
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
dbBackupConfigurations=[
{
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'CONTINUOUS',
'retentionDays': 123,
'enabled': True|False,
'customSchedule': 'string'
},
],
kmsKeyId='string',
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 Secrets Manager in your account.
string
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.
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 for InfluxDB v2, 8181 for InfluxDB v3
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
The Timestream for InfluxDB DB instance type to run InfluxDB on.
Optional when you define the cluster topology with deploymentConfiguration, because the instance type is then specified per node group.
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
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
Specifies the type of cluster to create.
dict
The compute topology for the cluster, defined as a set of node groups. Use deploymentConfiguration to allocate compute per function: ingest, query, compaction, and processing. A deployment configuration becomes the source of truth for the cluster's topology. Timestream for InfluxDB then ignores any node-count parameters in the associated DB parameter group.
InfluxDBv3Enterprise (dict) --
The deployment configuration for an InfluxDB 3 Enterprise cluster.
nodeGroups (list) -- [REQUIRED]
The node groups that make up the cluster. Across all node groups, the cluster must include 1 to 4 nodes with the INGEST mode, 0 to 14 nodes with the QUERY mode, and exactly one node with the COMPACT mode.
(dict) --
A group of one or more nodes in a Timestream for InfluxDB cluster that share the same instance modes and instance type. A cluster's compute topology is defined as a list of node groups.
instanceModes (list) -- [REQUIRED]
The functions that the nodes in this group perform. Provide from 1 to 4 unique modes. Valid modes:
INGEST – Nodes in this mode ingest data. Across all node groups, INGEST nodes must total between 1 and 4.
QUERY – Nodes in this mode query data. Across all node groups, QUERY nodes must total between 0 and 14.
COMPACT – Nodes in this mode compact data. Exactly one node across all node groups must have this mode. If the cluster has more than three non-compaction nodes, place the COMPACT node in its own dedicated node group.
PROCESS – Nodes in this mode process data with the processing engine.
(string) --
instanceType (string) -- [REQUIRED]
The Timestream for InfluxDB DB instance type to run InfluxDB on for the nodes in this group.
count (integer) -- [REQUIRED]
The number of nodes in this group. Valid values are 1 to 13.
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
Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone.
timezone (string) -- [REQUIRED]
The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
preferredMaintenanceWindow (string) -- [REQUIRED]
The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
list
A list of backup configurations to enable automated backups for the DB cluster.
(dict) --
Specifies the configuration for an automated backup schedule.
type (string) -- [REQUIRED]
The type of automated backup schedule. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, and CONTINUOUS.
retentionDays (integer) -- [REQUIRED]
The number of days to retain automated backups. Valid values are 1 to 365.
enabled (boolean) -- [REQUIRED]
Specifies whether this backup configuration is enabled.
customSchedule (string) --
A custom cron schedule expression for the backup. Required when type is CUSTOM_SCHEDULE.
string
The Amazon Web Services KMS key identifier to use for encryption of the DB cluster. Can be a key ID, key ARN, alias name, or alias ARN.
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'|'MAINTENANCE'|'UPDATING_INSTANCE_TYPE'|'REBOOTING'|'REBOOT_FAILED'|'PARTIALLY_AVAILABLE'|'RESTORING'|'RESTORE_FAILED'
}
Response Structure
(dict) --
dbClusterId (string) --
A service-generated unique identifier.
dbClusterStatus (string) --
The status of the DB cluster.
{'deploymentConfiguration': {'InfluxDBv3Enterprise': {'nodeGroups': [{'count': 'integer',
'instanceModes': ['PRIMARY '
'| '
'STANDBY '
'| '
'REPLICA '
'| '
'INGEST '
'| '
'QUERY '
'| '
'COMPACT '
'| '
'PROCESS'],
'instanceType': 'db.influx.medium '
'| '
'db.influx.large '
'| '
'db.influx.xlarge '
'| '
'db.influx.2xlarge '
'| '
'db.influx.4xlarge '
'| '
'db.influx.8xlarge '
'| '
'db.influx.12xlarge '
'| '
'db.influx.16xlarge '
'| '
'db.influx.24xlarge'}]}}}
Deletes a Timestream for InfluxDB backup.
See also: AWS API Documentation
Request Syntax
client.delete_db_backup(
identifier='string'
)
string
[REQUIRED]
The identifier of the backup to delete.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
'createdAt': datetime(2015, 1, 1),
'expiresAfter': 'string',
'dbResourceId': 'string',
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'ON_DEMAND'|'CONTINUOUS',
'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'|'MULTI_NODE_READ_REPLICAS',
'kmsKeyId': 'string',
'clusterConfiguration': {
'ingestQueryInstances': 123,
'queryOnlyInstances': 123,
'dedicatedCompactor': True|False
},
'deploymentConfiguration': {
'InfluxDBv3Enterprise': {
'nodeGroups': [
{
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'instanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
'count': 123
},
]
}
},
'dbParameterGroupId': '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'|'db.influx.24xlarge',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'failoverMode': 'AUTOMATIC'|'NO_FAILOVER',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'vpcSubnetIds': [
'string',
],
'vpcSecurityGroupIds': [
'string',
],
'publiclyAccessible': True|False,
'port': 123,
'networkType': 'IPV4'|'DUAL',
'influxAuthParametersSecretArn': 'string',
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
}
}
Response Structure
(dict) --
id (string) --
Service-generated unique identifier of the deleted backup.
name (string) --
The customer-provided name of the deleted backup.
arn (string) --
The Amazon Resource Name (ARN) of the deleted backup.
status (string) --
The current status of the backup.
createdAt (datetime) --
The time when the backup was created.
expiresAfter (string) --
The date after which the backup was set to be automatically deleted.
dbResourceId (string) --
The identifier of the DB resource that the backup was created from.
type (string) --
The type of backup.
engineType (string) --
The engine type of the resource that the backup was created from.
deploymentType (string) --
The deployment type of the resource that the backup was created from.
kmsKeyId (string) --
The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.
clusterConfiguration (dict) --
The cluster configuration of the resource at the time of backup.
Deprecated. Use deploymentConfiguration to view the cluster topology instead.
ingestQueryInstances (integer) --
The number of instances in the DbCluster which can both ingest and query.
queryOnlyInstances (integer) --
The number of instances in the DbCluster which can only query.
dedicatedCompactor (boolean) --
Indicates if the compactor instance is a standalone instance or not.
deploymentConfiguration (dict) --
The deployment configuration of the resource at the time of backup.
InfluxDBv3Enterprise (dict) --
The deployment configuration for an InfluxDB 3 Enterprise cluster.
nodeGroups (list) --
The node groups that make up the cluster. Across all node groups, the cluster must include 1 to 4 nodes with the INGEST mode, 0 to 14 nodes with the QUERY mode, and exactly one node with the COMPACT mode.
(dict) --
A group of one or more nodes in a Timestream for InfluxDB cluster that share the same instance modes and instance type. A cluster's compute topology is defined as a list of node groups.
instanceModes (list) --
The functions that the nodes in this group perform. Provide from 1 to 4 unique modes. Valid modes:
INGEST – Nodes in this mode ingest data. Across all node groups, INGEST nodes must total between 1 and 4.
QUERY – Nodes in this mode query data. Across all node groups, QUERY nodes must total between 0 and 14.
COMPACT – Nodes in this mode compact data. Exactly one node across all node groups must have this mode. If the cluster has more than three non-compaction nodes, place the COMPACT node in its own dedicated node group.
PROCESS – Nodes in this mode process data with the processing engine.
(string) --
instanceType (string) --
The Timestream for InfluxDB DB instance type to run InfluxDB on for the nodes in this group.
count (integer) --
The number of nodes in this group. Valid values are 1 to 13.
dbParameterGroupId (string) --
The identifier of the DB parameter group associated with the backup.
dbInstanceType (string) --
The DB instance type of the resource at the time of backup.
logDeliveryConfiguration (dict) --
The log delivery configuration of the resource at the time of backup.
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.
failoverMode (string) --
The failover mode of the resource at the time of backup.
dbStorageType (string) --
The storage type of the resource at the time of backup.
allocatedStorage (integer) --
The allocated storage of the resource at the time of backup, in GiB.
vpcSubnetIds (list) --
The VPC subnet IDs associated with the resource at the time of backup.
(string) --
vpcSecurityGroupIds (list) --
The VPC security group IDs associated with the resource at the time of backup.
(string) --
publiclyAccessible (boolean) --
Indicates whether the resource was publicly accessible at the time of backup.
port (integer) --
The port number of the resource at the time of backup.
networkType (string) --
The network type of the resource at the time of backup.
influxAuthParametersSecretArn (string) --
The ARN of the Secrets Manager secret containing the InfluxDB auth parameters.
maintenanceSchedule (dict) --
The maintenance schedule of the resource at the time of backup.
timezone (string) --
The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
preferredMaintenanceWindow (string) --
The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
{'deploymentConfiguration': {'InfluxDBv3Enterprise': {'nodeGroups': [{'count': 'integer',
'instanceModes': ['PRIMARY '
'| '
'STANDBY '
'| '
'REPLICA '
'| '
'INGEST '
'| '
'QUERY '
'| '
'COMPACT '
'| '
'PROCESS'],
'instanceType': 'db.influx.medium '
'| '
'db.influx.large '
'| '
'db.influx.xlarge '
'| '
'db.influx.2xlarge '
'| '
'db.influx.4xlarge '
'| '
'db.influx.8xlarge '
'| '
'db.influx.12xlarge '
'| '
'db.influx.16xlarge '
'| '
'db.influx.24xlarge'}]}}}
Returns information about a specific Timestream for InfluxDB backup.
See also: AWS API Documentation
Request Syntax
client.get_db_backup(
identifier='string'
)
string
[REQUIRED]
The identifier of the backup to retrieve information for.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
'createdAt': datetime(2015, 1, 1),
'expiresAfter': 'string',
'dbResourceId': 'string',
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'ON_DEMAND'|'CONTINUOUS',
'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'|'MULTI_NODE_READ_REPLICAS',
'kmsKeyId': 'string',
'clusterConfiguration': {
'ingestQueryInstances': 123,
'queryOnlyInstances': 123,
'dedicatedCompactor': True|False
},
'deploymentConfiguration': {
'InfluxDBv3Enterprise': {
'nodeGroups': [
{
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'instanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
'count': 123
},
]
}
},
'dbParameterGroupId': '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'|'db.influx.24xlarge',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'failoverMode': 'AUTOMATIC'|'NO_FAILOVER',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'vpcSubnetIds': [
'string',
],
'vpcSecurityGroupIds': [
'string',
],
'publiclyAccessible': True|False,
'port': 123,
'networkType': 'IPV4'|'DUAL',
'influxAuthParametersSecretArn': 'string',
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
}
}
Response Structure
(dict) --
id (string) --
Service-generated unique identifier of the backup.
name (string) --
The customer-provided name of the backup.
arn (string) --
The Amazon Resource Name (ARN) of the backup.
status (string) --
The current status of the backup.
createdAt (datetime) --
The time when the backup was created.
expiresAfter (string) --
The date after which the backup will be automatically deleted.
dbResourceId (string) --
The identifier of the DB resource that the backup was created from.
type (string) --
The type of backup.
engineType (string) --
The engine type of the resource that the backup was created from.
deploymentType (string) --
The deployment type of the resource that the backup was created from.
kmsKeyId (string) --
The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.
clusterConfiguration (dict) --
The cluster configuration of the resource at the time of backup.
Deprecated. Use deploymentConfiguration to view the cluster topology instead.
ingestQueryInstances (integer) --
The number of instances in the DbCluster which can both ingest and query.
queryOnlyInstances (integer) --
The number of instances in the DbCluster which can only query.
dedicatedCompactor (boolean) --
Indicates if the compactor instance is a standalone instance or not.
deploymentConfiguration (dict) --
The deployment configuration of the resource at the time of backup.
InfluxDBv3Enterprise (dict) --
The deployment configuration for an InfluxDB 3 Enterprise cluster.
nodeGroups (list) --
The node groups that make up the cluster. Across all node groups, the cluster must include 1 to 4 nodes with the INGEST mode, 0 to 14 nodes with the QUERY mode, and exactly one node with the COMPACT mode.
(dict) --
A group of one or more nodes in a Timestream for InfluxDB cluster that share the same instance modes and instance type. A cluster's compute topology is defined as a list of node groups.
instanceModes (list) --
The functions that the nodes in this group perform. Provide from 1 to 4 unique modes. Valid modes:
INGEST – Nodes in this mode ingest data. Across all node groups, INGEST nodes must total between 1 and 4.
QUERY – Nodes in this mode query data. Across all node groups, QUERY nodes must total between 0 and 14.
COMPACT – Nodes in this mode compact data. Exactly one node across all node groups must have this mode. If the cluster has more than three non-compaction nodes, place the COMPACT node in its own dedicated node group.
PROCESS – Nodes in this mode process data with the processing engine.
(string) --
instanceType (string) --
The Timestream for InfluxDB DB instance type to run InfluxDB on for the nodes in this group.
count (integer) --
The number of nodes in this group. Valid values are 1 to 13.
dbParameterGroupId (string) --
The identifier of the DB parameter group associated with the backup.
dbInstanceType (string) --
The DB instance type of the resource at the time of backup.
logDeliveryConfiguration (dict) --
The log delivery configuration of the resource at the time of backup.
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.
failoverMode (string) --
The failover mode of the resource at the time of backup.
dbStorageType (string) --
The storage type of the resource at the time of backup.
allocatedStorage (integer) --
The allocated storage of the resource at the time of backup, in GiB.
vpcSubnetIds (list) --
The VPC subnet IDs associated with the resource at the time of backup.
(string) --
vpcSecurityGroupIds (list) --
The VPC security group IDs associated with the resource at the time of backup.
(string) --
publiclyAccessible (boolean) --
Indicates whether the resource was publicly accessible at the time of backup.
port (integer) --
The port number of the resource at the time of backup.
networkType (string) --
The network type of the resource at the time of backup.
influxAuthParametersSecretArn (string) --
The ARN of the Secrets Manager secret containing the InfluxDB auth parameters.
maintenanceSchedule (dict) --
The maintenance schedule of the resource at the time of backup.
timezone (string) --
The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
preferredMaintenanceWindow (string) --
The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
{'deploymentConfiguration': {'InfluxDBv3Enterprise': {'nodeGroups': [{'count': 'integer',
'instanceModes': ['PRIMARY '
'| '
'STANDBY '
'| '
'REPLICA '
'| '
'INGEST '
'| '
'QUERY '
'| '
'COMPACT '
'| '
'PROCESS'],
'instanceType': 'db.influx.medium '
'| '
'db.influx.large '
'| '
'db.influx.xlarge '
'| '
'db.influx.2xlarge '
'| '
'db.influx.4xlarge '
'| '
'db.influx.8xlarge '
'| '
'db.influx.12xlarge '
'| '
'db.influx.16xlarge '
'| '
'db.influx.24xlarge'}]}}}
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'|'MAINTENANCE'|'UPDATING_INSTANCE_TYPE'|'REBOOTING'|'REBOOT_FAILED'|'PARTIALLY_AVAILABLE'|'RESTORING'|'RESTORE_FAILED',
'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'|'db.influx.24xlarge',
'networkType': 'IPV4'|'DUAL',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
'publiclyAccessible': True|False,
'dbParameterGroupIdentifier': 'string',
'effectiveDbParameterGroupIdentifier': 'string',
'logDeliveryConfiguration': {
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
'lastMaintenanceTime': datetime(2015, 1, 1),
'nextMaintenanceTime': datetime(2015, 1, 1),
'influxAuthParametersSecretArn': 'string',
'vpcSubnetIds': [
'string',
],
'vpcSecurityGroupIds': [
'string',
],
'failoverMode': 'AUTOMATIC'|'NO_FAILOVER',
'clusterConfiguration': {
'ingestQueryInstances': 123,
'queryOnlyInstances': 123,
'dedicatedCompactor': True|False
},
'deploymentConfiguration': {
'InfluxDBv3Enterprise': {
'nodeGroups': [
{
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'instanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
'count': 123
},
]
}
},
'dbBackupConfigurations': [
{
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'CONTINUOUS',
'retentionDays': 123,
'enabled': True|False,
'customSchedule': 'string',
'nextAutomatedBackupTime': datetime(2015, 1, 1)
},
],
'kmsKeyId': 'string'
}
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).
engineType (string) --
The engine type of your DB cluster.
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.
effectiveDbParameterGroupIdentifier (string) --
The ID of the DB parameter group actually applied to your DB cluster. When the service applies optimized defaults, it creates a service-managed DB parameter group and this field reflects that group, while dbParameterGroupIdentifier reflects the customer-provided DB parameter group. When no service-managed DB parameter group is applied, this value matches dbParameterGroupIdentifier.
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.
maintenanceSchedule (dict) --
The maintenance schedule for the DB cluster.
timezone (string) --
The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
preferredMaintenanceWindow (string) --
The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
lastMaintenanceTime (datetime) --
The timestamp of the last completed maintenance operation on the DB cluster.
nextMaintenanceTime (datetime) --
The timestamp of the next scheduled maintenance operation on the DB cluster.
influxAuthParametersSecretArn (string) --
The Amazon Resource Name (ARN) of the 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.
clusterConfiguration (dict) --
Configuration for node modes in the DbCluster.
Deprecated. Use deploymentConfiguration to view the cluster topology instead.
ingestQueryInstances (integer) --
The number of instances in the DbCluster which can both ingest and query.
queryOnlyInstances (integer) --
The number of instances in the DbCluster which can only query.
dedicatedCompactor (boolean) --
Indicates if the compactor instance is a standalone instance or not.
deploymentConfiguration (dict) --
The current compute topology of the cluster, as a set of node groups. The returned topology reflects the cluster's actual provisioned nodes.
InfluxDBv3Enterprise (dict) --
The deployment configuration for an InfluxDB 3 Enterprise cluster.
nodeGroups (list) --
The node groups that make up the cluster. Across all node groups, the cluster must include 1 to 4 nodes with the INGEST mode, 0 to 14 nodes with the QUERY mode, and exactly one node with the COMPACT mode.
(dict) --
A group of one or more nodes in a Timestream for InfluxDB cluster that share the same instance modes and instance type. A cluster's compute topology is defined as a list of node groups.
instanceModes (list) --
The functions that the nodes in this group perform. Provide from 1 to 4 unique modes. Valid modes:
INGEST – Nodes in this mode ingest data. Across all node groups, INGEST nodes must total between 1 and 4.
QUERY – Nodes in this mode query data. Across all node groups, QUERY nodes must total between 0 and 14.
COMPACT – Nodes in this mode compact data. Exactly one node across all node groups must have this mode. If the cluster has more than three non-compaction nodes, place the COMPACT node in its own dedicated node group.
PROCESS – Nodes in this mode process data with the processing engine.
(string) --
instanceType (string) --
The Timestream for InfluxDB DB instance type to run InfluxDB on for the nodes in this group.
count (integer) --
The number of nodes in this group. Valid values are 1 to 13.
dbBackupConfigurations (list) --
The backup configurations for the DB cluster.
(dict) --
Contains the configuration and status for an automated backup schedule.
type (string) --
The type of automated backup schedule.
retentionDays (integer) --
The number of days automated backups are retained.
enabled (boolean) --
Indicates whether this backup configuration is enabled.
customSchedule (string) --
The custom cron schedule expression for the backup, if applicable.
nextAutomatedBackupTime (datetime) --
The next scheduled time for an automated backup to be taken.
kmsKeyId (string) --
The Amazon Web Services KMS key ARN used for encryption of the DB cluster.
{'deploymentConfiguration': {'InfluxDBv3Enterprise': {'nodeGroups': [{'count': 'integer',
'instanceModes': ['PRIMARY '
'| '
'STANDBY '
'| '
'REPLICA '
'| '
'INGEST '
'| '
'QUERY '
'| '
'COMPACT '
'| '
'PROCESS'],
'instanceType': 'db.influx.medium '
'| '
'db.influx.large '
'| '
'db.influx.xlarge '
'| '
'db.influx.2xlarge '
'| '
'db.influx.4xlarge '
'| '
'db.influx.8xlarge '
'| '
'db.influx.12xlarge '
'| '
'db.influx.16xlarge '
'| '
'db.influx.24xlarge'}]}}}
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'|'db.influx.24xlarge',
deploymentConfiguration={
'InfluxDBv3Enterprise': {
'nodeGroups': [
{
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'instanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
'count': 123
},
]
}
},
failoverMode='AUTOMATIC'|'NO_FAILOVER',
maintenanceSchedule={
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
dbBackupConfigurations=[
{
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'CONTINUOUS',
'retentionDays': 123,
'enabled': True|False,
'customSchedule': 'string'
},
]
)
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.
You can't specify both dbInstanceType and deploymentConfiguration in the same request. When you use deploymentConfiguration, the instance type is specified per node group.
dict
The updated compute topology for the cluster, defined as a set of node groups. Use deploymentConfiguration to change the cluster's topology or scale its compute in a single call. You can't specify both deploymentConfiguration and dbInstanceType in the same request. When you provide a deployment configuration, Timestream for InfluxDB ignores any node-count parameters in the associated DB parameter group.
InfluxDBv3Enterprise (dict) --
The deployment configuration for an InfluxDB 3 Enterprise cluster.
nodeGroups (list) -- [REQUIRED]
The node groups that make up the cluster. Across all node groups, the cluster must include 1 to 4 nodes with the INGEST mode, 0 to 14 nodes with the QUERY mode, and exactly one node with the COMPACT mode.
(dict) --
A group of one or more nodes in a Timestream for InfluxDB cluster that share the same instance modes and instance type. A cluster's compute topology is defined as a list of node groups.
instanceModes (list) -- [REQUIRED]
The functions that the nodes in this group perform. Provide from 1 to 4 unique modes. Valid modes:
INGEST – Nodes in this mode ingest data. Across all node groups, INGEST nodes must total between 1 and 4.
QUERY – Nodes in this mode query data. Across all node groups, QUERY nodes must total between 0 and 14.
COMPACT – Nodes in this mode compact data. Exactly one node across all node groups must have this mode. If the cluster has more than three non-compaction nodes, place the COMPACT node in its own dedicated node group.
PROCESS – Nodes in this mode process data with the processing engine.
(string) --
instanceType (string) -- [REQUIRED]
The Timestream for InfluxDB DB instance type to run InfluxDB on for the nodes in this group.
count (integer) -- [REQUIRED]
The number of nodes in this group. Valid values are 1 to 13.
string
Update the DB cluster's failover behavior.
dict
Specifies the maintenance schedule for the DB cluster, including the preferred maintenance window and timezone.
timezone (string) -- [REQUIRED]
The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
preferredMaintenanceWindow (string) -- [REQUIRED]
The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
list
A list of backup configurations to update for the DB cluster.
(dict) --
Specifies the configuration for an automated backup schedule.
type (string) -- [REQUIRED]
The type of automated backup schedule. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, and CONTINUOUS.
retentionDays (integer) -- [REQUIRED]
The number of days to retain automated backups. Valid values are 1 to 365.
enabled (boolean) -- [REQUIRED]
Specifies whether this backup configuration is enabled.
customSchedule (string) --
A custom cron schedule expression for the backup. Required when type is CUSTOM_SCHEDULE.
dict
Response Syntax
{
'dbClusterStatus': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED'|'MAINTENANCE'|'UPDATING_INSTANCE_TYPE'|'REBOOTING'|'REBOOT_FAILED'|'PARTIALLY_AVAILABLE'|'RESTORING'|'RESTORE_FAILED'
}
Response Structure
(dict) --
dbClusterStatus (string) --
The status of the DB cluster.