@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateClusterRequest() |
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.
|
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
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.
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.
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.
Constraints:
Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word.
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.
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.
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 (@).
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 (@).
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 (@).
Constraints:
Must contain from 8 to 100 characters.
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
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 (@).
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 (@).
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
.
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
.Auth
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
.
PLAIN_TEXT
or SECRET_ARN
.Auth
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
.
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
.Auth
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
.
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
.Auth
public void setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic snapshots are retained.
backupRetentionPeriod
- The number of days for which automatic snapshots are retained.public Integer getBackupRetentionPeriod()
The number of days for which automatic snapshots are retained.
public CreateClusterRequest withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic snapshots are retained.
backupRetentionPeriod
- The number of days for which automatic snapshots are retained.public void setClientToken(String clientToken)
The client token for the elastic cluster.
clientToken
- The client token for the elastic cluster.public String getClientToken()
The client token for the elastic cluster.
public CreateClusterRequest withClientToken(String clientToken)
The client token for the elastic cluster.
clientToken
- The client token for the elastic cluster.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
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
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
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
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
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
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.
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.
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.
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.
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.
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.
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
.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, as
determined by the backupRetentionPeriod
.public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the backupRetentionPeriod
.
backupRetentionPeriod
.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
.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, as
determined by the backupRetentionPeriod
.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.
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.
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.
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.
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.
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.
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.
shardCapacity
- The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16,
32, 64.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.
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.
shardCapacity
- The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16,
32, 64.public void setShardCount(Integer shardCount)
The number of shards assigned to the elastic cluster. Maximum is 32.
shardCount
- The number of shards assigned to the elastic cluster. Maximum is 32.public Integer getShardCount()
The number of shards assigned to the elastic cluster. Maximum is 32.
public CreateClusterRequest withShardCount(Integer shardCount)
The number of shards assigned to the elastic cluster. Maximum is 32.
shardCount
- The number of shards assigned to the elastic cluster. Maximum is 32.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.
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.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.
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.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.
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.public List<String> getSubnetIds()
The Amazon EC2 subnet IDs for the new elastic cluster.
public void setSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the new elastic cluster.
subnetIds
- The Amazon EC2 subnet IDs for the new elastic cluster.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.
subnetIds
- The Amazon EC2 subnet IDs for the new elastic cluster.public CreateClusterRequest withSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the new elastic cluster.
subnetIds
- The Amazon EC2 subnet IDs for the new elastic cluster.public Map<String,String> getTags()
The tags to be assigned to the new elastic cluster.
public void setTags(Map<String,String> tags)
The tags to be assigned to the new elastic cluster.
tags
- The tags to be assigned to the new elastic cluster.public CreateClusterRequest withTags(Map<String,String> tags)
The tags to be assigned to the new elastic cluster.
tags
- The tags to be assigned to the new elastic cluster.public CreateClusterRequest addTagsEntry(String key, String value)
public CreateClusterRequest clearTagsEntries()
public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with the new elastic cluster.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the new elastic cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the new elastic cluster.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.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the new elastic cluster.public CreateClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the new elastic cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the new elastic cluster.public String toString()
toString
in class Object
Object.toString()
public CreateClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()