com.amazonaws.services.elasticache.model

Class ModifyReplicationGroupRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticache.model.ModifyReplicationGroupRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyReplicationGroupRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Represents the input of a ModifyReplicationGroups operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyReplicationGroupRequest()

Method Summary

Modifier and Type	Method and Description
ModifyReplicationGroupRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
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 replication group.
Boolean	getAutomaticFailoverEnabled() Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Boolean	getAutoMinorVersionUpgrade() This parameter is currently disabled.
String	getCacheNodeType() A valid cache node type that you want to scale this replication group to.
String	getCacheParameterGroupName() The name of the cache parameter group to apply to all of the clusters in this replication group.
List<String>	getCacheSecurityGroupNames() A list of cache security group names to authorize for the clusters in this replication group.
String	getEngineVersion() The upgraded version of the cache engine to be run on the cache clusters in the replication group.
String	getNodeGroupId() The name of the Node Group (called shard in the console).
String	getNotificationTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
String	getNotificationTopicStatus() The status of the Amazon SNS notification topic for the replication group.
String	getPreferredMaintenanceWindow() Specifies the weekly time range during which maintenance on the cluster is performed.
String	getPrimaryClusterId() For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role.
String	getReplicationGroupDescription() A description for the replication group.
String	getReplicationGroupId() The identifier of the replication group to modify.
List<String>	getSecurityGroupIds() Specifies the VPC Security Groups associated with the cache clusters in the replication group.
Integer	getSnapshotRetentionLimit() The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them.
String	getSnapshottingClusterId() The cache cluster ID that is used as the daily snapshot source for the replication group.
String	getSnapshotWindow() The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.
int	hashCode()
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 replication group.
Boolean	isAutomaticFailoverEnabled() Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
Boolean	isAutoMinorVersionUpgrade() This parameter is currently disabled.
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 replication group.
void	setAutomaticFailoverEnabled(Boolean automaticFailoverEnabled) Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
void	setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) This parameter is currently disabled.
void	setCacheNodeType(String cacheNodeType) A valid cache node type that you want to scale this replication group to.
void	setCacheParameterGroupName(String cacheParameterGroupName) The name of the cache parameter group to apply to all of the clusters in this replication group.
void	setCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames) A list of cache security group names to authorize for the clusters in this replication group.
void	setEngineVersion(String engineVersion) The upgraded version of the cache engine to be run on the cache clusters in the replication group.
void	setNodeGroupId(String nodeGroupId) The name of the Node Group (called shard in the console).
void	setNotificationTopicArn(String notificationTopicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
void	setNotificationTopicStatus(String notificationTopicStatus) The status of the Amazon SNS notification topic for the replication group.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cluster is performed.
void	setPrimaryClusterId(String primaryClusterId) For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role.
void	setReplicationGroupDescription(String replicationGroupDescription) A description for the replication group.
void	setReplicationGroupId(String replicationGroupId) The identifier of the replication group to modify.
void	setSecurityGroupIds(Collection<String> securityGroupIds) Specifies the VPC Security Groups associated with the cache clusters in the replication group.
void	setSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them.
void	setSnapshottingClusterId(String snapshottingClusterId) The cache cluster ID that is used as the daily snapshot source for the replication group.
void	setSnapshotWindow(String snapshotWindow) The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ModifyReplicationGroupRequest	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 replication group.
ModifyReplicationGroupRequest	withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled) Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.
ModifyReplicationGroupRequest	withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade) This parameter is currently disabled.
ModifyReplicationGroupRequest	withCacheNodeType(String cacheNodeType) A valid cache node type that you want to scale this replication group to.
ModifyReplicationGroupRequest	withCacheParameterGroupName(String cacheParameterGroupName) The name of the cache parameter group to apply to all of the clusters in this replication group.
ModifyReplicationGroupRequest	withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames) A list of cache security group names to authorize for the clusters in this replication group.
ModifyReplicationGroupRequest	withCacheSecurityGroupNames(String... cacheSecurityGroupNames) A list of cache security group names to authorize for the clusters in this replication group.
ModifyReplicationGroupRequest	withEngineVersion(String engineVersion) The upgraded version of the cache engine to be run on the cache clusters in the replication group.
ModifyReplicationGroupRequest	withNodeGroupId(String nodeGroupId) The name of the Node Group (called shard in the console).
ModifyReplicationGroupRequest	withNotificationTopicArn(String notificationTopicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.
ModifyReplicationGroupRequest	withNotificationTopicStatus(String notificationTopicStatus) The status of the Amazon SNS notification topic for the replication group.
ModifyReplicationGroupRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) Specifies the weekly time range during which maintenance on the cluster is performed.
ModifyReplicationGroupRequest	withPrimaryClusterId(String primaryClusterId) For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role.
ModifyReplicationGroupRequest	withReplicationGroupDescription(String replicationGroupDescription) A description for the replication group.
ModifyReplicationGroupRequest	withReplicationGroupId(String replicationGroupId) The identifier of the replication group to modify.
ModifyReplicationGroupRequest	withSecurityGroupIds(Collection<String> securityGroupIds) Specifies the VPC Security Groups associated with the cache clusters in the replication group.
ModifyReplicationGroupRequest	withSecurityGroupIds(String... securityGroupIds) Specifies the VPC Security Groups associated with the cache clusters in the replication group.
ModifyReplicationGroupRequest	withSnapshotRetentionLimit(Integer snapshotRetentionLimit) The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them.
ModifyReplicationGroupRequest	withSnapshottingClusterId(String snapshottingClusterId) The cache cluster ID that is used as the daily snapshot source for the replication group.
ModifyReplicationGroupRequest	withSnapshotWindow(String snapshotWindow) The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyReplicationGroupRequest

