@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Cluster extends Object implements Serializable, Cloneable, StructuredPojo
Returns information about a specific elastic cluster.
Constructor and Description |
---|
Cluster() |
Modifier and Type | Method and Description |
---|---|
Cluster |
clone() |
boolean |
equals(Object obj) |
String |
getAdminUserName()
The name of the elastic cluster administrator.
|
String |
getAuthType()
The authentication type for the elastic cluster.
|
Integer |
getBackupRetentionPeriod()
The number of days for which automatic snapshots are retained.
|
String |
getClusterArn()
The ARN identifier of the elastic cluster.
|
String |
getClusterEndpoint()
The URL used to connect to the elastic cluster.
|
String |
getClusterName()
The name of the elastic cluster.
|
String |
getCreateTime()
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
|
String |
getKmsKeyId()
The KMS key identifier to use to encrypt the elastic cluster.
|
String |
getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, as determined
by
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 cluster.
|
List<Shard> |
getShards()
The total number of shards in the cluster.
|
String |
getStatus()
The status of 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 associated with thie elastic cluster.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAdminUserName(String adminUserName)
The name of the elastic cluster administrator.
|
void |
setAuthType(String authType)
The authentication type for the elastic cluster.
|
void |
setBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic snapshots are retained.
|
void |
setClusterArn(String clusterArn)
The ARN identifier of the elastic cluster.
|
void |
setClusterEndpoint(String clusterEndpoint)
The URL used to connect to the elastic cluster.
|
void |
setClusterName(String clusterName)
The name of the elastic cluster.
|
void |
setCreateTime(String createTime)
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
|
void |
setKmsKeyId(String kmsKeyId)
The KMS key identifier to use to encrypt 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
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 cluster.
|
void |
setShards(Collection<Shard> shards)
The total number of shards in the cluster.
|
void |
setStatus(String status)
The status of 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 associated with thie elastic cluster.
|
String |
toString()
Returns a string representation of this object.
|
Cluster |
withAdminUserName(String adminUserName)
The name of the elastic cluster administrator.
|
Cluster |
withAuthType(Auth authType)
The authentication type for the elastic cluster.
|
Cluster |
withAuthType(String authType)
The authentication type for the elastic cluster.
|
Cluster |
withBackupRetentionPeriod(Integer backupRetentionPeriod)
The number of days for which automatic snapshots are retained.
|
Cluster |
withClusterArn(String clusterArn)
The ARN identifier of the elastic cluster.
|
Cluster |
withClusterEndpoint(String clusterEndpoint)
The URL used to connect to the elastic cluster.
|
Cluster |
withClusterName(String clusterName)
The name of the elastic cluster.
|
Cluster |
withCreateTime(String createTime)
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
|
Cluster |
withKmsKeyId(String kmsKeyId)
The KMS key identifier to use to encrypt the elastic cluster.
|
Cluster |
withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined
by
backupRetentionPeriod . |
Cluster |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
|
Cluster |
withShardCapacity(Integer shardCapacity)
The number of vCPUs assigned to each elastic cluster shard.
|
Cluster |
withShardCount(Integer shardCount)
The number of shards assigned to the elastic cluster.
|
Cluster |
withShardInstanceCount(Integer shardInstanceCount)
The number of replica instances applying to all shards in the cluster.
|
Cluster |
withShards(Collection<Shard> shards)
The total number of shards in the cluster.
|
Cluster |
withShards(Shard... shards)
The total number of shards in the cluster.
|
Cluster |
withStatus(Status status)
The status of the elastic cluster.
|
Cluster |
withStatus(String status)
The status of the elastic cluster.
|
Cluster |
withSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the elastic cluster.
|
Cluster |
withSubnetIds(String... subnetIds)
The Amazon EC2 subnet IDs for the elastic cluster.
|
Cluster |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups associated with thie elastic cluster.
|
Cluster |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups associated with thie elastic cluster.
|
public void setAdminUserName(String adminUserName)
The name of the elastic cluster administrator.
adminUserName
- The name of the elastic cluster administrator.public String getAdminUserName()
The name of the elastic cluster administrator.
public Cluster withAdminUserName(String adminUserName)
The name of the elastic cluster administrator.
adminUserName
- The name of the elastic cluster administrator.public void setAuthType(String authType)
The authentication type for the elastic cluster.
authType
- The authentication type for the elastic cluster.Auth
public String getAuthType()
The authentication type for the elastic cluster.
Auth
public Cluster withAuthType(String authType)
The authentication type for the elastic cluster.
authType
- The authentication type for the elastic cluster.Auth
public Cluster withAuthType(Auth authType)
The authentication type for the elastic cluster.
authType
- The authentication type for the elastic cluster.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 Cluster 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 setClusterArn(String clusterArn)
The ARN identifier of the elastic cluster.
clusterArn
- The ARN identifier of the elastic cluster.public String getClusterArn()
The ARN identifier of the elastic cluster.
public Cluster withClusterArn(String clusterArn)
The ARN identifier of the elastic cluster.
clusterArn
- The ARN identifier of the elastic cluster.public void setClusterEndpoint(String clusterEndpoint)
The URL used to connect to the elastic cluster.
clusterEndpoint
- The URL used to connect to the elastic cluster.public String getClusterEndpoint()
The URL used to connect to the elastic cluster.
public Cluster withClusterEndpoint(String clusterEndpoint)
The URL used to connect to the elastic cluster.
clusterEndpoint
- The URL used to connect to the elastic cluster.public void setClusterName(String clusterName)
The name of the elastic cluster.
clusterName
- The name of the elastic cluster.public String getClusterName()
The name of the elastic cluster.
public Cluster withClusterName(String clusterName)
The name of the elastic cluster.
clusterName
- The name of the elastic cluster.public void setCreateTime(String createTime)
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
createTime
- The time when the elastic cluster was created in Universal Coordinated Time (UTC).public String getCreateTime()
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
public Cluster withCreateTime(String createTime)
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
createTime
- The time when the elastic cluster was created in Universal Coordinated Time (UTC).public void setKmsKeyId(String kmsKeyId)
The KMS key identifier to use to encrypt the elastic cluster.
kmsKeyId
- The KMS key identifier to use to encrypt the elastic cluster.public String getKmsKeyId()
The KMS key identifier to use to encrypt the elastic cluster.
public Cluster withKmsKeyId(String kmsKeyId)
The KMS key identifier to use to encrypt the elastic cluster.
kmsKeyId
- The KMS key identifier to use to encrypt the elastic cluster.public void setPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined
by backupRetentionPeriod
.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, as
determined by backupRetentionPeriod
.public String getPreferredBackupWindow()
The daily time range during which automated backups are created if automated backups are enabled, as determined
by backupRetentionPeriod
.
backupRetentionPeriod
.public Cluster withPreferredBackupWindow(String preferredBackupWindow)
The daily time range during which automated backups are created if automated backups are enabled, as determined
by backupRetentionPeriod
.
preferredBackupWindow
- The daily time range during which automated backups are created if automated backups are enabled, as
determined by 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
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
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
Format: ddd:hh24:mi-ddd:hh24:mi
public Cluster 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
preferredMaintenanceWindow
- The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
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 Cluster 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 Cluster 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 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 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 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 Cluster withShardInstanceCount(Integer shardInstanceCount)
The number of replica instances applying to all shards in the 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 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<Shard> getShards()
The total number of shards in the cluster.
public void setShards(Collection<Shard> shards)
The total number of shards in the cluster.
shards
- The total number of shards in the cluster.public Cluster withShards(Shard... shards)
The total number of shards in the cluster.
NOTE: This method appends the values to the existing list (if any). Use
setShards(java.util.Collection)
or withShards(java.util.Collection)
if you want to override the
existing values.
shards
- The total number of shards in the cluster.public Cluster withShards(Collection<Shard> shards)
The total number of shards in the cluster.
shards
- The total number of shards in the cluster.public void setStatus(String status)
The status of the elastic cluster.
status
- The status of the elastic cluster.Status
public String getStatus()
The status of the elastic cluster.
Status
public Cluster withStatus(String status)
The status of the elastic cluster.
status
- The status of the elastic cluster.Status
public Cluster withStatus(Status status)
The status of the elastic cluster.
status
- The status of the elastic cluster.Status
public List<String> getSubnetIds()
The Amazon EC2 subnet IDs for the elastic cluster.
public void setSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the elastic cluster.
subnetIds
- The Amazon EC2 subnet IDs for the elastic cluster.public Cluster 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.
subnetIds
- The Amazon EC2 subnet IDs for the elastic cluster.public Cluster withSubnetIds(Collection<String> subnetIds)
The Amazon EC2 subnet IDs for the elastic cluster.
subnetIds
- The Amazon EC2 subnet IDs for the elastic cluster.public List<String> getVpcSecurityGroupIds()
A list of EC2 VPC security groups associated with thie elastic cluster.
public void setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups associated with thie elastic cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups associated with thie elastic cluster.public Cluster withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of EC2 VPC security groups associated with thie 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 associated with thie elastic cluster.public Cluster withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of EC2 VPC security groups associated with thie elastic cluster.
vpcSecurityGroupIds
- A list of EC2 VPC security groups associated with thie elastic cluster.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.