com.amazonaws.services.docdbelastic.model

Class UpdateClusterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.docdbelastic.model.UpdateClusterRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateClusterRequest()

Method Summary

Modifier and Type	Method and Description
UpdateClusterRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAdminUserPassword() The password associated with the elastic cluster administrator.
String	getAuthType() The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
Integer	getBackupRetentionPeriod() The number of days for which automatic snapshots are retained.
String	getClientToken() The client token for the elastic cluster.
String	getClusterArn() The ARN identifier of the elastic cluster.
String	getPreferredBackupWindow() The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
String	getPreferredMaintenanceWindow() The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Integer	getShardCapacity() The number of vCPUs assigned to each elastic cluster shard.
Integer	getShardCount() The number of shards assigned to the elastic cluster.
Integer	getShardInstanceCount() The number of replica instances applying to all shards in the elastic cluster.
List<String>	getSubnetIds() The Amazon EC2 subnet IDs for the elastic cluster.
List<String>	getVpcSecurityGroupIds() A list of EC2 VPC security groups to associate with the elastic cluster.
int	hashCode()
void	setAdminUserPassword(String adminUserPassword) The password associated with the elastic cluster administrator.
void	setAuthType(String authType) The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
void	setBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days for which automatic snapshots are retained.
void	setClientToken(String clientToken) The client token for the elastic cluster.
void	setClusterArn(String clusterArn) The ARN identifier of the elastic cluster.
void	setPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
void	setPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
void	setShardCapacity(Integer shardCapacity) The number of vCPUs assigned to each elastic cluster shard.
void	setShardCount(Integer shardCount) The number of shards assigned to the elastic cluster.
void	setShardInstanceCount(Integer shardInstanceCount) The number of replica instances applying to all shards in the elastic cluster.
void	setSubnetIds(Collection<String> subnetIds) The Amazon EC2 subnet IDs for the elastic cluster.
void	setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with the elastic cluster.
String	toString() Returns a string representation of this object.
UpdateClusterRequest	withAdminUserPassword(String adminUserPassword) The password associated with the elastic cluster administrator.
UpdateClusterRequest	withAuthType(Auth authType) The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
UpdateClusterRequest	withAuthType(String authType) The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
UpdateClusterRequest	withBackupRetentionPeriod(Integer backupRetentionPeriod) The number of days for which automatic snapshots are retained.
UpdateClusterRequest	withClientToken(String clientToken) The client token for the elastic cluster.
UpdateClusterRequest	withClusterArn(String clusterArn) The ARN identifier of the elastic cluster.
UpdateClusterRequest	withPreferredBackupWindow(String preferredBackupWindow) The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
UpdateClusterRequest	withPreferredMaintenanceWindow(String preferredMaintenanceWindow) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
UpdateClusterRequest	withShardCapacity(Integer shardCapacity) The number of vCPUs assigned to each elastic cluster shard.
UpdateClusterRequest	withShardCount(Integer shardCount) The number of shards assigned to the elastic cluster.
UpdateClusterRequest	withShardInstanceCount(Integer shardInstanceCount) The number of replica instances applying to all shards in the elastic cluster.
UpdateClusterRequest	withSubnetIds(Collection<String> subnetIds) The Amazon EC2 subnet IDs for the elastic cluster.
UpdateClusterRequest	withSubnetIds(String... subnetIds) The Amazon EC2 subnet IDs for the elastic cluster.
UpdateClusterRequest	withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with the elastic cluster.
UpdateClusterRequest	withVpcSecurityGroupIds(String... vpcSecurityGroupIds) A list of EC2 VPC security groups to associate with the elastic cluster.

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

UpdateClusterRequest

public UpdateClusterRequest()

Method Detail

setAdminUserPassword

public void setAdminUserPassword(String adminUserPassword)

The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Parameters:

adminUserPassword - The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

getAdminUserPassword

public String getAdminUserPassword()

The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Returns:

The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

withAdminUserPassword

public UpdateClusterRequest withAdminUserPassword(String adminUserPassword)

The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Parameters:

adminUserPassword - The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Returns:

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

setAuthType

public void setAuthType(String authType)

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

Parameters:

authType - The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

See Also:

Auth

getAuthType

public String getAuthType()

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

Returns:

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

See Also:

Auth

withAuthType

public UpdateClusterRequest withAuthType(String authType)

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

Parameters:

authType - The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

Returns:

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

See Also:

Auth

withAuthType

public UpdateClusterRequest withAuthType(Auth authType)

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

Parameters:

authType - The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.

Returns:

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

See Also:

Auth

setBackupRetentionPeriod

public void setBackupRetentionPeriod(Integer backupRetentionPeriod)

The number of days for which automatic snapshots are retained.

Parameters:

backupRetentionPeriod - The number of days for which automatic snapshots are retained.

getBackupRetentionPeriod

public Integer getBackupRetentionPeriod()

