AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ModifyCacheClusterInput

import "github.com/aws/aws-sdk-go/service/elasticache"

type ModifyCacheClusterInput struct { AZMode *string `type:"string" enum:"AZMode"` ApplyImmediately *bool `type:"boolean"` AutoMinorVersionUpgrade *bool `type:"boolean"` CacheClusterId *string `type:"string" required:"true"` CacheNodeIdsToRemove []*string `locationNameList:"CacheNodeId" type:"list"` CacheNodeType *string `type:"string"` CacheParameterGroupName *string `type:"string"` CacheSecurityGroupNames []*string `locationNameList:"CacheSecurityGroupName" type:"list"` EngineVersion *string `type:"string"` NewAvailabilityZones []*string `locationNameList:"PreferredAvailabilityZone" type:"list"` NotificationTopicArn *string `type:"string"` NotificationTopicStatus *string `type:"string"` NumCacheNodes *int64 `type:"integer"` PreferredMaintenanceWindow *string `type:"string"` SecurityGroupIds []*string `locationNameList:"SecurityGroupId" type:"list"` SnapshotRetentionLimit *int64 `type:"integer"` SnapshotWindow *string `type:"string"` }

Represents the input of a ModifyCacheCluster operation.

AZMode

Type: *string

Specifies whether the new nodes in this Memcached 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 clusters.

You cannot specify single-az if the Memcached 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 are 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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNode.Memcached.html).

ApplyImmediately

Type: *bool

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

If false, changes to the 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

AutoMinorVersionUpgrade

Type: *bool

This parameter is currently disabled.

CacheClusterId

Type: *string

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

CacheClusterId is a required field

CacheNodeIdsToRemove

Type: []*string

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 ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

CacheNodeType

Type: *string

A valid cache node type that you want to scale this cluster up to.

CacheParameterGroupName

Type: *string

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

CacheSecurityGroupNames

Type: []*string

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

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

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

EngineVersion

Type: *string

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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

NewAvailabilityZones

Type: []*string

The list of Availability Zones where the new Memcached cache nodes are 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 operations. Specify NumCacheNodes=3 to cancel all pending operations.

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 (https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/CacheNode.Memcached.html).

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

Type: *string

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

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

NotificationTopicStatus

Type: *string

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

Valid values: active | inactive

NumCacheNodes

Type: *int64

The number of cache nodes that the 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), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, 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.

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

A pending operation 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 operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation 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 operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations 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 cluster.

PreferredMaintenanceWindow

Type: *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

SecurityGroupIds

Type: []*string

Specifies the VPC Security Groups associated with the cluster.

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

SnapshotRetentionLimit

Type: *int64

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.

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

SnapshotWindow

Type: *string

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

Method

GoString

func (s ModifyCacheClusterInput) GoString() string

GoString returns the string representation

SetAZMode

func (s *ModifyCacheClusterInput) SetAZMode(v string) *ModifyCacheClusterInput

SetAZMode sets the AZMode field's value.

SetApplyImmediately

func (s *ModifyCacheClusterInput) SetApplyImmediately(v bool) *ModifyCacheClusterInput

SetApplyImmediately sets the ApplyImmediately field's value.

SetAutoMinorVersionUpgrade

func (s *ModifyCacheClusterInput) SetAutoMinorVersionUpgrade(v bool) *ModifyCacheClusterInput

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

SetCacheClusterId

func (s *ModifyCacheClusterInput) SetCacheClusterId(v string) *ModifyCacheClusterInput

SetCacheClusterId sets the CacheClusterId field's value.

SetCacheNodeIdsToRemove

func (s *ModifyCacheClusterInput) SetCacheNodeIdsToRemove(v []*string) *ModifyCacheClusterInput

SetCacheNodeIdsToRemove sets the CacheNodeIdsToRemove field's value.

SetCacheNodeType

func (s *ModifyCacheClusterInput) SetCacheNodeType(v string) *ModifyCacheClusterInput

SetCacheNodeType sets the CacheNodeType field's value.

SetCacheParameterGroupName

func (s *ModifyCacheClusterInput) SetCacheParameterGroupName(v string) *ModifyCacheClusterInput

SetCacheParameterGroupName sets the CacheParameterGroupName field's value.

SetCacheSecurityGroupNames

func (s *ModifyCacheClusterInput) SetCacheSecurityGroupNames(v []*string) *ModifyCacheClusterInput

SetCacheSecurityGroupNames sets the CacheSecurityGroupNames field's value.

SetEngineVersion

func (s *ModifyCacheClusterInput) SetEngineVersion(v string) *ModifyCacheClusterInput

SetEngineVersion sets the EngineVersion field's value.

SetNewAvailabilityZones

func (s *ModifyCacheClusterInput) SetNewAvailabilityZones(v []*string) *ModifyCacheClusterInput

SetNewAvailabilityZones sets the NewAvailabilityZones field's value.

SetNotificationTopicArn

func (s *ModifyCacheClusterInput) SetNotificationTopicArn(v string) *ModifyCacheClusterInput

SetNotificationTopicArn sets the NotificationTopicArn field's value.

SetNotificationTopicStatus

func (s *ModifyCacheClusterInput) SetNotificationTopicStatus(v string) *ModifyCacheClusterInput

SetNotificationTopicStatus sets the NotificationTopicStatus field's value.

SetNumCacheNodes

func (s *ModifyCacheClusterInput) SetNumCacheNodes(v int64) *ModifyCacheClusterInput

SetNumCacheNodes sets the NumCacheNodes field's value.

SetPreferredMaintenanceWindow

func (s *ModifyCacheClusterInput) SetPreferredMaintenanceWindow(v string) *ModifyCacheClusterInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

SetSecurityGroupIds

func (s *ModifyCacheClusterInput) SetSecurityGroupIds(v []*string) *ModifyCacheClusterInput

SetSecurityGroupIds sets the SecurityGroupIds field's value.

SetSnapshotRetentionLimit

func (s *ModifyCacheClusterInput) SetSnapshotRetentionLimit(v int64) *ModifyCacheClusterInput

SetSnapshotRetentionLimit sets the SnapshotRetentionLimit field's value.

SetSnapshotWindow

func (s *ModifyCacheClusterInput) SetSnapshotWindow(v string) *ModifyCacheClusterInput

SetSnapshotWindow sets the SnapshotWindow field's value.

String

func (s ModifyCacheClusterInput) String() string

String returns the string representation

Validate

func (s *ModifyCacheClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: