2026/08/03 - Timestream InfluxDB - 5 new13 updated api methods
Changes This release adds support for customer-managed backup restore, and encryption of new DbInstances and DbClusters using customer-managed KMS keys.
Returns a list of Timestream for InfluxDB backups.
See also: AWS API Documentation
Request Syntax
client.list_db_backups(
dbResourceId='string',
nextToken='string',
maxResults=123
)
string
The identifier of the DB instance or DB cluster to list backups for. If not specified, returns all backups in the account and region.
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': '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'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of Timestream for InfluxDB backup summaries.
(dict) --
Contains a summary of a Timestream for InfluxDB backup.
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 status of the backup. Valid values are IN_PROGRESS, COMPLETED, FAILED, DELETING, and DELETED.
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. Valid values are HOURLY, DAILY, WEEKLY, MONTHLY, CUSTOM_SCHEDULE, ON_DEMAND, and CONTINUOUS.
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.
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.
Restores a Timestream for InfluxDB resource from a backup. By default, a new resource is created. You can optionally restore to the same resource using the REPLACE_EXISTING restore mode.
See also: AWS API Documentation
Request Syntax
client.restore_from_db_backup(
name='string',
dbBackupId='string',
restoreToTime=datetime(2015, 1, 1),
restoreMode='NEW_RESOURCE'|'REPLACE_EXISTING',
vpcSubnetIds=[
'string',
],
vpcSecurityGroupIds=[
'string',
],
publiclyAccessible=True|False,
logDeliveryConfiguration={
's3Configuration': {
'bucketName': 'string',
'enabled': True|False
}
},
maintenanceSchedule={
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
tags={
'string': 'string'
},
port=123,
networkType='IPV4'|'DUAL',
deploymentType='SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'|'MULTI_NODE_READ_REPLICAS',
dbBackupConfigurations=[
{
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'CONTINUOUS',
'retentionDays': 123,
'enabled': True|False,
'customSchedule': 'string'
},
],
kmsKeyId='string'
)
string
[REQUIRED]
The name of the new resource to create from the restore. If restoring to an existing resource, the name must match the existing resource name.
string
[REQUIRED]
The identifier of the backup to restore from.
datetime
The point in time to restore to, for continuous backups. Must be within the backup's retention window.
string
Specifies whether to restore to a new resource or replace the existing resource. Valid values are NEW_RESOURCE (default) and REPLACE_EXISTING.
list
A list of VPC subnet IDs for the restored resource. If not specified, the restored resource uses the same subnets as the backup.
(string) --
list
A list of VPC security group IDs for the restored resource. If not specified, the restored resource uses the same security groups as the backup.
(string) --
boolean
Specifies whether the restored resource is publicly accessible.
dict
Configuration for sending InfluxDB engine logs to the specified S3 bucket for the restored resource.
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
The maintenance schedule for the restored resource.
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.
dict
A list of key-value pairs to associate with the restored resource.
(string) --
(string) --
integer
The port number on which the restored InfluxDB resource accepts connections.
string
Specifies the network type of the restored resource. Valid values are IPV4 and DUAL.
string
Specifies the deployment type of the restored resource. Valid values are SINGLE_AZ, WITH_MULTIAZ_STANDBY, and MULTI_NODE_READ_REPLICAS.
list
A list of backup configurations to apply to the restored resource.
(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 restored resource. Can be a key ID, key ARN, alias name, or alias ARN.
dict
Response Syntax
{
'restoredDbResourceId': 'string',
'restoreStatus': 'RESTORING',
'resourceType': 'DB_INSTANCE'|'DB_CLUSTER',
'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'|'MULTI_NODE_READ_REPLICAS'
}
Response Structure
(dict) --
restoredDbResourceId (string) --
The identifier of the restored DB resource.
restoreStatus (string) --
The status of the restore operation.
resourceType (string) --
The type of the restored resource. Valid values are DB_INSTANCE and DB_CLUSTER.
engineType (string) --
The engine type of the restored resource.
deploymentType (string) --
The deployment type of the restored resource.
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
},
'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.
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.
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.
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
},
'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.
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.
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.
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
},
'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.
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.
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.
{'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}],
'kmsKeyId': 'string'}
Response {'dbClusterStatus': {'RESTORE_FAILED', 'RESTORING'}}
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',
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
[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
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.
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.
{'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}],
'kmsKeyId': 'string'}
Response {'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'nextAutomatedBackupTime': 'timestamp',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}],
'kmsKeyId': 'string',
'status': {'RESTORE_FAILED', 'RESTORING'}}
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'|'db.influx.24xlarge',
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
}
},
maintenanceSchedule={
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
tags={
'string': 'string'
},
port=123,
networkType='IPV4'|'DUAL',
dbBackupConfigurations=[
{
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'CONTINUOUS',
'retentionDays': 123,
'enabled': True|False,
'customSchedule': 'string'
},
],
kmsKeyId='string'
)
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 v2. 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.
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
Specifies the maintenance schedule for the DB instance, 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.
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.
list
A list of backup configurations to enable automated backups for the DB instance.
(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 instance. Can be a key ID, key ARN, alias name, or alias ARN.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE'|'MAINTENANCE'|'REBOOTING'|'REBOOT_FAILED'|'RESTORING'|'RESTORE_FAILED',
'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'|'db.influx.24xlarge',
'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'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
'lastMaintenanceTime': datetime(2015, 1, 1),
'nextMaintenanceTime': datetime(2015, 1, 1),
'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) --
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 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.
instanceModes (list) --
Specifies the DbInstance's roles in the cluster.
(string) --
maintenanceSchedule (dict) --
The maintenance schedule for the DB instance.
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 instance.
nextMaintenanceTime (datetime) --
The timestamp of the next scheduled maintenance operation on the DB instance.
dbBackupConfigurations (list) --
The backup configurations for the DB instance.
(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 instance.
{'retainAutomatedBackups': 'boolean'}
Response {'dbClusterStatus': {'RESTORE_FAILED', 'RESTORING'}}
Deletes a Timestream for InfluxDB cluster.
See also: AWS API Documentation
Request Syntax
client.delete_db_cluster(
dbClusterId='string',
retainAutomatedBackups=True|False
)
string
[REQUIRED]
Service-generated unique identifier of the DB cluster.
boolean
Specifies whether to retain automated backups after the DB cluster is deleted. If set to true, automated backups are not deleted and can be restored later.
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.
{'retainAutomatedBackups': 'boolean'}
Response {'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'nextAutomatedBackupTime': 'timestamp',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}],
'kmsKeyId': 'string',
'status': {'RESTORE_FAILED', 'RESTORING'}}
Deletes a Timestream for InfluxDB DB instance.
See also: AWS API Documentation
Request Syntax
client.delete_db_instance(
identifier='string',
retainAutomatedBackups=True|False
)
string
[REQUIRED]
The id of the DB instance.
boolean
Specifies whether to retain automated backups after the DB instance is deleted. If set to true, automated backups are not deleted and can be restored later.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE'|'MAINTENANCE'|'REBOOTING'|'REBOOT_FAILED'|'RESTORING'|'RESTORE_FAILED',
'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'|'db.influx.24xlarge',
'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'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
'lastMaintenanceTime': datetime(2015, 1, 1),
'nextMaintenanceTime': datetime(2015, 1, 1),
'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) --
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 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.
instanceModes (list) --
Specifies the DbInstance's roles in the cluster.
(string) --
maintenanceSchedule (dict) --
The maintenance schedule for the DB instance.
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 instance.
nextMaintenanceTime (datetime) --
The timestamp of the next scheduled maintenance operation on the DB instance.
dbBackupConfigurations (list) --
The backup configurations that were associated with the deleted DB instance.
(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 that was used for encryption of the deleted DB instance.
{'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'nextAutomatedBackupTime': 'timestamp',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}],
'kmsKeyId': 'string',
'status': {'RESTORE_FAILED', 'RESTORING'}}
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',
'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
},
'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.
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.
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.
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.
{'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'nextAutomatedBackupTime': 'timestamp',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}],
'kmsKeyId': 'string',
'status': {'RESTORE_FAILED', 'RESTORING'}}
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'|'MAINTENANCE'|'REBOOTING'|'REBOOT_FAILED'|'RESTORING'|'RESTORE_FAILED',
'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'|'db.influx.24xlarge',
'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'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
'lastMaintenanceTime': datetime(2015, 1, 1),
'nextMaintenanceTime': datetime(2015, 1, 1),
'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) --
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 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.
instanceModes (list) --
Specifies the DbInstance's roles in the cluster.
(string) --
maintenanceSchedule (dict) --
The maintenance schedule for the DB instance.
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 instance.
nextMaintenanceTime (datetime) --
The timestamp of the next scheduled maintenance operation on the DB instance.
dbBackupConfigurations (list) --
The backup configurations for the DB instance.
(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 instance.
{'items': {'status': {'RESTORE_FAILED', 'RESTORING'}}}
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'|'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'
},
],
'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).
engineType (string) --
The engine type of your DB 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.
{'items': {'status': {'RESTORE_FAILED', 'RESTORING'}}}
Returns a list of Timestream for InfluxDB DB instances.
See also: AWS API Documentation
Request Syntax
client.list_db_instances(
nextToken='string',
maxResults=123
)
string
The pagination token. To resume pagination, provide the NextToken value as 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 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'|'MAINTENANCE'|'REBOOTING'|'REBOOT_FAILED'|'RESTORING'|'RESTORE_FAILED',
'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'|'db.influx.24xlarge',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
items (list) --
A list of Timestream for InfluxDB DB instance summaries.
(dict) --
Contains a summary of a DB instance.
id (string) --
The service-generated unique identifier of the DB instance.
name (string) --
This customer-supplied name 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 to run InfluxDB on.
dbStorageType (string) --
The storage type for your DB instance.
allocatedStorage (integer) --
The amount of storage to allocate for your DbStorageType in GiB (gibibytes).
deploymentType (string) --
Single-Instance or with a MultiAZ Standby for High availability.
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.
{'items': {'status': {'RESTORE_FAILED', 'RESTORING'}}}
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'|'MAINTENANCE'|'REBOOTING'|'REBOOT_FAILED'|'RESTORING'|'RESTORE_FAILED',
'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'|'db.influx.24xlarge',
'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
'allocatedStorage': 123,
'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
'instanceMode': 'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
]
},
],
'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.
instanceModes (list) --
Specifies the DB instance's roles in the cluster.
(string) --
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.
{'dbClusterStatus': {'RESTORE_FAILED', 'RESTORING'}}
Reboots a Timestream for InfluxDB cluster.
See also: AWS API Documentation
Request Syntax
client.reboot_db_cluster(
dbClusterId='string',
instanceIds=[
'string',
]
)
string
[REQUIRED]
Service-generated unique identifier of the DB cluster to reboot.
list
A list of service-generated unique DB Instance Ids belonging to the DB Cluster to reboot.
(string) --
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.
{'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'nextAutomatedBackupTime': 'timestamp',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}],
'kmsKeyId': 'string',
'status': {'RESTORE_FAILED', 'RESTORING'}}
Reboots a Timestream for InfluxDB instance.
See also: AWS API Documentation
Request Syntax
client.reboot_db_instance(
identifier='string'
)
string
[REQUIRED]
The id of the DB instance to reboot.
dict
Response Syntax
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE'|'MAINTENANCE'|'REBOOTING'|'REBOOT_FAILED'|'RESTORING'|'RESTORE_FAILED',
'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'|'db.influx.24xlarge',
'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'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
'lastMaintenanceTime': datetime(2015, 1, 1),
'nextMaintenanceTime': datetime(2015, 1, 1),
'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) --
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 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.
instanceModes (list) --
Specifies the DbInstance's roles in the cluster.
(string) --
maintenanceSchedule (dict) --
The maintenance schedule for the DB instance.
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 instance.
nextMaintenanceTime (datetime) --
The timestamp of the next scheduled maintenance operation on the DB instance.
dbBackupConfigurations (list) --
The backup configurations for the DB instance.
(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 instance.
{'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}]}
Response {'dbClusterStatus': {'RESTORE_FAILED', 'RESTORING'}}
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',
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.
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.
{'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}]}
Response {'dbBackupConfigurations': [{'customSchedule': 'string',
'enabled': 'boolean',
'nextAutomatedBackupTime': 'timestamp',
'retentionDays': 'integer',
'type': 'HOURLY | DAILY | WEEKLY | MONTHLY | '
'CUSTOM_SCHEDULE | CONTINUOUS'}],
'kmsKeyId': 'string',
'status': {'RESTORE_FAILED', 'RESTORING'}}
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'|'db.influx.24xlarge',
deploymentType='SINGLE_AZ'|'WITH_MULTIAZ_STANDBY',
dbStorageType='InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
allocatedStorage=123,
maintenanceSchedule={
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
dbBackupConfigurations=[
{
'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'CONTINUOUS',
'retentionDays': 123,
'enabled': True|False,
'customSchedule': 'string'
},
]
)
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
Specifies the maintenance schedule for the DB instance, 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 instance.
(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
{
'id': 'string',
'name': 'string',
'arn': 'string',
'status': 'CREATING'|'AVAILABLE'|'DELETING'|'MODIFYING'|'UPDATING'|'DELETED'|'FAILED'|'UPDATING_DEPLOYMENT_TYPE'|'UPDATING_INSTANCE_TYPE'|'MAINTENANCE'|'REBOOTING'|'REBOOT_FAILED'|'RESTORING'|'RESTORE_FAILED',
'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'|'db.influx.24xlarge',
'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'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
'instanceModes': [
'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
],
'maintenanceSchedule': {
'timezone': 'string',
'preferredMaintenanceWindow': 'string'
},
'lastMaintenanceTime': datetime(2015, 1, 1),
'nextMaintenanceTime': datetime(2015, 1, 1),
'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) --
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 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 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.
instanceModes (list) --
Specifies the DbInstance's roles in the cluster.
(string) --
maintenanceSchedule (dict) --
The maintenance schedule for the DB instance.
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 instance.
nextMaintenanceTime (datetime) --
The timestamp of the next scheduled maintenance operation on the DB instance.
dbBackupConfigurations (list) --
The backup configurations for the DB instance.
(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 instance.