TimestreamInfluxDB / Client / get_db_cluster

get_db_cluster¶

TimestreamInfluxDB.Client.get_db_cluster(**kwargs)¶

Retrieves information about a Timestream for InfluxDB cluster.

Request Syntax

response = client.get_db_cluster(
    dbClusterId='string'
)

Parameters:

dbClusterId (string) –

[REQUIRED]

Service-generated unique identifier of the DB cluster to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'name': 'string',
    'arn': 'string',
    'status': 'CREATING'|'UPDATING'|'DELETING'|'AVAILABLE'|'FAILED'|'DELETED'|'MAINTENANCE'|'UPDATING_INSTANCE_TYPE'|'REBOOTING'|'REBOOT_FAILED'|'PARTIALLY_AVAILABLE'|'RESTORING'|'RESTORE_FAILED',
    'endpoint': 'string',
    'readerEndpoint': 'string',
    'port': 123,
    'deploymentType': 'MULTI_NODE_READ_REPLICAS',
    'dbInstanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
    'networkType': 'IPV4'|'DUAL',
    'dbStorageType': 'InfluxIOIncludedT1'|'InfluxIOIncludedT2'|'InfluxIOIncludedT3',
    'allocatedStorage': 123,
    'engineType': 'INFLUXDB_V2'|'INFLUXDB_V3_CORE'|'INFLUXDB_V3_ENTERPRISE',
    'publiclyAccessible': True|False,
    'dbParameterGroupIdentifier': 'string',
    'effectiveDbParameterGroupIdentifier': 'string',
    'logDeliveryConfiguration': {
        's3Configuration': {
            'bucketName': 'string',
            'enabled': True|False
        }
    },
    'maintenanceSchedule': {
        'timezone': 'string',
        'preferredMaintenanceWindow': 'string'
    },
    'lastMaintenanceTime': datetime(2015, 1, 1),
    'nextMaintenanceTime': datetime(2015, 1, 1),
    'influxAuthParametersSecretArn': 'string',
    'vpcSubnetIds': [
        'string',
    ],
    'vpcSecurityGroupIds': [
        'string',
    ],
    'failoverMode': 'AUTOMATIC'|'NO_FAILOVER',
    'clusterConfiguration': {
        'ingestQueryInstances': 123,
        'queryOnlyInstances': 123,
        'dedicatedCompactor': True|False
    },
    'deploymentConfiguration': {
        'InfluxDBv3Enterprise': {
            'nodeGroups': [
                {
                    'instanceModes': [
                        'PRIMARY'|'STANDBY'|'REPLICA'|'INGEST'|'QUERY'|'COMPACT'|'PROCESS',
                    ],
                    'instanceType': 'db.influx.medium'|'db.influx.large'|'db.influx.xlarge'|'db.influx.2xlarge'|'db.influx.4xlarge'|'db.influx.8xlarge'|'db.influx.12xlarge'|'db.influx.16xlarge'|'db.influx.24xlarge',
                    'count': 123
                },
            ]
        }
    },
    'dbBackupConfigurations': [
        {
            'type': 'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'CUSTOM_SCHEDULE'|'CONTINUOUS',
            'retentionDays': 123,
            'enabled': True|False,
            'customSchedule': 'string',
            'nextAutomatedBackupTime': datetime(2015, 1, 1)
        },
    ],
    'kmsKeyId': 'string'
}

Response Structure

(dict) –
- id (string) –
  
  Service-generated unique identifier of the DB cluster to retrieve.
- name (string) –
  
  Customer-supplied name of the Timestream for InfluxDB cluster.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the DB cluster.
- status (string) –
  
  The status of the DB cluster.
- endpoint (string) –
  
  The endpoint used to connect to the Timestream for InfluxDB cluster for write and read operations.
- readerEndpoint (string) –
  
  The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.
- port (integer) –
  
  The port number on which InfluxDB accepts connections.
- deploymentType (string) –
  
  Deployment type of the DB cluster.
- dbInstanceType (string) –
  
  The Timestream for InfluxDB instance type that InfluxDB runs on.
- networkType (string) –
  
  Specifies whether the network type of the Timestream for InfluxDB cluster is IPv4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols.
- dbStorageType (string) –
  
  The Timestream for InfluxDB DB storage type that InfluxDB stores data on.
- allocatedStorage (integer) –
  
  The amount of storage allocated for your DB storage type (in gibibytes).
- engineType (string) –
  
  The engine type of your DB cluster.
- publiclyAccessible (boolean) –
  
  Indicates if the DB cluster has a public IP to facilitate access from outside the VPC.
- dbParameterGroupIdentifier (string) –
  
  The ID of the DB parameter group assigned to your DB cluster.
- effectiveDbParameterGroupIdentifier (string) –
  
  The ID of the DB parameter group actually applied to your DB cluster. When the service applies optimized defaults, it creates a service-managed DB parameter group and this field reflects that group, while dbParameterGroupIdentifier reflects the customer-provided DB parameter group. When no service-managed DB parameter group is applied, this value matches dbParameterGroupIdentifier.
- logDeliveryConfiguration (dict) –
  
  Configuration for sending InfluxDB engine logs to send to specified S3 bucket.
  - s3Configuration (dict) –
    
    Configuration for S3 bucket log delivery.
    - bucketName (string) –
      
      The name of the S3 bucket to deliver logs to.
    - enabled (boolean) –
      
      Indicates whether log delivery to the S3 bucket is enabled.
- maintenanceSchedule (dict) –
  
  The maintenance schedule for the DB cluster.
  - timezone (string) –
    
    The IANA timezone identifier for the maintenance window. Format: Region/City or UTC. For example, America/New_York or UTC.
  - preferredMaintenanceWindow (string) –
    
    The preferred maintenance window in the format ddd:HH:MM-ddd:HH:MM (UTC). Day must be one of: Mon, Tue, Wed, Thu, Fri, Sat, Sun. For example, Sun:02:00-Sun:06:00. Provide an empty string to let the system choose a window.
- lastMaintenanceTime (datetime) –
  
  The timestamp of the last completed maintenance operation on the DB cluster.
- nextMaintenanceTime (datetime) –
  
  The timestamp of the next scheduled maintenance operation on the DB cluster.
- influxAuthParametersSecretArn (string) –
  
  The Amazon Resource Name (ARN) of the Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.
- vpcSubnetIds (list) –
  
  A list of VPC subnet IDs associated with the DB cluster.
  - (string) –
- vpcSecurityGroupIds (list) –
  
  A list of VPC security group IDs associated with the DB cluster.
  - (string) –
- failoverMode (string) –
  
  The configured failover mode for the DB cluster.
- clusterConfiguration (dict) –
  
  Configuration for node modes in the DbCluster.
  
  Deprecated. Use deploymentConfiguration to view the cluster topology instead.
  - ingestQueryInstances (integer) –
    
    The number of instances in the DbCluster which can both ingest and query.
  - queryOnlyInstances (integer) –
    
    The number of instances in the DbCluster which can only query.
  - dedicatedCompactor (boolean) –
    
    Indicates if the compactor instance is a standalone instance or not.
- deploymentConfiguration (dict) –
  
  The current compute topology of the cluster, as a set of node groups. The returned topology reflects the cluster’s actual provisioned nodes.
  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.
- 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.

get_db_cluster¶

Request Syntax

Response Syntax

Response Structure

Note

Exceptions