TimestreamInfluxDB / Client / get_db_backup

get_db_backup¶

TimestreamInfluxDB.Client.get_db_backup(**kwargs)¶

Returns information about a specific Timestream for InfluxDB backup.

Request Syntax

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

Parameters:

identifier (string) –

[REQUIRED]

The identifier of the backup to retrieve information for.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'IN_PROGRESS'|'COMPLETED'|'FAILED'|'DELETING'|'DELETED',
    'createdAt': datetime(2015, 1, 1),
    'expiresAfter': 'string',
    'dbResourceId': 'string',
    'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'ON_DEMAND'|'CONTINUOUS',
    'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
    'deploymentType': 'SINGLE_AZ'|'WITH_MULTIAZ_STANDBY'|'MULTI_NODE_READ_REPLICAS',
    'kmsKeyId': 'string',
    'clusterConfiguration': {
        'ingestQueryInstances': 123,
        'queryOnlyInstances': 123,
        'dedicatedCompactor': True|False
    },
    'deploymentConfiguration': {
        'InfluxDBv3Enterprise': {
            'nodeGroups': [
                {
                    'instanceModes': [
                        'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
                    ],
                    'instanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
                    'count': 123
                },
            ]
        }
    },
    'dbParameterGroupId': 'string',
    'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
    'logDeliveryConfiguration': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'failoverMode': 'AUTOMATIC'|'NO_FAILOVER',
    'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    'allocatedStorage': 123,
    'vpcSubnetIds': [
        'string',
    ],
    'vpcSecurityGroupIds': [
        'string',
    ],
    'publiclyAccessible': True|False,
    'port': 123,
    'networkType': 'IPV4'|'DUAL',
    'influxAuthParametersSecretArn': 'string',
    'maintenanceSchedule': {
        'timezone': 'string',
        'preferredMaintenanceWindow': 'string'
    }
}

Response Structure

(dict) –
- id (string) –
  
  Service-generated unique identifier of the backup.
- name (string) –
  
  The customer-provided name of the backup.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the backup.
- status (string) –
  
  The current status of the backup.
- createdAt (datetime) –
  
  The time when the backup was created.
- expiresAfter (string) –
  
  The date after which the backup will be automatically deleted.
- dbResourceId (string) –
  
  The identifier of the DB resource that the backup was created from.
- type (string) –
  
  The type of backup.
- engineType (string) –
  
  The engine type of the resource that the backup was created from.
- deploymentType (string) –
  
  The deployment type of the resource that the backup was created from.
- kmsKeyId (string) –
  
  The Amazon Web Services KMS key ARN used for encryption of the resource at the time of backup.
- clusterConfiguration (dict) –
  
  The cluster configuration of the resource at the time of backup.
  
  Deprecated. Use deploymentConfiguration to view the cluster topology instead.
  - ingestQueryInstances (integer) –
    
    The number of instances in the DbCluster which can both ingest and query.
  - queryOnlyInstances (integer) –
    
    The number of instances in the DbCluster which can only query.
  - dedicatedCompactor (boolean) –
    
    Indicates if the compactor instance is a standalone instance or not.
- deploymentConfiguration (dict) –
  
  The deployment configuration of the resource at the time of backup.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: InfluxDBv3Enterprise. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - InfluxDBv3Enterprise (dict) –
    
    The deployment configuration for an InfluxDB 3 Enterprise cluster.
    - nodeGroups (list) –
      
      The node groups that make up the cluster. Across all node groups, the cluster must include 1 to 4 nodes with the INGEST mode, 0 to 14 nodes with the QUERY mode, and exactly one node with the COMPACT mode.
      - (dict) –
        
        A group of one or more nodes in a Timestream for InfluxDB cluster that share the same instance modes and instance type. A cluster’s compute topology is defined as a list of node groups.
        
        instanceModes (list) –
        
        The functions that the nodes in this group perform. Provide from 1 to 4 unique modes. Valid modes:
        
        INGEST – Nodes in this mode ingest data. Across all node groups, INGEST nodes must total between 1 and 4.
        
        QUERY – Nodes in this mode query data. Across all node groups, QUERY nodes must total between 0 and 14.
        
        COMPACT – Nodes in this mode compact data. Exactly one node across all node groups must have this mode. If the cluster has more than three non-compaction nodes, place the COMPACT node in its own dedicated node group.
        
        PROCESS – Nodes in this mode process data with the processing engine.
        
        (string) –
        
        instanceType (string) –
        
        The Timestream for InfluxDB DB instance type to run InfluxDB on for the nodes in this group.
        
        count (integer) –
        
        The number of nodes in this group. Valid values are 1 to 13.
- dbParameterGroupId (string) –
  
  The identifier of the DB parameter group associated with the backup.
- dbInstanceType (string) –
  
  The DB instance type of the resource at the time of backup.
- logDeliveryConfiguration (dict) –
  
  The log delivery configuration of the resource at the time of backup.
  - s3Configuration (dict) –
    
    Configuration for S3 bucket log delivery.
    - bucketName (string) –
      
      The name of the S3 bucket to deliver logs to.
    - enabled (boolean) –
      
      Indicates whether log delivery to the S3 bucket is enabled.
- failoverMode (string) –
  
  The failover mode of the resource at the time of backup.
- dbStorageType (string) –
  
  The storage type of the resource at the time of backup.
- allocatedStorage (integer) –
  
  The allocated storage of the resource at the time of backup, in GiB.
- vpcSubnetIds (list) –
  
  The VPC subnet IDs associated with the resource at the time of backup.
  - (string) –
- vpcSecurityGroupIds (list) –
  
  The VPC security group IDs associated with the resource at the time of backup.
  - (string) –
- publiclyAccessible (boolean) –
  
  Indicates whether the resource was publicly accessible at the time of backup.
- port (integer) –
  
  The port number of the resource at the time of backup.
- networkType (string) –
  
  The network type of the resource at the time of backup.
- influxAuthParametersSecretArn (string) –
  
  The ARN of the Secrets Manager secret containing the InfluxDB auth parameters.
- maintenanceSchedule (dict) –
  
  The maintenance schedule of the resource at the time of backup.
  - timezone (string) –
    
    The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
  - preferredMaintenanceWindow (string) –
    
    The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.

get_db_backup¶

Request Syntax

Response Syntax

Response Structure

Note

Exceptions