The number of days for which automatic snapshots are retained.

Returns:

The number of days for which automatic snapshots are retained.

withBackupRetentionPeriod

public UpdateClusterRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)

The number of days for which automatic snapshots are retained.

Parameters:

backupRetentionPeriod - The number of days for which automatic snapshots are retained.

Returns:

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

setClientToken

public void setClientToken(String clientToken)

The client token for the elastic cluster.

Parameters:

clientToken - The client token for the elastic cluster.

getClientToken

public String getClientToken()

The client token for the elastic cluster.

Returns:

The client token for the elastic cluster.

withClientToken

public UpdateClusterRequest withClientToken(String clientToken)

The client token for the elastic cluster.

Parameters:

clientToken - The client token for the elastic cluster.

Returns:

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

setClusterArn

public void setClusterArn(String clusterArn)

The ARN identifier of the elastic cluster.

Parameters:

clusterArn - The ARN identifier of the elastic cluster.

getClusterArn

public String getClusterArn()

The ARN identifier of the elastic cluster.

Returns:

The ARN identifier of the elastic cluster.

withClusterArn

public UpdateClusterRequest withClusterArn(String clusterArn)

The ARN identifier of the elastic cluster.

Parameters:

clusterArn - The ARN identifier of the elastic cluster.

Returns:

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

setPreferredBackupWindow

public void setPreferredBackupWindow(String preferredBackupWindow)

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

getPreferredBackupWindow

public String getPreferredBackupWindow()

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

Returns:

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

withPreferredBackupWindow

public UpdateClusterRequest withPreferredBackupWindow(String preferredBackupWindow)

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

Parameters:

preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

Returns:

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

setPreferredMaintenanceWindow

public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Parameters:

preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

getPreferredMaintenanceWindow

public String getPreferredMaintenanceWindow()

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Returns:

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

withPreferredMaintenanceWindow

public UpdateClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Parameters:

preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Returns:

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

setShardCapacity

public void setShardCapacity(Integer shardCapacity)

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Parameters:

shardCapacity - The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

getShardCapacity

public Integer getShardCapacity()

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Returns:

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

withShardCapacity

public UpdateClusterRequest withShardCapacity(Integer shardCapacity)

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Parameters:

shardCapacity - The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

Returns:

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

setShardCount

public void setShardCount(Integer shardCount)

The number of shards assigned to the elastic cluster. Maximum is 32.

Parameters:

shardCount - The number of shards assigned to the elastic cluster. Maximum is 32.

getShardCount

public Integer getShardCount()

The number of shards assigned to the elastic cluster. Maximum is 32.

Returns:

The number of shards assigned to the elastic cluster. Maximum is 32.

withShardCount

public UpdateClusterRequest withShardCount(Integer shardCount)

The number of shards assigned to the elastic cluster. Maximum is 32.

Parameters:

shardCount - The number of shards assigned to the elastic cluster. Maximum is 32.

Returns:

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

setShardInstanceCount

public void setShardInstanceCount(Integer shardInstanceCount)

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Parameters:

shardInstanceCount - The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

getShardInstanceCount

public Integer getShardInstanceCount()

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Returns:

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

withShardInstanceCount

public UpdateClusterRequest withShardInstanceCount(Integer shardInstanceCount)

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Parameters:

shardInstanceCount - The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

Returns:

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

getSubnetIds

public List<String> getSubnetIds()

The Amazon EC2 subnet IDs for the elastic cluster.

Returns:

The Amazon EC2 subnet IDs for the elastic cluster.

setSubnetIds

public void setSubnetIds(Collection<String> subnetIds)

The Amazon EC2 subnet IDs for the elastic cluster.

Parameters:

subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.

withSubnetIds

public UpdateClusterRequest withSubnetIds(String... subnetIds)

The Amazon EC2 subnet IDs for the elastic cluster.

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

Parameters:

subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.

Returns:

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

withSubnetIds

public UpdateClusterRequest withSubnetIds(Collection<String> subnetIds)

The Amazon EC2 subnet IDs for the elastic cluster.

Parameters:

subnetIds - The Amazon EC2 subnet IDs for the elastic cluster.

Returns:

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

getVpcSecurityGroupIds

public List<String> getVpcSecurityGroupIds()

A list of EC2 VPC security groups to associate with the elastic cluster.

Returns:

A list of EC2 VPC security groups to associate with the elastic cluster.

setVpcSecurityGroupIds

public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

A list of EC2 VPC security groups to associate with the elastic cluster.

Parameters:

vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.

withVpcSecurityGroupIds

public UpdateClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)

A list of EC2 VPC security groups to associate with the elastic cluster.

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

Parameters:

vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.

Returns:

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

withVpcSecurityGroupIds

public UpdateClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)

A list of EC2 VPC security groups to associate with the elastic cluster.

Parameters:

vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the elastic cluster.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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