public ModifyReplicationGroupRequest()

Method Detail

setReplicationGroupId

public void setReplicationGroupId(String replicationGroupId)

The identifier of the replication group to modify.

Parameters:

replicationGroupId - The identifier of the replication group to modify.

getReplicationGroupId

public String getReplicationGroupId()

The identifier of the replication group to modify.

Returns:

The identifier of the replication group to modify.

withReplicationGroupId

public ModifyReplicationGroupRequest withReplicationGroupId(String replicationGroupId)

The identifier of the replication group to modify.

Parameters:

replicationGroupId - The identifier of the replication group to modify.

Returns:

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

setReplicationGroupDescription

public void setReplicationGroupDescription(String replicationGroupDescription)

A description for the replication group. Maximum length is 255 characters.

Parameters:

replicationGroupDescription - A description for the replication group. Maximum length is 255 characters.

getReplicationGroupDescription

public String getReplicationGroupDescription()

A description for the replication group. Maximum length is 255 characters.

Returns:

A description for the replication group. Maximum length is 255 characters.

withReplicationGroupDescription

public ModifyReplicationGroupRequest withReplicationGroupDescription(String replicationGroupDescription)

A description for the replication group. Maximum length is 255 characters.

Parameters:

replicationGroupDescription - A description for the replication group. Maximum length is 255 characters.

Returns:

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

setPrimaryClusterId

public void setPrimaryClusterId(String primaryClusterId)

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Parameters:

primaryClusterId - For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

getPrimaryClusterId

public String getPrimaryClusterId()

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Returns:

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

withPrimaryClusterId

public ModifyReplicationGroupRequest withPrimaryClusterId(String primaryClusterId)

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Parameters:

primaryClusterId - For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

Returns:

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

setSnapshottingClusterId

public void setSnapshottingClusterId(String snapshottingClusterId)

The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Parameters:

snapshottingClusterId - The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

getSnapshottingClusterId

public String getSnapshottingClusterId()

The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Returns:

The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

withSnapshottingClusterId

public ModifyReplicationGroupRequest withSnapshottingClusterId(String snapshottingClusterId)

The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Parameters:

snapshottingClusterId - The cache cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

Returns:

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

setAutomaticFailoverEnabled

public void setAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Parameters:

automaticFailoverEnabled - Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

getAutomaticFailoverEnabled

public Boolean getAutomaticFailoverEnabled()

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Returns:

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

withAutomaticFailoverEnabled

public ModifyReplicationGroupRequest withAutomaticFailoverEnabled(Boolean automaticFailoverEnabled)

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Parameters:

automaticFailoverEnabled - Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Returns:

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

isAutomaticFailoverEnabled

public Boolean isAutomaticFailoverEnabled()

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

Returns:

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

ElastiCache Multi-AZ replication groups are not supported on:

• Redis versions earlier than 2.8.6.

• Redis (cluster mode disabled):T1 and T2 cache node types.

  Redis (cluster mode enabled): T1 node types.

getCacheSecurityGroupNames

public List<String> getCacheSecurityGroupNames()

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

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

Returns:

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon 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 for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon 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 for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

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

withCacheSecurityGroupNames

