ElastiCache / Client / reboot_cache_cluster

reboot_cache_cluster

ElastiCache.Client.reboot_cache_cluster(**kwargs)

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached, Valkey and Redis OSS (cluster mode disabled) clusters. Rebooting is not supported on Valkey or Redis OSS (cluster mode enabled) clusters.

If you make changes to parameters that require a Valkey or Redis OSS (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

See also: AWS API Documentation

Request Syntax

response = client.reboot_cache_cluster(
    CacheClusterId='string',
    CacheNodeIdsToReboot=[
        'string',
    ]
)

Parameters:

• CacheClusterId (string) –

  [REQUIRED]

  The cluster identifier. This parameter is stored as a lowercase string.

• CacheNodeIdsToReboot (list) –

  [REQUIRED]

  A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'CacheCluster': {
        'CacheClusterId': 'string',
        'ConfigurationEndpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClientDownloadLandingPage': 'string',
        'CacheNodeType': 'string',
        'Engine': 'string',
        'EngineVersion': 'string',
        'CacheClusterStatus': 'string',
        'NumCacheNodes': 123,
        'PreferredAvailabilityZone': 'string',
        'PreferredOutpostArn': 'string',
        'CacheClusterCreateTime': datetime(2015, 1, 1),
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'NumCacheNodes': 123,
            'CacheNodeIdsToRemove': [
                'string',
            ],
            'EngineVersion': 'string',
            'CacheNodeType': 'string',
            'AuthTokenStatus': 'SETTING'|'ROTATING',
            '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'
        },
        'NotificationConfiguration': {
            'TopicArn': 'string',
            'TopicStatus': 'string'
        },
        'CacheSecurityGroups': [
            {
                'CacheSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'CacheParameterGroup': {
            'CacheParameterGroupName': 'string',
            'ParameterApplyStatus': 'string',
            'CacheNodeIdsToReboot': [
                'string',
            ]
        },
        'CacheSubnetGroupName': 'string',
        'CacheNodes': [
            {
                'CacheNodeId': 'string',
                'CacheNodeStatus': 'string',
                'CacheNodeCreateTime': datetime(2015, 1, 1),
                'Endpoint': {
                    'Address': 'string',
                    'Port': 123
                },
                'ParameterGroupStatus': 'string',
                'SourceCacheNodeId': 'string',
                'CustomerAvailabilityZone': 'string',
                'CustomerOutpostArn': 'string'
            },
        ],
        'AutoMinorVersionUpgrade': True|False,
        'SecurityGroups': [
            {
                'SecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ReplicationGroupId': 'string',
        'SnapshotRetentionLimit': 123,
        'SnapshotWindow': 'string',
        'AuthTokenEnabled': True|False,
        'AuthTokenLastModifiedDate': datetime(2015, 1, 1),
        'TransitEncryptionEnabled': True|False,
        'AtRestEncryptionEnabled': True|False,
        'ARN': 'string',
        'ReplicationGroupLogDeliveryEnabled': True|False,
        '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'
            },
        ],
        'NetworkType': 'ipv4'|'ipv6'|'dual_stack',
        'IpDiscovery': 'ipv4'|'ipv6',
        'TransitEncryptionMode': 'preferred'|'required'
    }
}

Response Structure

