@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 Elastic DocumentDB cluster administrator.
|
String |
getAdminUserPassword()
The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
|
String |
getAuthType()
The authentication type for the Elastic DocumentDB cluster.
|
String |
getClientToken()
The client token for the Elastic DocumentDB cluster.
|
String |
getClusterName()
The name of the new Elastic DocumentDB cluster.
|
String |
getKmsKeyId()
The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.
|
String |
getPreferredMaintenanceWindow()
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Integer |
getShardCapacity()
The capacity of each shard in the new Elastic DocumentDB cluster.
|
Integer |
getShardCount()
The number of shards to create in the new Elastic DocumentDB cluster.
|
List<String> |
getSubnetIds()
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
|
Map<String,String> |
getTags()
The tags to be assigned to the new Elastic DocumentDB cluster.
|
List<String> |
getVpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
|
int |
hashCode() |
void |
setAdminUserName(String adminUserName)
The name of the Elastic DocumentDB cluster administrator.
|
void |
setAdminUserPassword(String adminUserPassword)
The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
|
void |
setAuthType(String authType)
The authentication type for the Elastic DocumentDB cluster.
|
void |
setClientToken(String clientToken)
The client token for the Elastic DocumentDB cluster.
|
void |
setClusterName(String clusterName)
The name of the new Elastic DocumentDB cluster.
|
void |
setKmsKeyId(String kmsKeyId)
The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.
|
void |
setPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
void |
setShardCapacity(Integer shardCapacity)
The capacity of each shard in the new Elastic DocumentDB cluster.
|
void |
setShardCount(Integer shardCount)
The number of shards to create in the new Elastic DocumentDB cluster.
|
void |
setSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
|
void |
setTags(Map<String,String> tags)
The tags to be assigned to the new Elastic DocumentDB cluster.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
|
String |
toString()
Returns a string representation of this object.
|
CreateClusterRequest |
withAdminUserName(String adminUserName)
The name of the Elastic DocumentDB cluster administrator.
|
CreateClusterRequest |
withAdminUserPassword(String adminUserPassword)
The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.
|
CreateClusterRequest |
withAuthType(Auth authType)
The authentication type for the Elastic DocumentDB cluster.
|
CreateClusterRequest |
withAuthType(String authType)
The authentication type for the Elastic DocumentDB cluster.
|
CreateClusterRequest |
withClientToken(String clientToken)
The client token for the Elastic DocumentDB cluster.
|
CreateClusterRequest |
withClusterName(String clusterName)
The name of the new Elastic DocumentDB cluster.
|
CreateClusterRequest |
withKmsKeyId(String kmsKeyId)
The KMS key identifier to use to encrypt the new Elastic DocumentDB cluster.
|
CreateClusterRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
CreateClusterRequest |
withShardCapacity(Integer shardCapacity)
The capacity of each shard in the new Elastic DocumentDB cluster.
|
CreateClusterRequest |
withShardCount(Integer shardCount)
The number of shards to create in the new Elastic DocumentDB cluster.
|
CreateClusterRequest |
withSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
|
CreateClusterRequest |
withSubnetIds(String... subnetIds)
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
|
CreateClusterRequest |
withTags(Map<String,String> tags)
The tags to be assigned to the new Elastic DocumentDB cluster.
|
CreateClusterRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
|
CreateClusterRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB 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 Elastic DocumentDB cluster 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 Elastic DocumentDB cluster 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 Elastic DocumentDB cluster 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 Elastic DocumentDB cluster 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 Elastic DocumentDB cluster 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 Elastic DocumentDB cluster administrator and 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 Elastic DocumentDB cluster administrator and 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 Elastic DocumentDB cluster administrator and 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 Elastic DocumentDB cluster administrator and 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 Elastic DocumentDB cluster administrator and 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 for the Elastic DocumentDB cluster.
authType
- The authentication type for the Elastic DocumentDB cluster.Auth
public String getAuthType()
The authentication type for the Elastic DocumentDB cluster.
Auth
public CreateClusterRequest withAuthType(String authType)
The authentication type for the Elastic DocumentDB cluster.
authType
- The authentication type for the Elastic DocumentDB cluster.Auth
public CreateClusterRequest withAuthType(Auth authType)
The authentication type for the Elastic DocumentDB cluster.
authType
- The authentication type for the Elastic DocumentDB cluster.Auth
public void setClientToken(String clientToken)
The client token for the Elastic DocumentDB cluster.
clientToken
- The client token for the Elastic DocumentDB cluster.public String getClientToken()
The client token for the Elastic DocumentDB cluster.
public CreateClusterRequest withClientToken(String clientToken)
The client token for the Elastic DocumentDB cluster.
clientToken
- The client token for the Elastic DocumentDB cluster.public void setClusterName(String clusterName)
The name of the new Elastic DocumentDB 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 DocumentDB 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 DocumentDB 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 DocumentDB 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 DocumentDB 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 DocumentDB 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, Elastic 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 DocumentDB 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, Elastic 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 DocumentDB 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, Elastic 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, Elastic 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 DocumentDB 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, Elastic 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 DocumentDB 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, Elastic 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 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 capacity of each shard in the new Elastic DocumentDB cluster.
shardCapacity
- The capacity of each shard in the new Elastic DocumentDB cluster.public Integer getShardCapacity()
The capacity of each shard in the new Elastic DocumentDB cluster.
public CreateClusterRequest withShardCapacity(Integer shardCapacity)
The capacity of each shard in the new Elastic DocumentDB cluster.
shardCapacity
- The capacity of each shard in the new Elastic DocumentDB cluster.public void setShardCount(Integer shardCount)
The number of shards to create in the new Elastic DocumentDB cluster.
shardCount
- The number of shards to create in the new Elastic DocumentDB cluster.public Integer getShardCount()
The number of shards to create in the new Elastic DocumentDB cluster.
public CreateClusterRequest withShardCount(Integer shardCount)
The number of shards to create in the new Elastic DocumentDB cluster.
shardCount
- The number of shards to create in the new Elastic DocumentDB cluster.public List<String> getSubnetIds()
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
public void setSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
subnetIds
- The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.public CreateClusterRequest withSubnetIds(String... subnetIds)
The Amazon EC2 subnet IDs for the new Elastic DocumentDB 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 DocumentDB cluster.public CreateClusterRequest withSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
subnetIds
- The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.public Map<String,String> getTags()
The tags to be assigned to the new Elastic DocumentDB cluster.
public void setTags(Map<String,String> tags)
The tags to be assigned to the new Elastic DocumentDB cluster.
tags
- The tags to be assigned to the new Elastic DocumentDB cluster.public CreateClusterRequest withTags(Map<String,String> tags)
The tags to be assigned to the new Elastic DocumentDB cluster.
tags
- The tags to be assigned to the new Elastic DocumentDB 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 DocumentDB cluster.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.public CreateClusterRequest withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB 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 DocumentDB cluster.public CreateClusterRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.public String toString()
toString
in class Object
Object.toString()
public CreateClusterRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()