CreateClusterRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.docdbelastic.model

Class CreateClusterRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.docdbelastic.model.CreateClusterRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateClusterRequest
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

CreateClusterRequest ()

Constructors
Constructor and Description
`CreateClusterRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateClusterRequest`	`addTagsEntry (String key, String value)` Add a single Tags entry
`CreateClusterRequest`	`clearTagsEntries ()` Removes all the entries added into Tags.
`CreateClusterRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getAdminUserName ()` The name of the Amazon DocumentDB elastic clusters administrator.
`String`	`getAdminUserPassword ()` The password for the Amazon DocumentDB elastic clusters 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`	`getClusterName ()` The name of the new elastic cluster.
`String`	`getKmsKeyId ()` The KMS key identifier to use to encrypt the new 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 new elastic cluster.
`Map<String,String>`	`getTags ()` The tags to be assigned to the new elastic cluster.
`List<String>`	`getVpcSecurityGroupIds ()` A list of EC2 VPC security groups to associate with the new elastic cluster.
`int`	`hashCode ()`
`void`	`setAdminUserName (String adminUserName)` The name of the Amazon DocumentDB elastic clusters administrator.
`void`	`setAdminUserPassword (String adminUserPassword)` The password for the Amazon DocumentDB elastic clusters 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`	`setClusterName (String clusterName)` The name of the new elastic cluster.
`void`	`setKmsKeyId (String kmsKeyId)` The KMS key identifier to use to encrypt the new 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 new elastic cluster.
`void`	`setTags (Map<String,String> tags)` The tags to be assigned to the new elastic cluster.
`void`	`setVpcSecurityGroupIds (Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with the new elastic cluster.
`String`	`toString ()` Returns a string representation of this object.
`CreateClusterRequest`	`withAdminUserName (String adminUserName)` The name of the Amazon DocumentDB elastic clusters administrator.
`CreateClusterRequest`	`withAdminUserPassword (String adminUserPassword)` The password for the Amazon DocumentDB elastic clusters administrator.
`CreateClusterRequest`	`withAuthType (Auth authType)` The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
`CreateClusterRequest`	`withAuthType (String authType)` The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
`CreateClusterRequest`	`withBackupRetentionPeriod (Integer backupRetentionPeriod)` The number of days for which automatic snapshots are retained.
`CreateClusterRequest`	`withClientToken (String clientToken)` The client token for the elastic cluster.
`CreateClusterRequest`	`withClusterName (String clusterName)` The name of the new elastic cluster.
`CreateClusterRequest`	`withKmsKeyId (String kmsKeyId)` The KMS key identifier to use to encrypt the new elastic cluster.
`CreateClusterRequest`	`withPreferredBackupWindow (String preferredBackupWindow)` The daily time range during which automated backups are created if automated backups are enabled, as determined by the `backupRetentionPeriod`.
`CreateClusterRequest`	`withPreferredMaintenanceWindow (String preferredMaintenanceWindow)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`CreateClusterRequest`	`withShardCapacity (Integer shardCapacity)` The number of vCPUs assigned to each elastic cluster shard.
`CreateClusterRequest`	`withShardCount (Integer shardCount)` The number of shards assigned to the elastic cluster.
`CreateClusterRequest`	`withShardInstanceCount (Integer shardInstanceCount)` The number of replica instances applying to all shards in the elastic cluster.
`CreateClusterRequest`	`withSubnetIds (Collection<String> subnetIds)` The Amazon EC2 subnet IDs for the new elastic cluster.
`CreateClusterRequest`	`withSubnetIds (String... subnetIds)` The Amazon EC2 subnet IDs for the new elastic cluster.
`CreateClusterRequest`	`withTags (Map<String,String> tags)` The tags to be assigned to the new elastic cluster.
`CreateClusterRequest`	`withVpcSecurityGroupIds (Collection<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with the new elastic cluster.
`CreateClusterRequest`	`withVpcSecurityGroupIds (String... vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with the new 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
  - CreateClusterRequest
```
public CreateClusterRequest()
```
- Method Detail
  - setAdminUserName
```
public void setAdminUserName(String adminUserName)
```
    The name of the Amazon DocumentDB elastic clusters administrator.
    
    Constraints:
    - Must be from 1 to 63 letters or numbers.
    - The first character must be a letter.
    - Cannot be a reserved word.
    Parameters:
    adminUserName - The name of the Amazon DocumentDB elastic clusters administrator.
    
    Constraints:
    
    Must be from 1 to 63 letters or numbers.
    
    The first character must be a letter.
    
    Cannot be a reserved word.
  - getAdminUserName
```
public String getAdminUserName()
```
    The name of the Amazon DocumentDB elastic clusters administrator.
    
    Constraints:
    - Must be from 1 to 63 letters or numbers.
    - The first character must be a letter.
    - Cannot be a reserved word.
    Returns:
    The name of the Amazon DocumentDB elastic clusters administrator.
    
    Constraints:
    
    Must be from 1 to 63 letters or numbers.
    
    The first character must be a letter.
    
    Cannot be a reserved word.
  - withAdminUserName
```
public CreateClusterRequest withAdminUserName(String adminUserName)
```
    The name of the Amazon DocumentDB elastic clusters administrator.
    
    Constraints:
    - Must be from 1 to 63 letters or numbers.
    - The first character must be a letter.
    - Cannot be a reserved word.
    Parameters:
    adminUserName - The name of the Amazon DocumentDB elastic clusters administrator.
    
    Constraints:
    
    Must be from 1 to 63 letters or numbers.
    
    The first character must be a letter.
    
    Cannot be a reserved word.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAdminUserPassword
```
public void setAdminUserPassword(String adminUserPassword)
```
    The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
    
    Constraints:
    - Must contain from 8 to 100 characters.
    - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
    Parameters:
    adminUserPassword - The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
    
    Constraints:
    
    Must contain from 8 to 100 characters.
    
    Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
  - getAdminUserPassword
```
public String getAdminUserPassword()
```
    The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
    
    Constraints:
    - Must contain from 8 to 100 characters.
    - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
    Returns:
    The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
    
    Constraints:
    
    Must contain from 8 to 100 characters.
    
    Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
  - withAdminUserPassword
```
public CreateClusterRequest withAdminUserPassword(String adminUserPassword)
```
    The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
    
    Constraints:
    - Must contain from 8 to 100 characters.
    - Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
    Parameters:
    adminUserPassword - The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
    
    Constraints:
    
    Must contain from 8 to 100 characters.
    
    Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
    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 CreateClusterRequest 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 CreateClusterRequest 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 CreateClusterRequest 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 CreateClusterRequest 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.
  - setClusterName
```
public void setClusterName(String clusterName)
```
    The name of the new elastic cluster. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - The first character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster
    Parameters:
    clusterName - The name of the new elastic cluster. This parameter is stored as a lowercase string.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens.
    
    The first character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster
  - getClusterName
```
public String getClusterName()
```
    The name of the new elastic cluster. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - The first character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster
    Returns:
    The name of the new elastic cluster. This parameter is stored as a lowercase string.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens.
    
    The first character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster
  - withClusterName
```
public CreateClusterRequest withClusterName(String clusterName)
```
    The name of the new elastic cluster. This parameter is stored as a lowercase string.
    
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - The first character must be a letter.
    - Cannot end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster
    Parameters:
    clusterName - The name of the new elastic cluster. This parameter is stored as a lowercase string.
    
    Constraints:
    
    Must contain from 1 to 63 letters, numbers, or hyphens.
    
    The first character must be a letter.
    
    Cannot end with a hyphen or contain two consecutive hyphens.
    
    Example: my-cluster
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKmsKeyId
```
public void setKmsKeyId(String kmsKeyId)
```
    The KMS key identifier to use to encrypt the new elastic cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
    
    If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier to use to encrypt the new elastic cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
    
    If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
  - getKmsKeyId
```
public String getKmsKeyId()
```
    The KMS key identifier to use to encrypt the new elastic cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
    
    If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Returns:
    
    The KMS key identifier to use to encrypt the new elastic cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
    
    If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
  - withKmsKeyId
```
public CreateClusterRequest withKmsKeyId(String kmsKeyId)
```
    The KMS key identifier to use to encrypt the new elastic cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
    
    If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    Parameters:
    
    kmsKeyId - The KMS key identifier to use to encrypt the new elastic cluster.
    
    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
    
    If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    
    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 CreateClusterRequest 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 CreateClusterRequest 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 CreateClusterRequest 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 CreateClusterRequest 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 CreateClusterRequest 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 new elastic cluster.
    
    Returns:
    
    The Amazon EC2 subnet IDs for the new elastic cluster.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    The Amazon EC2 subnet IDs for the new elastic cluster.
    
    Parameters:
    
    subnetIds - The Amazon EC2 subnet IDs for the new elastic cluster.
  - withSubnetIds
```
public CreateClusterRequest withSubnetIds(String... subnetIds)
```
    The Amazon EC2 subnet IDs for the new 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 new elastic cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public CreateClusterRequest withSubnetIds(Collection<String> subnetIds)
```
    The Amazon EC2 subnet IDs for the new elastic cluster.
    
    Parameters:
    
    subnetIds - The Amazon EC2 subnet IDs for the new elastic cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    The tags to be assigned to the new elastic cluster.
    
    Returns:
    
    The tags to be assigned to the new elastic cluster.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags to be assigned to the new elastic cluster.
    
    Parameters:
    
    tags - The tags to be assigned to the new elastic cluster.
  - withTags
```
public CreateClusterRequest withTags(Map<String,String> tags)
```
    The tags to be assigned to the new elastic cluster.
    
    Parameters:
    
    tags - The tags to be assigned to the new elastic cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateClusterRequest addTagsEntry(String key,
 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateClusterRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    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 new elastic cluster.
    
    Returns:
    
    A list of EC2 VPC security groups to associate with the new elastic cluster.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with the new elastic cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the new elastic cluster.
  - withVpcSecurityGroupIds
```
public CreateClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with the new 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 new elastic cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVpcSecurityGroupIds
```
public CreateClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with the new elastic cluster.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with the new 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 CreateClusterRequest 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()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateClusterRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateClusterRequest

Method Detail

setAdminUserName

getAdminUserName

withAdminUserName

setAdminUserPassword

getAdminUserPassword

withAdminUserPassword

setAuthType

getAuthType

withAuthType

withAuthType

setBackupRetentionPeriod

getBackupRetentionPeriod

withBackupRetentionPeriod

setClientToken

getClientToken

withClientToken

setClusterName

getClusterName

withClusterName

setKmsKeyId

getKmsKeyId

withKmsKeyId

setPreferredBackupWindow

getPreferredBackupWindow

withPreferredBackupWindow

setPreferredMaintenanceWindow

getPreferredMaintenanceWindow

withPreferredMaintenanceWindow

setShardCapacity

getShardCapacity

withShardCapacity

setShardCount

getShardCount

withShardCount

setShardInstanceCount

getShardInstanceCount

withShardInstanceCount

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

getVpcSecurityGroupIds

setVpcSecurityGroupIds

withVpcSecurityGroupIds

withVpcSecurityGroupIds

toString

equals

hashCode

clone