ElastiCache / Client / test_failover

test_failover

ElastiCache.Client.test_failover(**kwargs)

Represents the input of a TestFailover operation which tests automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

This API is designed for testing the behavior of your application in case of ElastiCache failover. It is not designed to be an operational tool for initiating a failover to overcome a problem you may have with the cluster. Moreover, in certain conditions such as large-scale operational events, Amazon may block this API.

Note the following

• A customer can use this operation to test automatic failover on up to 15 shards (called node groups in the ElastiCache API and Amazon CLI) in any rolling 24-hour period.

• If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

• If calling this operation multiple times on different shards in the same Valkey or Redis OSS (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

• To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the Amazon CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

  • Replication group message: Test Failover API called for node group <node-group-id>

  • Cache cluster message: Failover from primary node <primary-node-id> to replica node <node-id> completed

  • Replication group message: Failover from primary node <primary-node-id> to replica node <node-id> completed

  • Cache cluster message: Recovering cache nodes <node-id>

  • Cache cluster message: Finished recovery for cache nodes <node-id>

For more information see:

• Viewing ElastiCache Events in the ElastiCache User Guide

• DescribeEvents in the ElastiCache API Reference

Also see, Testing Multi-AZ in the ElastiCache User Guide.

See also: AWS API Documentation

Request Syntax

response = client.test_failover(
    ReplicationGroupId='string',
    NodeGroupId='string'
)

Parameters:

• ReplicationGroupId (string) –

  [REQUIRED]

  The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

• NodeGroupId (string) –

  [REQUIRED]

  The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 15 node groups in any rolling 24-hour period.

Return type:

dict

Returns:

Response Syntax

{
    'ReplicationGroup': {
        'ReplicationGroupId': 'string',
        'Description': 'string',
        'GlobalReplicationGroupInfo': {
            'GlobalReplicationGroupId': 'string',
            'GlobalReplicationGroupMemberRole': 'string'
        },
        'Status': 'string',
        'PendingModifiedValues': {
            'PrimaryClusterId': 'string',
            'AutomaticFailoverStatus': 'enabled'|'disabled',
            'Resharding': {
                'SlotMigration': {
                    'ProgressPercentage': 123.0
                }
            },
            'AuthTokenStatus': 'SETTING'|'ROTATING',
            'UserGroups': {
                'UserGroupIdsToAdd': [
                    'string',
                ],
                'UserGroupIdsToRemove': [
                    'string',
                ]
            },
            'LogDeliveryConfigurations': [
                {
                    'LogType': 'slow-log'|'engine-log',
                    'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
                    'DestinationDetails': {
                        'CloudWatchLogsDetails': {
                            'LogGroup': 'string'
                        },
                        'KinesisFirehoseDetails': {
                            'DeliveryStream': 'string'
                        }
                    },
                    'LogFormat': 'text'|'json'
                },
            ],
            'TransitEncryptionEnabled': True|False,
            'TransitEncryptionMode': 'preferred'|'required',
            'ClusterMode': 'enabled'|'disabled'|'compatible'
        },
        'MemberClusters': [
            'string',
        ],
        'NodeGroups': [
            {
                'NodeGroupId': 'string',
                'Status': 'string',
                'PrimaryEndpoint': {
                    'Address': 'string',
                    'Port': 123
                },
                'ReaderEndpoint': {
                    'Address': 'string',
                    'Port': 123
                },
                'Slots': 'string',
                'NodeGroupMembers': [
                    {
                        'CacheClusterId': 'string',
                        'CacheNodeId': 'string',
                        'ReadEndpoint': {
                            'Address': 'string',
                            'Port': 123
                        },
                        'PreferredAvailabilityZone': 'string',
                        'PreferredOutpostArn': 'string',
                        'CurrentRole': 'string'
                    },
                ]
            },
        ],
        'SnapshottingClusterId': 'string',
        'AutomaticFailover': 'enabled'|'disabled'|'enabling'|'disabling',
        'MultiAZ': 'enabled'|'disabled',
        'ConfigurationEndpoint': {
            'Address': 'string',
            'Port': 123
        },
        'SnapshotRetentionLimit': 123,
        'SnapshotWindow': 'string',
        'ClusterEnabled': True|False,
        'CacheNodeType': 'string',
        'AuthTokenEnabled': True|False,
        'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
        'TransitEncryptionEnabled': True|False,
        'AtRestEncryptionEnabled': True|False,
        'MemberClustersOutpostArns': [
            'string',
        ],
        'KmsKeyId': 'string',
        'ARN': 'string',
        'UserGroupIds': [
            'string',
        ],
        'LogDeliveryConfigurations': [
            {
                'LogType': 'slow-log'|'engine-log',
                'DestinationType': 'cloudwatch-logs'|'kinesis-firehose',
                'DestinationDetails': {
                    'CloudWatchLogsDetails': {
                        'LogGroup': 'string'
                    },
                    'KinesisFirehoseDetails': {
                        'DeliveryStream': 'string'
                    }
                },
                'LogFormat': 'text'|'json',
                'Status': 'active'|'enabling'|'modifying'|'disabling'|'error',
                'Message': 'string'
            },
        ],
        'ReplicationGroupCreateTime': datetime(2015, 1, 1),
        'DataTiering': 'enabled'|'disabled',
        'AutoMinorVersionUpgrade': True|False,
        'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
        'IpDiscovery': 'ipv4'|'ipv6',
        'TransitEncryptionMode': 'preferred'|'required',
        'ClusterMode': 'enabled'|'disabled'|'compatible',
        'Engine': 'string'
    }
}

Response Structure

• (dict) –

  • ReplicationGroup (dict) –

    Contains all of the attributes of a specific Valkey or Redis OSS replication group.

    • ReplicationGroupId (string) –

      The identifier for the replication group.

    • Description (string) –

      The user supplied description of the replication group.

    • GlobalReplicationGroupInfo (dict) –

      The name of the Global datastore and role of this replication group in the Global datastore.

      • GlobalReplicationGroupId (string) –

        The name of the Global datastore

      • GlobalReplicationGroupMemberRole (string) –

        The role of the replication group in a Global datastore. Can be primary or secondary.

    • Status (string) –

      The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

    • PendingModifiedValues (dict) –

      A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

      • PrimaryClusterId (string) –

        The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

      • AutomaticFailoverStatus (string) –

        Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

      • Resharding (dict) –

        The status of an online resharding operation.

        • SlotMigration (dict) –

          Represents the progress of an online resharding operation.

          • ProgressPercentage (float) –

            The percentage of the slot migration that is complete.

      • AuthTokenStatus (string) –

        The auth token status

      • UserGroups (dict) –

        The user group being modified.

        • UserGroupIdsToAdd (list) –

          The ID of the user group to add.

          • (string) –

        • UserGroupIdsToRemove (list) –

          The ID of the user group to remove.

          • (string) –

      • LogDeliveryConfigurations (list) –

        The log delivery configurations being modified

        • (dict) –

          The log delivery configurations being modified

          • LogType (string) –

            Refers to slow-log or engine-log..

          • DestinationType (string) –

            Returns the destination type, either CloudWatch Logs or Kinesis Data Firehose.

          • DestinationDetails (dict) –

            Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

            • CloudWatchLogsDetails (dict) –

              The configuration details of the CloudWatch Logs destination.

              • LogGroup (string) –

                The name of the CloudWatch Logs log group.

            • KinesisFirehoseDetails (dict) –

              The configuration details of the Kinesis Data Firehose destination.

              • DeliveryStream (string) –

                The name of the Kinesis Data Firehose delivery stream.

          • LogFormat (string) –

            Returns the log format, either JSON or TEXT

      • TransitEncryptionEnabled (boolean) –

        A flag that enables in-transit encryption when set to true.

      • TransitEncryptionMode (string) –

        A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

      • ClusterMode (string) –

        Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

    • MemberClusters (list) –

      The names of all the cache clusters that are part of this replication group.

      • (string) –

    • NodeGroups (list) –

      A list of node groups in this replication group. For Valkey or Redis OSS (cluster mode disabled) replication groups, this is a single-element list. For Valkey or Redis OSS (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

      • (dict) –

        Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

        • NodeGroupId (string) –

          The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

        • Status (string) –

          The current state of this replication group - creating, available, modifying, deleting.

        • PrimaryEndpoint (dict) –

          The endpoint of the primary node in this node group (shard).

          • Address (string) –

            The DNS hostname of the cache node.

          • Port (integer) –

            The port number that the cache engine is listening on.

        • ReaderEndpoint (dict) –

          The endpoint of the replica nodes in this node group (shard). This value is read-only.

          • Address (string) –

            The DNS hostname of the cache node.

          • Port (integer) –

            The port number that the cache engine is listening on.

        • Slots (string) –

          The keyspace for this node group (shard).

        • NodeGroupMembers (list) –

          A list containing information about individual nodes within the node group (shard).

          • (dict) –

            Represents a single node within a node group (shard).

            • CacheClusterId (string) –

              The ID of the cluster to which the node belongs.

            • CacheNodeId (string) –

              The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

            • ReadEndpoint (dict) –

              The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Valkey or Redis OSS (cluster mode disabled) clusters.

              • Address (string) –

                The DNS hostname of the cache node.

              • Port (integer) –

                The port number that the cache engine is listening on.

            • PreferredAvailabilityZone (string) –

              The name of the Availability Zone in which the node is located.

            • PreferredOutpostArn (string) –

              The outpost ARN of the node group member.

            • CurrentRole (string) –

              The role that is currently assigned to the node - primary or replica. This member is only applicable for Valkey or Redis OSS (cluster mode disabled) replication groups.

    • SnapshottingClusterId (string) –

      The cluster ID that is used as the daily snapshot source for the replication group.

    • AutomaticFailover (string) –

      Indicates the status of automatic failover for this Valkey or Redis OSS replication group.

    • MultiAZ (string) –

      A flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ

    • ConfigurationEndpoint (dict) –

      The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

      • Address (string) –

        The DNS hostname of the cache node.

      • Port (integer) –

        The port number that the cache engine is listening on.

    • SnapshotRetentionLimit (integer) –

      The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

      Warning

      If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

    • SnapshotWindow (string) –

      The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

      Example: 05:00-09:00

      If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

      Note

      This parameter is only valid if the Engine parameter is redis.

    • ClusterEnabled (boolean) –

      A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

      Valid values: true | false

    • CacheNodeType (string) –

      The name of the compute and memory capacity node type for each node in the replication group.

    • AuthTokenEnabled (boolean) –

      A flag that enables using an AuthToken (password) when issuing Valkey or Redis OSS commands.

      Default: false

    • AuthTokenLastModifiedDate (datetime) –

      The date the auth token was last modified

    • TransitEncryptionEnabled (boolean) –

      A flag that enables in-transit encryption when set to true.

      Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

      Default: false

    • AtRestEncryptionEnabled (boolean) –

      A flag that enables encryption at-rest when set to true.

      You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

      Required: Only available when creating a replication group in an Amazon VPC using Redis OSS version 3.2.6, 4.x or later.

      Default: false

    • MemberClustersOutpostArns (list) –

      The outpost ARNs of the replication group’s member clusters.

      • (string) –

    • KmsKeyId (string) –

      The ID of the KMS key used to encrypt the disk in the cluster.

    • ARN (string) –

      The ARN (Amazon Resource Name) of the replication group.

    • UserGroupIds (list) –

      The ID of the user group associated to the replication group.

      • (string) –

    • LogDeliveryConfigurations (list) –

      Returns the destination, format and type of the logs.

      • (dict) –

        Returns the destination, format and type of the logs.

        • LogType (string) –

          Refers to slow-log or engine-log.

        • DestinationType (string) –

          Returns the destination type, either cloudwatch-logs or kinesis-firehose.

        • DestinationDetails (dict) –

          Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.

          • CloudWatchLogsDetails (dict) –

            The configuration details of the CloudWatch Logs destination.

            • LogGroup (string) –

              The name of the CloudWatch Logs log group.

          • KinesisFirehoseDetails (dict) –

            The configuration details of the Kinesis Data Firehose destination.

            • DeliveryStream (string) –

              The name of the Kinesis Data Firehose delivery stream.

        • LogFormat (string) –

          Returns the log format, either JSON or TEXT.

        • Status (string) –

          Returns the log delivery configuration status. Values are one of enabling | disabling | modifying | active | error

        • Message (string) –

          Returns an error message for the log delivery configuration.

    • ReplicationGroupCreateTime (datetime) –

      The date and time when the cluster was created.

    • DataTiering (string) –

      Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering.

    • AutoMinorVersionUpgrade (boolean) –

      If you are running Valkey 7.2 and above, or Redis OSS engine version 6.0 and above, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.

    • NetworkType (string) –

      Must be either ipv4 | ipv6 | dual_stack. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    • IpDiscovery (string) –

      The network type you choose when modifying a cluster, either ipv4 | ipv6. IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the Nitro system.

    • TransitEncryptionMode (string) –

      A setting that allows you to migrate your clients to use in-transit encryption, with no downtime.

    • ClusterMode (string) –

      Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled.

    • Engine (string) –

      The engine used in a replication group. The options are redis, memcached or valkey.

Exceptions

• ElastiCache.Client.exceptions.APICallRateForCustomerExceededFault

• ElastiCache.Client.exceptions.InvalidCacheClusterStateFault

• ElastiCache.Client.exceptions.InvalidReplicationGroupStateFault

• ElastiCache.Client.exceptions.NodeGroupNotFoundFault

• ElastiCache.Client.exceptions.ReplicationGroupNotFoundFault

• ElastiCache.Client.exceptions.TestFailoverNotAvailableFault

• ElastiCache.Client.exceptions.InvalidKMSKeyFault

• ElastiCache.Client.exceptions.InvalidParameterValueException

• ElastiCache.Client.exceptions.InvalidParameterCombinationException