Class ModifyCacheClusterRequest

    • Constructor Detail

      • ModifyCacheClusterRequest

        public ModifyCacheClusterRequest()
        Default constructor for ModifyCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
      • ModifyCacheClusterRequest

        public ModifyCacheClusterRequest​(String cacheClusterId)
        Constructs a new ModifyCacheClusterRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
        Parameters:
        cacheClusterId - The cache cluster identifier. This value is stored as a lowercase string.
    • Method Detail

      • setCacheClusterId

        public void setCacheClusterId​(String cacheClusterId)

        The cache cluster identifier. This value is stored as a lowercase string.

        Parameters:
        cacheClusterId - The cache cluster identifier. This value is stored as a lowercase string.
      • getCacheClusterId

        public String getCacheClusterId()

        The cache cluster identifier. This value is stored as a lowercase string.

        Returns:
        The cache cluster identifier. This value is stored as a lowercase string.
      • withCacheClusterId

        public ModifyCacheClusterRequest withCacheClusterId​(String cacheClusterId)

        The cache cluster identifier. This value is stored as a lowercase string.

        Parameters:
        cacheClusterId - The cache cluster identifier. This value is stored as a lowercase string.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setNumCacheNodes

        public void setNumCacheNodes​(Integer numCacheNodes)

        The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

        If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

        For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

        Note:
        Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
        A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

        Parameters:
        numCacheNodes - The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

        If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

        For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

        Note:
        Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
        A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

      • getNumCacheNodes

        public Integer getNumCacheNodes()

        The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

        If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

        For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

        Note:
        Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
        A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

        Returns:
        The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

        If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

        For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

        Note:
        Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
        A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

      • withNumCacheNodes

        public ModifyCacheClusterRequest withNumCacheNodes​(Integer numCacheNodes)

        The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

        If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

        For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

        Note:
        Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
        A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

        Parameters:
        numCacheNodes - The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

        If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

        For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

        Note:
        Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
        A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getCacheNodeIdsToRemove

        public List<String> getCacheNodeIdsToRemove()

        A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

        For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

        Returns:
        A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

        For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

      • setCacheNodeIdsToRemove

        public void setCacheNodeIdsToRemove​(Collection<String> cacheNodeIdsToRemove)

        A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

        For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

        Parameters:
        cacheNodeIdsToRemove - A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

        For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

      • withCacheNodeIdsToRemove

        public ModifyCacheClusterRequest withCacheNodeIdsToRemove​(String... cacheNodeIdsToRemove)

        A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

        For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

        NOTE: This method appends the values to the existing list (if any). Use setCacheNodeIdsToRemove(java.util.Collection) or withCacheNodeIdsToRemove(java.util.Collection) if you want to override the existing values.

        Parameters:
        cacheNodeIdsToRemove - A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

        For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withCacheNodeIdsToRemove

        public ModifyCacheClusterRequest withCacheNodeIdsToRemove​(Collection<String> cacheNodeIdsToRemove)

        A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

        For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

        Parameters:
        cacheNodeIdsToRemove - A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

        For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAZMode

        public void setAZMode​(String aZMode)

        Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Parameters:
        aZMode - Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        See Also:
        AZMode
      • getAZMode

        public String getAZMode()

        Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Returns:
        Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        See Also:
        AZMode
      • withAZMode

        public ModifyCacheClusterRequest withAZMode​(String aZMode)

        Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Parameters:
        aZMode - Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AZMode
      • setAZMode

        public void setAZMode​(AZMode aZMode)

        Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Parameters:
        aZMode - Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        See Also:
        AZMode
      • withAZMode

        public ModifyCacheClusterRequest withAZMode​(AZMode aZMode)

        Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Parameters:
        aZMode - Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

        Valid values: single-az | cross-az.

        This option is only supported for Memcached cache clusters.

        You cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

        Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AZMode
      • getNewAvailabilityZones

        public List<String> getNewAvailabilityZones()

        The list of Availability Zones where the new Memcached cache nodes will be created.

        This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

        This option is only supported on Memcached clusters.

        Scenarios:

        • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
          Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
        • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
          Specify NumCacheNodes=6 ((3 + 2) + 1)
        • and optionally specify an Availability Zone for the new node.
        • Scenario 3: You want to cancel all pending actions.
          Specify NumCacheNodes=3 to cancel all pending actions.

        The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

        If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Impact of new add/remove requests upon pending requests

        • Scenario-1
          • Pending Action: Delete
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending delete.
        • Scenario-2
          • Pending Action: Delete
          • New Request: Create
          • Result: The new create, pending or immediate, replaces the pending delete.
        • Scenario-3
          • Pending Action: Create
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending create.
        • Scenario-4
          • Pending Action: Create
          • New Request: Create
          • Result: The new create is added to the pending create. Important:
            If the new create request is Apply Immediately - Yes, all creates are performed immediately.
            If the new create request is Apply Immediately - No, all creates are pending.

        Example:

        Returns:
        The list of Availability Zones where the new Memcached cache nodes will be created.

        This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

        This option is only supported on Memcached clusters.

        Scenarios:

        • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
          Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
        • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
          Specify NumCacheNodes=6 ((3 + 2) + 1)
        • and optionally specify an Availability Zone for the new node.
        • Scenario 3: You want to cancel all pending actions.
          Specify NumCacheNodes=3 to cancel all pending actions.

        The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

        If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Impact of new add/remove requests upon pending requests

        • Scenario-1
          • Pending Action: Delete
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending delete.
        • Scenario-2
          • Pending Action: Delete
          • New Request: Create
          • Result: The new create, pending or immediate, replaces the pending delete.
        • Scenario-3
          • Pending Action: Create
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending create.
        • Scenario-4
          • Pending Action: Create
          • New Request: Create
          • Result: The new create is added to the pending create. Important:
            If the new create request is Apply Immediately - Yes, all creates are performed immediately.
            If the new create request is Apply Immediately - No, all creates are pending.

        Example:

      • setNewAvailabilityZones

        public void setNewAvailabilityZones​(Collection<String> newAvailabilityZones)

        The list of Availability Zones where the new Memcached cache nodes will be created.

        This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

        This option is only supported on Memcached clusters.

        Scenarios:

        • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
          Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
        • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
          Specify NumCacheNodes=6 ((3 + 2) + 1)
        • and optionally specify an Availability Zone for the new node.
        • Scenario 3: You want to cancel all pending actions.
          Specify NumCacheNodes=3 to cancel all pending actions.

        The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

        If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Impact of new add/remove requests upon pending requests

        • Scenario-1
          • Pending Action: Delete
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending delete.
        • Scenario-2
          • Pending Action: Delete
          • New Request: Create
          • Result: The new create, pending or immediate, replaces the pending delete.
        • Scenario-3
          • Pending Action: Create
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending create.
        • Scenario-4
          • Pending Action: Create
          • New Request: Create
          • Result: The new create is added to the pending create. Important:
            If the new create request is Apply Immediately - Yes, all creates are performed immediately.
            If the new create request is Apply Immediately - No, all creates are pending.

        Example:

        Parameters:
        newAvailabilityZones - The list of Availability Zones where the new Memcached cache nodes will be created.

        This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

        This option is only supported on Memcached clusters.

        Scenarios:

        • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
          Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
        • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
          Specify NumCacheNodes=6 ((3 + 2) + 1)
        • and optionally specify an Availability Zone for the new node.
        • Scenario 3: You want to cancel all pending actions.
          Specify NumCacheNodes=3 to cancel all pending actions.

        The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

        If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Impact of new add/remove requests upon pending requests

        • Scenario-1
          • Pending Action: Delete
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending delete.
        • Scenario-2
          • Pending Action: Delete
          • New Request: Create
          • Result: The new create, pending or immediate, replaces the pending delete.
        • Scenario-3
          • Pending Action: Create
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending create.
        • Scenario-4
          • Pending Action: Create
          • New Request: Create
          • Result: The new create is added to the pending create. Important:
            If the new create request is Apply Immediately - Yes, all creates are performed immediately.
            If the new create request is Apply Immediately - No, all creates are pending.

        Example:

      • withNewAvailabilityZones

        public ModifyCacheClusterRequest withNewAvailabilityZones​(String... newAvailabilityZones)

        The list of Availability Zones where the new Memcached cache nodes will be created.

        This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

        This option is only supported on Memcached clusters.

        Scenarios:

        • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
          Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
        • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
          Specify NumCacheNodes=6 ((3 + 2) + 1)
        • and optionally specify an Availability Zone for the new node.
        • Scenario 3: You want to cancel all pending actions.
          Specify NumCacheNodes=3 to cancel all pending actions.

        The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

        If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Impact of new add/remove requests upon pending requests

        • Scenario-1
          • Pending Action: Delete
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending delete.
        • Scenario-2
          • Pending Action: Delete
          • New Request: Create
          • Result: The new create, pending or immediate, replaces the pending delete.
        • Scenario-3
          • Pending Action: Create
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending create.
        • Scenario-4
          • Pending Action: Create
          • New Request: Create
          • Result: The new create is added to the pending create. Important:
            If the new create request is Apply Immediately - Yes, all creates are performed immediately.
            If the new create request is Apply Immediately - No, all creates are pending.

        Example:

        NOTE: This method appends the values to the existing list (if any). Use setNewAvailabilityZones(java.util.Collection) or withNewAvailabilityZones(java.util.Collection) if you want to override the existing values.

        Parameters:
        newAvailabilityZones - The list of Availability Zones where the new Memcached cache nodes will be created.

        This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

        This option is only supported on Memcached clusters.

        Scenarios:

        • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
          Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
        • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
          Specify NumCacheNodes=6 ((3 + 2) + 1)
        • and optionally specify an Availability Zone for the new node.
        • Scenario 3: You want to cancel all pending actions.
          Specify NumCacheNodes=3 to cancel all pending actions.

        The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

        If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Impact of new add/remove requests upon pending requests

        • Scenario-1
          • Pending Action: Delete
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending delete.
        • Scenario-2
          • Pending Action: Delete
          • New Request: Create
          • Result: The new create, pending or immediate, replaces the pending delete.
        • Scenario-3
          • Pending Action: Create
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending create.
        • Scenario-4
          • Pending Action: Create
          • New Request: Create
          • Result: The new create is added to the pending create. Important:
            If the new create request is Apply Immediately - Yes, all creates are performed immediately.
            If the new create request is Apply Immediately - No, all creates are pending.

        Example:

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withNewAvailabilityZones

        public ModifyCacheClusterRequest withNewAvailabilityZones​(Collection<String> newAvailabilityZones)

        The list of Availability Zones where the new Memcached cache nodes will be created.

        This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

        This option is only supported on Memcached clusters.

        Scenarios:

        • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
          Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
        • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
          Specify NumCacheNodes=6 ((3 + 2) + 1)
        • and optionally specify an Availability Zone for the new node.
        • Scenario 3: You want to cancel all pending actions.
          Specify NumCacheNodes=3 to cancel all pending actions.

        The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

        If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Impact of new add/remove requests upon pending requests

        • Scenario-1
          • Pending Action: Delete
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending delete.
        • Scenario-2
          • Pending Action: Delete
          • New Request: Create
          • Result: The new create, pending or immediate, replaces the pending delete.
        • Scenario-3
          • Pending Action: Create
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending create.
        • Scenario-4
          • Pending Action: Create
          • New Request: Create
          • Result: The new create is added to the pending create. Important:
            If the new create request is Apply Immediately - Yes, all creates are performed immediately.
            If the new create request is Apply Immediately - No, all creates are pending.

        Example:

        Parameters:
        newAvailabilityZones - The list of Availability Zones where the new Memcached cache nodes will be created.

        This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

        This option is only supported on Memcached clusters.

        Scenarios:

        • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
          Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
        • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
          Specify NumCacheNodes=6 ((3 + 2) + 1)
        • and optionally specify an Availability Zone for the new node.
        • Scenario 3: You want to cancel all pending actions.
          Specify NumCacheNodes=3 to cancel all pending actions.

        The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

        If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

        Impact of new add/remove requests upon pending requests

        • Scenario-1
          • Pending Action: Delete
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending delete.
        • Scenario-2
          • Pending Action: Delete
          • New Request: Create
          • Result: The new create, pending or immediate, replaces the pending delete.
        • Scenario-3
          • Pending Action: Create
          • New Request: Delete
          • Result: The new delete, pending or immediate, replaces the pending create.
        • Scenario-4
          • Pending Action: Create
          • New Request: Create
          • Result: The new create is added to the pending create. Important:
            If the new create request is Apply Immediately - Yes, all creates are performed immediately.
            If the new create request is Apply Immediately - No, all creates are pending.

        Example:

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getCacheSecurityGroupNames

        public List<String> getCacheSecurityGroupNames()

        A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

        This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

        Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

        Returns:
        A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

        This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

        Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

      • setCacheSecurityGroupNames

        public void setCacheSecurityGroupNames​(Collection<String> cacheSecurityGroupNames)

        A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

        This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

        Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

        Parameters:
        cacheSecurityGroupNames - A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

        This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

        Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

      • withCacheSecurityGroupNames

        public ModifyCacheClusterRequest withCacheSecurityGroupNames​(String... cacheSecurityGroupNames)

        A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

        This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

        Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

        NOTE: This method appends the values to the existing list (if any). Use setCacheSecurityGroupNames(java.util.Collection) or withCacheSecurityGroupNames(java.util.Collection) if you want to override the existing values.

        Parameters:
        cacheSecurityGroupNames - A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

        This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

        Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withCacheSecurityGroupNames

        public ModifyCacheClusterRequest withCacheSecurityGroupNames​(Collection<String> cacheSecurityGroupNames)

        A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

        This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

        Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

        Parameters:
        cacheSecurityGroupNames - A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

        This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

        Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getSecurityGroupIds

        public List<String> getSecurityGroupIds()

        Specifies the VPC Security Groups associated with the cache cluster.

        This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

        Returns:
        Specifies the VPC Security Groups associated with the cache cluster.

        This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

      • setSecurityGroupIds

        public void setSecurityGroupIds​(Collection<String> securityGroupIds)

        Specifies the VPC Security Groups associated with the cache cluster.

        This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

        Parameters:
        securityGroupIds - Specifies the VPC Security Groups associated with the cache cluster.

        This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

      • withSecurityGroupIds

        public ModifyCacheClusterRequest withSecurityGroupIds​(String... securityGroupIds)

        Specifies the VPC Security Groups associated with the cache cluster.

        This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

        NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

        Parameters:
        securityGroupIds - Specifies the VPC Security Groups associated with the cache cluster.

        This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withSecurityGroupIds

        public ModifyCacheClusterRequest withSecurityGroupIds​(Collection<String> securityGroupIds)

        Specifies the VPC Security Groups associated with the cache cluster.

        This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

        Parameters:
        securityGroupIds - Specifies the VPC Security Groups associated with the cache cluster.

        This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setPreferredMaintenanceWindow

        public void setPreferredMaintenanceWindow​(String preferredMaintenanceWindow)

        Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

        Parameters:
        preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

      • getPreferredMaintenanceWindow

        public String getPreferredMaintenanceWindow()

        Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

        Returns:
        Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

      • withPreferredMaintenanceWindow

        public ModifyCacheClusterRequest withPreferredMaintenanceWindow​(String preferredMaintenanceWindow)

        Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

        Parameters:
        preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cache 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:05:00-sun:09:00

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setNotificationTopicArn

        public void setNotificationTopicArn​(String notificationTopicArn)

        The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the cache cluster owner.
        Parameters:
        notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the cache cluster owner.
      • getNotificationTopicArn

        public String getNotificationTopicArn()

        The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the cache cluster owner.
        Returns:
        The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the cache cluster owner.
      • withNotificationTopicArn

        public ModifyCacheClusterRequest withNotificationTopicArn​(String notificationTopicArn)

        The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the cache cluster owner.
        Parameters:
        notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the cache cluster owner.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCacheParameterGroupName

        public void setCacheParameterGroupName​(String cacheParameterGroupName)

        The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

        Parameters:
        cacheParameterGroupName - The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
      • getCacheParameterGroupName

        public String getCacheParameterGroupName()

        The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

        Returns:
        The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
      • withCacheParameterGroupName

        public ModifyCacheClusterRequest withCacheParameterGroupName​(String cacheParameterGroupName)

        The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

        Parameters:
        cacheParameterGroupName - The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setNotificationTopicStatus

        public void setNotificationTopicStatus​(String notificationTopicStatus)

        The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

        Valid values: active | inactive

        Parameters:
        notificationTopicStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

        Valid values: active | inactive

      • getNotificationTopicStatus

        public String getNotificationTopicStatus()

        The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

        Valid values: active | inactive

        Returns:
        The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

        Valid values: active | inactive

      • withNotificationTopicStatus

        public ModifyCacheClusterRequest withNotificationTopicStatus​(String notificationTopicStatus)

        The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

        Valid values: active | inactive

        Parameters:
        notificationTopicStatus - The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

        Valid values: active | inactive

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setApplyImmediately

        public void setApplyImmediately​(Boolean applyImmediately)

        If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

        If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

        If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

        Valid values: true | false

        Default: false

        Parameters:
        applyImmediately - If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

        If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

        If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

        Valid values: true | false

        Default: false

      • getApplyImmediately

        public Boolean getApplyImmediately()

        If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

        If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

        If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

        Valid values: true | false

        Default: false

        Returns:
        If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

        If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

        If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

        Valid values: true | false

        Default: false

      • withApplyImmediately

        public ModifyCacheClusterRequest withApplyImmediately​(Boolean applyImmediately)

        If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

        If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

        If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

        Valid values: true | false

        Default: false

        Parameters:
        applyImmediately - If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

        If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

        If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

        Valid values: true | false

        Default: false

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isApplyImmediately

        public Boolean isApplyImmediately()

        If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

        If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

        If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

        Valid values: true | false

        Default: false

        Returns:
        If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

        If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

        If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

        Valid values: true | false

        Default: false

      • setEngineVersion

        public void setEngineVersion​(String engineVersion)

        The upgraded version of the cache engine to be run on the cache nodes.

        Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.

        Parameters:
        engineVersion - The upgraded version of the cache engine to be run on the cache nodes.

        Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.

      • getEngineVersion

        public String getEngineVersion()

        The upgraded version of the cache engine to be run on the cache nodes.

        Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.

        Returns:
        The upgraded version of the cache engine to be run on the cache nodes.

        Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.

      • withEngineVersion

        public ModifyCacheClusterRequest withEngineVersion​(String engineVersion)

        The upgraded version of the cache engine to be run on the cache nodes.

        Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.

        Parameters:
        engineVersion - The upgraded version of the cache engine to be run on the cache nodes.

        Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cache cluster and create it anew with the earlier engine version.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAutoMinorVersionUpgrade

        public void setAutoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        This parameter is currently disabled.

        Parameters:
        autoMinorVersionUpgrade - This parameter is currently disabled.
      • getAutoMinorVersionUpgrade

        public Boolean getAutoMinorVersionUpgrade()

        This parameter is currently disabled.

        Returns:
        This parameter is currently disabled.
      • withAutoMinorVersionUpgrade

        public ModifyCacheClusterRequest withAutoMinorVersionUpgrade​(Boolean autoMinorVersionUpgrade)

        This parameter is currently disabled.

        Parameters:
        autoMinorVersionUpgrade - This parameter is currently disabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isAutoMinorVersionUpgrade

        public Boolean isAutoMinorVersionUpgrade()

        This parameter is currently disabled.

        Returns:
        This parameter is currently disabled.
      • setSnapshotRetentionLimit

        public void setSnapshotRetentionLimit​(Integer snapshotRetentionLimit)

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

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

        Parameters:
        snapshotRetentionLimit - The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

      • getSnapshotRetentionLimit

        public Integer getSnapshotRetentionLimit()

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

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

        Returns:
        The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

      • withSnapshotRetentionLimit

        public ModifyCacheClusterRequest withSnapshotRetentionLimit​(Integer snapshotRetentionLimit)

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

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

        Parameters:
        snapshotRetentionLimit - The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSnapshotWindow

        public void setSnapshotWindow​(String snapshotWindow)

        The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

        Parameters:
        snapshotWindow - The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
      • getSnapshotWindow

        public String getSnapshotWindow()

        The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

        Returns:
        The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
      • withSnapshotWindow

        public ModifyCacheClusterRequest withSnapshotWindow​(String snapshotWindow)

        The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

        Parameters:
        snapshotWindow - The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setCacheNodeType

        public void setCacheNodeType​(String cacheNodeType)

        A valid cache node type that you want to scale this cache cluster to. The value of this parameter must be one of the ScaleUpModifications values returned by the ListAllowedCacheNodeTypeModification action.

        Parameters:
        cacheNodeType - A valid cache node type that you want to scale this cache cluster to. The value of this parameter must be one of the ScaleUpModifications values returned by the ListAllowedCacheNodeTypeModification action.
      • getCacheNodeType

        public String getCacheNodeType()

        A valid cache node type that you want to scale this cache cluster to. The value of this parameter must be one of the ScaleUpModifications values returned by the ListAllowedCacheNodeTypeModification action.

        Returns:
        A valid cache node type that you want to scale this cache cluster to. The value of this parameter must be one of the ScaleUpModifications values returned by the ListAllowedCacheNodeTypeModification action.
      • withCacheNodeType

        public ModifyCacheClusterRequest withCacheNodeType​(String cacheNodeType)

        A valid cache node type that you want to scale this cache cluster to. The value of this parameter must be one of the ScaleUpModifications values returned by the ListAllowedCacheNodeTypeModification action.

        Parameters:
        cacheNodeType - A valid cache node type that you want to scale this cache cluster to. The value of this parameter must be one of the ScaleUpModifications values returned by the ListAllowedCacheNodeTypeModification action.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object