• (dict) –

  • CacheCluster (dict) –

    Contains all of the attributes of a specific cluster.

    • CacheClusterId (string) –

      The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

    • ConfigurationEndpoint (dict) –

      Represents a Memcached cluster endpoint which can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

      Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

      • Address (string) –

        The DNS hostname of the cache node.

      • Port (integer) –

        The port number that the cache engine is listening on.

    • ClientDownloadLandingPage (string) –

      The URL of the web page where you can download the latest ElastiCache client library.

    • CacheNodeType (string) –

      The name of the compute and memory capacity node type for the cluster.

      The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

      • General purpose:

        • Current generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

        Note

        For region availability, see Supported Node Types

        M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

      • Compute optimized:

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge

      • Memory optimized:

        • Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

        Note

        For region availability, see Supported Node Types

        R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

        • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

      Additional node type info

      • All current generation instance types are created in Amazon VPC by default.

      • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

      • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

      • The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

    • Engine (string) –

      The name of the cache engine ( memcached or redis) to be used for this cluster.

    • EngineVersion (string) –

      The version of the cache engine that is used in this cluster.

    • CacheClusterStatus (string) –

      The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

    • NumCacheNodes (integer) –

      The number of cache nodes in the cluster.

      For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

    • PreferredAvailabilityZone (string) –

      The name of the Availability Zone in which the cluster is located or “Multiple” if the cache nodes are located in different Availability Zones.

    • PreferredOutpostArn (string) –

      The outpost ARN in which the cache cluster is created.

    • CacheClusterCreateTime (datetime) –

      The date and time when the cluster was created.

    • PreferredMaintenanceWindow (string) –

      Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

      Valid values for ddd are:

      • sun

      • mon

      • tue

      • wed

      • thu

      • fri

      • sat

      Example: sun:23:00-mon:01:30

    • PendingModifiedValues (dict) –

      A group of settings that are applied to the cluster in the future, or that are currently being applied.

      • NumCacheNodes (integer) –

        The new number of cache nodes for the cluster.

        For clusters running Valkey or Redis OSS, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.

      • CacheNodeIdsToRemove (list) –

        A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

        • (string) –

      • EngineVersion (string) –

        The new cache engine version that the cluster runs.

      • CacheNodeType (string) –

        The cache node type that this cluster or replication group is scaled to.

      • AuthTokenStatus (string) –

        The auth token status

      • 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.

    • NotificationConfiguration (dict) –

      Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

      • TopicArn (string) –

        The Amazon Resource Name (ARN) that identifies the topic.

      • TopicStatus (string) –

        The current state of the topic.

    • CacheSecurityGroups (list) –

      A list of cache security group elements, composed of name and status sub-elements.

      • (dict) –

        Represents a cluster’s status within a particular cache security group.

        • CacheSecurityGroupName (string) –

          The name of the cache security group.

        • Status (string) –

          The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.

    • CacheParameterGroup (dict) –

      Status of the cache parameter group.

      • CacheParameterGroupName (string) –

        The name of the cache parameter group.

      • ParameterApplyStatus (string) –

        The status of parameter updates.

      • CacheNodeIdsToReboot (list) –

        A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

        • (string) –

    • CacheSubnetGroupName (string) –

      The name of the cache subnet group associated with the cluster.

    • CacheNodes (list) –

      A list of cache nodes that are members of the cluster.

      • (dict) –

        Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster’s protocol-compliant caching software - either Memcached, Valkey or Redis OSS.

        The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

        • General purpose:

          • Current generation: M7g node types: cache.m7g.large, cache.m7g.xlarge, cache.m7g.2xlarge, cache.m7g.4xlarge, cache.m7g.8xlarge, cache.m7g.12xlarge, cache.m7g.16xlarge

          Note

          For region availability, see Supported Node Types

          M6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis OSS engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

          • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

        • Compute optimized:

          • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge

        • Memory optimized:

          • Current generation: R7g node types: cache.r7g.large, cache.r7g.xlarge, cache.r7g.2xlarge, cache.r7g.4xlarge, cache.r7g.8xlarge, cache.r7g.12xlarge, cache.r7g.16xlarge

          Note

          For region availability, see Supported Node Types

          R6g node types (available only for Redis OSS engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

          • Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

        Additional node type info

        • All current generation instance types are created in Amazon VPC by default.

        • Valkey or Redis OSS append-only files (AOF) are not supported for T1 or T2 instances.

        • Valkey or Redis OSS Multi-AZ with automatic failover is not supported on T1 instances.

        • The configuration variables appendonly and appendfsync are not supported on Valkey, or on Redis OSS version 2.8.22 and later.

        • CacheNodeId (string) –

          The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer’s Amazon account.

        • CacheNodeStatus (string) –

          The current state of this cache node, one of the following values: available, creating, rebooting, or deleting.

        • CacheNodeCreateTime (datetime) –

          The date and time when the cache node was created.

        • Endpoint (dict) –

          The hostname for connecting to this cache node.

          • Address (string) –

            The DNS hostname of the cache node.

          • Port (integer) –

            The port number that the cache engine is listening on.

        • ParameterGroupStatus (string) –

          The status of the parameter group applied to this cache node.

        • SourceCacheNodeId (string) –

          The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

        • CustomerAvailabilityZone (string) –

          The Availability Zone where this node was created and now resides.

        • CustomerOutpostArn (string) –

          The customer outpost ARN of the cache node.

    • AutoMinorVersionUpgrade (boolean) –

      If you are running Valkey or Redis OSS engine version 6.0 or later, 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.

    • SecurityGroups (list) –

      A list of VPC Security Groups associated with the cluster.

      • (dict) –

        Represents a single cache security group and its status.

        • SecurityGroupId (string) –

          The identifier of the cache security group.

        • Status (string) –

          The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.

    • ReplicationGroupId (string) –

      The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

    • 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 cluster.

      Example: 05:00-09:00

    • 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 at-rest encryption 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

    • ARN (string) –

      The ARN (Amazon Resource Name) of the cache cluster.

    • ReplicationGroupLogDeliveryEnabled (boolean) –

      A boolean value indicating whether log delivery is enabled for the replication group.

    • 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.

    • 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 associated with the 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.

Exceptions

• ElastiCache.Client.exceptions.InvalidCacheClusterStateFault

• ElastiCache.Client.exceptions.CacheClusterNotFoundFault

Examples

Reboots the specified nodes in the names cluster.

response = client.reboot_cache_cluster(
    CacheClusterId='custom-mem1-4  ',
    CacheNodeIdsToReboot=[
        '0001',
        '0002',
    ],
)

print(response)

Expected Output:

{
    'CacheCluster': {
        'AutoMinorVersionUpgrade': True,
        'CacheClusterCreateTime': datetime(2016, 12, 21, 21, 59, 43, 2, 356, 0),
        'CacheClusterId': 'my-mem-cluster',
        'CacheClusterStatus': 'rebooting cache cluster nodes',
        'CacheNodeType': 'cache.t2.medium',
        'CacheParameterGroup': {
            'CacheNodeIdsToReboot': [
            ],
            'CacheParameterGroupName': 'default.memcached1.4',
            'ParameterApplyStatus': 'in-sync',
        },
        'CacheSecurityGroups': [
        ],
        'CacheSubnetGroupName': 'default',
        'ClientDownloadLandingPage': 'https://console.aws.amazon.com/elasticache/home#client-download:',
        'ConfigurationEndpoint': {
            'Address': 'my-mem-cluster.abcdef.cfg.use1.cache.amazonaws.com',
            'Port': 11211,
        },
        'Engine': 'memcached',
        'EngineVersion': '1.4.24',
        'NumCacheNodes': 2,
        'PendingModifiedValues': {
        },
        'PreferredAvailabilityZone': 'Multiple',
        'PreferredMaintenanceWindow': 'wed:06:00-wed:07:00',
    },
    'ResponseMetadata': {
        '...': '...',
    },
}