TimestreamInfluxDB / Client / update_db_cluster

update_db_cluster¶

TimestreamInfluxDB.Client.update_db_cluster(**kwargs)¶

Updates a Timestream for InfluxDB cluster.

Request Syntax

response = 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'
        },
    ]
)

Parameters:

dbClusterId (string) –
[REQUIRED]

Service-generated unique identifier of the DB cluster to update.
logDeliveryConfiguration (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.
dbParameterGroupIdentifier (string) – Update the DB cluster to use the specified DB parameter group.
port (integer) – Update the DB cluster to use the specified port.
dbInstanceType (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.
deploymentConfiguration (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.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: InfluxDBv3Enterprise.
- 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.
failoverMode (string) – Update the DB cluster’s failover behavior.
maintenanceSchedule (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.
dbBackupConfigurations (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.

Return type:

dict

Returns:

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.

update_db_cluster¶

Request Syntax

Note

Response Syntax

Response Structure

Exceptions