public ModifyReplicationGroupRequest withCacheSecurityGroupNames(String... cacheSecurityGroupNames)

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon 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 for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon 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 ModifyReplicationGroupRequest withCacheSecurityGroupNames(Collection<String> cacheSecurityGroupNames)

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon 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 for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (Amazon 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 clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Returns:

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

setSecurityGroupIds

public void setSecurityGroupIds(Collection<String> securityGroupIds)

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Parameters:

securityGroupIds - Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

withSecurityGroupIds

public ModifyReplicationGroupRequest withSecurityGroupIds(String... securityGroupIds)

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon 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 clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Returns:

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

withSecurityGroupIds

public ModifyReplicationGroupRequest withSecurityGroupIds(Collection<String> securityGroupIds)

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

Parameters:

securityGroupIds - Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (Amazon 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 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

Parameters:

preferredMaintenanceWindow - 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

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

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

Returns:

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

withPreferredMaintenanceWindow

public ModifyReplicationGroupRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

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

Parameters:

preferredMaintenanceWindow - 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

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 are sent.

The Amazon SNS topic owner must be same as the replication group owner.

Parameters:

notificationTopicArn - 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 replication group owner.

getNotificationTopicArn

public String getNotificationTopicArn()

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 replication group owner.

Returns:

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 replication group owner.

withNotificationTopicArn

public ModifyReplicationGroupRequest withNotificationTopicArn(String notificationTopicArn)

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 replication group owner.

Parameters:

notificationTopicArn - 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 replication group 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 all of the clusters in this replication group. 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 all of the clusters in this replication group. 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 all of the clusters in this replication group. 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 all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

withCacheParameterGroupName

public ModifyReplicationGroupRequest withCacheParameterGroupName(String cacheParameterGroupName)

The name of the cache parameter group to apply to all of the clusters in this replication group. 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 all of the clusters in this replication group. 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 for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

Parameters:

notificationTopicStatus - The status of the Amazon SNS notification topic for the replication group. 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 for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

Returns:

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

Valid values: active | inactive

withNotificationTopicStatus

public ModifyReplicationGroupRequest withNotificationTopicStatus(String notificationTopicStatus)

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

Valid values: active | inactive

Parameters:

notificationTopicStatus - The status of the Amazon SNS notification topic for the replication group. 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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

withApplyImmediately

public ModifyReplicationGroupRequest 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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

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 replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

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 clusters in the replication group.

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 replication group and create it anew with the earlier engine version.

Parameters:

engineVersion - The upgraded version of the cache engine to be run on the cache clusters in the replication group.

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 replication group 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 clusters in the replication group.

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 replication group and create it anew with the earlier engine version.

Returns:

The upgraded version of the cache engine to be run on the cache clusters in the replication group.

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 replication group and create it anew with the earlier engine version.

withEngineVersion

public ModifyReplicationGroupRequest withEngineVersion(String engineVersion)

The upgraded version of the cache engine to be run on the cache clusters in the replication group.

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 replication group and create it anew with the earlier engine version.

Parameters:

engineVersion - The upgraded version of the cache engine to be run on the cache clusters in the replication group.

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 replication group 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 ModifyReplicationGroupRequest 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 retains automatic node group (shard) 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.

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

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache retains automatic node group (shard) 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.

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 retains automatic node group (shard) 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.

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

Returns:

The number of days for which ElastiCache retains automatic node group (shard) 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.

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

withSnapshotRetentionLimit

public ModifyReplicationGroupRequest withSnapshotRetentionLimit(Integer snapshotRetentionLimit)

The number of days for which ElastiCache retains automatic node group (shard) 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.

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

Parameters:

snapshotRetentionLimit - The number of days for which ElastiCache retains automatic node group (shard) 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.

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 begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

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

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

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

getSnapshotWindow

public String getSnapshotWindow()

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

Example: 05:00-09:00

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

Returns:

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

Example: 05:00-09:00

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

withSnapshotWindow

public ModifyReplicationGroupRequest withSnapshotWindow(String snapshotWindow)

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

Example: 05:00-09:00

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

Parameters:

snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

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

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 replication group to.

Parameters:

cacheNodeType - A valid cache node type that you want to scale this replication group to.

getCacheNodeType

public String getCacheNodeType()

A valid cache node type that you want to scale this replication group to.

Returns:

A valid cache node type that you want to scale this replication group to.

withCacheNodeType

public ModifyReplicationGroupRequest withCacheNodeType(String cacheNodeType)

A valid cache node type that you want to scale this replication group to.

Parameters:

cacheNodeType - A valid cache node type that you want to scale this replication group to.

Returns:

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

setNodeGroupId

public void setNodeGroupId(String nodeGroupId)

The name of the Node Group (called shard in the console).

Parameters:

nodeGroupId - The name of the Node Group (called shard in the console).

getNodeGroupId

public String getNodeGroupId()

The name of the Node Group (called shard in the console).

Returns:

The name of the Node Group (called shard in the console).

withNodeGroupId

public ModifyReplicationGroupRequest withNodeGroupId(String nodeGroupId)

The name of the Node Group (called shard in the console).

Parameters:

nodeGroupId - The name of the Node Group (called shard in the console).

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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ModifyReplicationGroupRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()