@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Cluster extends Object implements Serializable, Cloneable, StructuredPojo
Contains all of the attributes of a specific cluster.
Constructor and Description |
---|
Cluster() |
Modifier and Type | Method and Description |
---|---|
Cluster |
clone() |
boolean |
equals(Object obj) |
String |
getACLName()
The name of the Access Control List associated with this cluster.
|
String |
getARN()
The Amazon Resource Name (ARN) of the cluster.
|
Boolean |
getAutoMinorVersionUpgrade()
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
|
String |
getAvailabilityMode()
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
|
Endpoint |
getClusterEndpoint()
The cluster's configuration endpoint
|
String |
getDataTiering()
Enables data tiering.
|
String |
getDescription()
A description of the cluster
|
String |
getEnginePatchVersion()
The Redis OSS engine patch version used by the cluster
|
String |
getEngineVersion()
The Redis OSS engine version used by the cluster
|
String |
getKmsKeyId()
The ID of the KMS key used to encrypt the cluster
|
String |
getMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed.
|
String |
getName()
The user-supplied name of the cluster.
|
String |
getNodeType()
The cluster's node type
|
Integer |
getNumberOfShards()
The number of shards in the cluster
|
String |
getParameterGroupName()
The name of the parameter group used by the cluster
|
String |
getParameterGroupStatus()
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
|
ClusterPendingUpdates |
getPendingUpdates()
A group of settings that are currently being applied.
|
List<SecurityGroupMembership> |
getSecurityGroups()
A list of security groups used by the cluster
|
List<Shard> |
getShards()
A list of shards that are members of the cluster.
|
Integer |
getSnapshotRetentionLimit()
The number of days for which MemoryDB retains automatic snapshots before deleting them.
|
String |
getSnapshotWindow()
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
|
String |
getSnsTopicArn()
The Amazon Resource Name (ARN) of the SNS notification topic
|
String |
getSnsTopicStatus()
The SNS topic must be in Active status to receive notifications
|
String |
getStatus()
The status of the cluster.
|
String |
getSubnetGroupName()
The name of the subnet group used by the cluster
|
Boolean |
getTLSEnabled()
A flag to indicate if In-transit encryption is enabled
|
int |
hashCode() |
Boolean |
isAutoMinorVersionUpgrade()
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
|
Boolean |
isTLSEnabled()
A flag to indicate if In-transit encryption is enabled
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setACLName(String aCLName)
The name of the Access Control List associated with this cluster.
|
void |
setARN(String aRN)
The Amazon Resource Name (ARN) of the cluster.
|
void |
setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
|
void |
setAvailabilityMode(String availabilityMode)
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
|
void |
setClusterEndpoint(Endpoint clusterEndpoint)
The cluster's configuration endpoint
|
void |
setDataTiering(String dataTiering)
Enables data tiering.
|
void |
setDescription(String description)
A description of the cluster
|
void |
setEnginePatchVersion(String enginePatchVersion)
The Redis OSS engine patch version used by the cluster
|
void |
setEngineVersion(String engineVersion)
The Redis OSS engine version used by the cluster
|
void |
setKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the cluster
|
void |
setMaintenanceWindow(String maintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
void |
setName(String name)
The user-supplied name of the cluster.
|
void |
setNodeType(String nodeType)
The cluster's node type
|
void |
setNumberOfShards(Integer numberOfShards)
The number of shards in the cluster
|
void |
setParameterGroupName(String parameterGroupName)
The name of the parameter group used by the cluster
|
void |
setParameterGroupStatus(String parameterGroupStatus)
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
|
void |
setPendingUpdates(ClusterPendingUpdates pendingUpdates)
A group of settings that are currently being applied.
|
void |
setSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of security groups used by the cluster
|
void |
setShards(Collection<Shard> shards)
A list of shards that are members of the cluster.
|
void |
setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which MemoryDB retains automatic snapshots before deleting them.
|
void |
setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
|
void |
setSnsTopicArn(String snsTopicArn)
The Amazon Resource Name (ARN) of the SNS notification topic
|
void |
setSnsTopicStatus(String snsTopicStatus)
The SNS topic must be in Active status to receive notifications
|
void |
setStatus(String status)
The status of the cluster.
|
void |
setSubnetGroupName(String subnetGroupName)
The name of the subnet group used by the cluster
|
void |
setTLSEnabled(Boolean tLSEnabled)
A flag to indicate if In-transit encryption is enabled
|
String |
toString()
Returns a string representation of this object.
|
Cluster |
withACLName(String aCLName)
The name of the Access Control List associated with this cluster.
|
Cluster |
withARN(String aRN)
The Amazon Resource Name (ARN) of the cluster.
|
Cluster |
withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
|
Cluster |
withAvailabilityMode(AZStatus availabilityMode)
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
|
Cluster |
withAvailabilityMode(String availabilityMode)
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
|
Cluster |
withClusterEndpoint(Endpoint clusterEndpoint)
The cluster's configuration endpoint
|
Cluster |
withDataTiering(DataTieringStatus dataTiering)
Enables data tiering.
|
Cluster |
withDataTiering(String dataTiering)
Enables data tiering.
|
Cluster |
withDescription(String description)
A description of the cluster
|
Cluster |
withEnginePatchVersion(String enginePatchVersion)
The Redis OSS engine patch version used by the cluster
|
Cluster |
withEngineVersion(String engineVersion)
The Redis OSS engine version used by the cluster
|
Cluster |
withKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the cluster
|
Cluster |
withMaintenanceWindow(String maintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed.
|
Cluster |
withName(String name)
The user-supplied name of the cluster.
|
Cluster |
withNodeType(String nodeType)
The cluster's node type
|
Cluster |
withNumberOfShards(Integer numberOfShards)
The number of shards in the cluster
|
Cluster |
withParameterGroupName(String parameterGroupName)
The name of the parameter group used by the cluster
|
Cluster |
withParameterGroupStatus(String parameterGroupStatus)
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
|
Cluster |
withPendingUpdates(ClusterPendingUpdates pendingUpdates)
A group of settings that are currently being applied.
|
Cluster |
withSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of security groups used by the cluster
|
Cluster |
withSecurityGroups(SecurityGroupMembership... securityGroups)
A list of security groups used by the cluster
|
Cluster |
withShards(Collection<Shard> shards)
A list of shards that are members of the cluster.
|
Cluster |
withShards(Shard... shards)
A list of shards that are members of the cluster.
|
Cluster |
withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which MemoryDB retains automatic snapshots before deleting them.
|
Cluster |
withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
|
Cluster |
withSnsTopicArn(String snsTopicArn)
The Amazon Resource Name (ARN) of the SNS notification topic
|
Cluster |
withSnsTopicStatus(String snsTopicStatus)
The SNS topic must be in Active status to receive notifications
|
Cluster |
withStatus(String status)
The status of the cluster.
|
Cluster |
withSubnetGroupName(String subnetGroupName)
The name of the subnet group used by the cluster
|
Cluster |
withTLSEnabled(Boolean tLSEnabled)
A flag to indicate if In-transit encryption is enabled
|
public void setName(String name)
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
name
- The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.public String getName()
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
public Cluster withName(String name)
The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.
name
- The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.public void setDescription(String description)
A description of the cluster
description
- A description of the clusterpublic String getDescription()
A description of the cluster
public Cluster withDescription(String description)
A description of the cluster
description
- A description of the clusterpublic void setStatus(String status)
The status of the cluster. For example, Available, Updating, Creating.
status
- The status of the cluster. For example, Available, Updating, Creating.public String getStatus()
The status of the cluster. For example, Available, Updating, Creating.
public Cluster withStatus(String status)
The status of the cluster. For example, Available, Updating, Creating.
status
- The status of the cluster. For example, Available, Updating, Creating.public void setPendingUpdates(ClusterPendingUpdates pendingUpdates)
A group of settings that are currently being applied.
pendingUpdates
- A group of settings that are currently being applied.public ClusterPendingUpdates getPendingUpdates()
A group of settings that are currently being applied.
public Cluster withPendingUpdates(ClusterPendingUpdates pendingUpdates)
A group of settings that are currently being applied.
pendingUpdates
- A group of settings that are currently being applied.public void setNumberOfShards(Integer numberOfShards)
The number of shards in the cluster
numberOfShards
- The number of shards in the clusterpublic Integer getNumberOfShards()
The number of shards in the cluster
public Cluster withNumberOfShards(Integer numberOfShards)
The number of shards in the cluster
numberOfShards
- The number of shards in the clusterpublic List<Shard> getShards()
A list of shards that are members of the cluster.
public void setShards(Collection<Shard> shards)
A list of shards that are members of the cluster.
shards
- A list of shards that are members of the cluster.public Cluster withShards(Shard... shards)
A list of shards that are members of 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
- A list of shards that are members of the cluster.public Cluster withShards(Collection<Shard> shards)
A list of shards that are members of the cluster.
shards
- A list of shards that are members of the cluster.public void setAvailabilityMode(String availabilityMode)
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
availabilityMode
- Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).AZStatus
public String getAvailabilityMode()
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
AZStatus
public Cluster withAvailabilityMode(String availabilityMode)
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
availabilityMode
- Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).AZStatus
public Cluster withAvailabilityMode(AZStatus availabilityMode)
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
availabilityMode
- Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).AZStatus
public void setClusterEndpoint(Endpoint clusterEndpoint)
The cluster's configuration endpoint
clusterEndpoint
- The cluster's configuration endpointpublic Endpoint getClusterEndpoint()
The cluster's configuration endpoint
public Cluster withClusterEndpoint(Endpoint clusterEndpoint)
The cluster's configuration endpoint
clusterEndpoint
- The cluster's configuration endpointpublic void setNodeType(String nodeType)
The cluster's node type
nodeType
- The cluster's node typepublic String getNodeType()
The cluster's node type
public Cluster withNodeType(String nodeType)
The cluster's node type
nodeType
- The cluster's node typepublic void setEngineVersion(String engineVersion)
The Redis OSS engine version used by the cluster
engineVersion
- The Redis OSS engine version used by the clusterpublic String getEngineVersion()
The Redis OSS engine version used by the cluster
public Cluster withEngineVersion(String engineVersion)
The Redis OSS engine version used by the cluster
engineVersion
- The Redis OSS engine version used by the clusterpublic void setEnginePatchVersion(String enginePatchVersion)
The Redis OSS engine patch version used by the cluster
enginePatchVersion
- The Redis OSS engine patch version used by the clusterpublic String getEnginePatchVersion()
The Redis OSS engine patch version used by the cluster
public Cluster withEnginePatchVersion(String enginePatchVersion)
The Redis OSS engine patch version used by the cluster
enginePatchVersion
- The Redis OSS engine patch version used by the clusterpublic void setParameterGroupName(String parameterGroupName)
The name of the parameter group used by the cluster
parameterGroupName
- The name of the parameter group used by the clusterpublic String getParameterGroupName()
The name of the parameter group used by the cluster
public Cluster withParameterGroupName(String parameterGroupName)
The name of the parameter group used by the cluster
parameterGroupName
- The name of the parameter group used by the clusterpublic void setParameterGroupStatus(String parameterGroupStatus)
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
parameterGroupStatus
- The status of the parameter group used by the cluster, for example 'active' or 'applying'.public String getParameterGroupStatus()
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
public Cluster withParameterGroupStatus(String parameterGroupStatus)
The status of the parameter group used by the cluster, for example 'active' or 'applying'.
parameterGroupStatus
- The status of the parameter group used by the cluster, for example 'active' or 'applying'.public List<SecurityGroupMembership> getSecurityGroups()
A list of security groups used by the cluster
public void setSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of security groups used by the cluster
securityGroups
- A list of security groups used by the clusterpublic Cluster withSecurityGroups(SecurityGroupMembership... securityGroups)
A list of security groups used by the cluster
NOTE: This method appends the values to the existing list (if any). Use
setSecurityGroups(java.util.Collection)
or withSecurityGroups(java.util.Collection)
if you want
to override the existing values.
securityGroups
- A list of security groups used by the clusterpublic Cluster withSecurityGroups(Collection<SecurityGroupMembership> securityGroups)
A list of security groups used by the cluster
securityGroups
- A list of security groups used by the clusterpublic void setSubnetGroupName(String subnetGroupName)
The name of the subnet group used by the cluster
subnetGroupName
- The name of the subnet group used by the clusterpublic String getSubnetGroupName()
The name of the subnet group used by the cluster
public Cluster withSubnetGroupName(String subnetGroupName)
The name of the subnet group used by the cluster
subnetGroupName
- The name of the subnet group used by the clusterpublic void setTLSEnabled(Boolean tLSEnabled)
A flag to indicate if In-transit encryption is enabled
tLSEnabled
- A flag to indicate if In-transit encryption is enabledpublic Boolean getTLSEnabled()
A flag to indicate if In-transit encryption is enabled
public Cluster withTLSEnabled(Boolean tLSEnabled)
A flag to indicate if In-transit encryption is enabled
tLSEnabled
- A flag to indicate if In-transit encryption is enabledpublic Boolean isTLSEnabled()
A flag to indicate if In-transit encryption is enabled
public void setKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the cluster
kmsKeyId
- The ID of the KMS key used to encrypt the clusterpublic String getKmsKeyId()
The ID of the KMS key used to encrypt the cluster
public Cluster withKmsKeyId(String kmsKeyId)
The ID of the KMS key used to encrypt the cluster
kmsKeyId
- The ID of the KMS key used to encrypt the clusterpublic void setARN(String aRN)
The Amazon Resource Name (ARN) of the cluster.
aRN
- The Amazon Resource Name (ARN) of the cluster.public String getARN()
The Amazon Resource Name (ARN) of the cluster.
public Cluster withARN(String aRN)
The Amazon Resource Name (ARN) of the cluster.
aRN
- The Amazon Resource Name (ARN) of the cluster.public void setSnsTopicArn(String snsTopicArn)
The Amazon Resource Name (ARN) of the SNS notification topic
snsTopicArn
- The Amazon Resource Name (ARN) of the SNS notification topicpublic String getSnsTopicArn()
The Amazon Resource Name (ARN) of the SNS notification topic
public Cluster withSnsTopicArn(String snsTopicArn)
The Amazon Resource Name (ARN) of the SNS notification topic
snsTopicArn
- The Amazon Resource Name (ARN) of the SNS notification topicpublic void setSnsTopicStatus(String snsTopicStatus)
The SNS topic must be in Active status to receive notifications
snsTopicStatus
- The SNS topic must be in Active status to receive notificationspublic String getSnsTopicStatus()
The SNS topic must be in Active status to receive notifications
public Cluster withSnsTopicStatus(String snsTopicStatus)
The SNS topic must be in Active status to receive notifications
snsTopicStatus
- The SNS topic must be in Active status to receive notificationspublic void setSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshotRetentionLimit
- The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if
you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being
deleted.public Integer getSnapshotRetentionLimit()
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
public Cluster withSnapshotRetentionLimit(Integer snapshotRetentionLimit)
The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
snapshotRetentionLimit
- The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if
you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being
deleted.public void setMaintenanceWindow(String maintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
maintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a
range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute
period.public String getMaintenanceWindow()
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
public Cluster withMaintenanceWindow(String maintenanceWindow)
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
maintenanceWindow
- Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a
range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute
period.public void setSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
snapshotWindow
- The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example:
05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time
range.public String getSnapshotWindow()
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
public Cluster withSnapshotWindow(String snapshotWindow)
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
snapshotWindow
- The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example:
05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time
range.public void setACLName(String aCLName)
The name of the Access Control List associated with this cluster.
aCLName
- The name of the Access Control List associated with this cluster.public String getACLName()
The name of the Access Control List associated with this cluster.
public Cluster withACLName(String aCLName)
The name of the Access Control List associated with this cluster.
aCLName
- The name of the Access Control List associated with this cluster.public void setAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
autoMinorVersionUpgrade
- When set to true, the cluster will automatically receive minor engine version upgrades after launch.public Boolean getAutoMinorVersionUpgrade()
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
public Cluster withAutoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
autoMinorVersionUpgrade
- When set to true, the cluster will automatically receive minor engine version upgrades after launch.public Boolean isAutoMinorVersionUpgrade()
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
public void setDataTiering(String dataTiering)
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
dataTiering
- Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter
must be set when using r6gd nodes. For more information, see Data tiering.DataTieringStatus
public String getDataTiering()
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
DataTieringStatus
public Cluster withDataTiering(String dataTiering)
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
dataTiering
- Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter
must be set when using r6gd nodes. For more information, see Data tiering.DataTieringStatus
public Cluster withDataTiering(DataTieringStatus dataTiering)
Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see Data tiering.
dataTiering
- Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter
must be set when using r6gd nodes. For more information, see Data tiering.DataTieringStatus
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.