Class ClusterConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClusterConfiguration.Builder,
ClusterConfiguration>
A list of cluster configuration options.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ClusterConfiguration.Builder
builder()
final String
The description of the cluster configurationfinal String
engine()
The name of the engine used by the cluster configuration.final String
The Redis OSS engine version used by the clusterfinal boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Shards property.final String
The specified maintenance window for the clusterfinal String
The name for the multi-Region cluster associated with the cluster configuration.final String
The name of the multi-Region parameter group associated with the cluster configuration.final String
name()
The name of the clusterfinal String
nodeType()
The node type used for the clusterfinal Integer
The number of shards in the clusterfinal String
The name of parameter group used by the clusterfinal Integer
port()
The port used by the clusterstatic Class
<? extends ClusterConfiguration.Builder> final List
<ShardDetail> shards()
The list of shards in the clusterfinal Integer
The snapshot retention limit set by the clusterfinal String
The snapshot window set by the clusterfinal String
The name of the subnet group used by the clusterTake this object and create a builder that contains all of the current property values of this object.final String
topicArn()
The Amazon Resource Name (ARN) of the SNS notification topic for the clusterfinal String
toString()
Returns a string representation of this object.final String
vpcId()
The ID of the VPC the cluster belongs toMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
-
description
The description of the cluster configuration
- Returns:
- The description of the cluster configuration
-
nodeType
The node type used for the cluster
- Returns:
- The node type used for the cluster
-
engine
The name of the engine used by the cluster configuration.
- Returns:
- The name of the engine used by the cluster configuration.
-
engineVersion
The Redis OSS engine version used by the cluster
- Returns:
- The Redis OSS engine version used by the cluster
-
maintenanceWindow
The specified maintenance window for the cluster
- Returns:
- The specified maintenance window for the cluster
-
topicArn
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
- Returns:
- The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
-
port
-
parameterGroupName
The name of parameter group used by the cluster
- Returns:
- The name of parameter group used by the cluster
-
subnetGroupName
The name of the subnet group used by the cluster
- Returns:
- The name of the subnet group used by the cluster
-
vpcId
The ID of the VPC the cluster belongs to
- Returns:
- The ID of the VPC the cluster belongs to
-
snapshotRetentionLimit
The snapshot retention limit set by the cluster
- Returns:
- The snapshot retention limit set by the cluster
-
snapshotWindow
The snapshot window set by the cluster
- Returns:
- The snapshot window set by the cluster
-
numShards
The number of shards in the cluster
- Returns:
- The number of shards in the cluster
-
hasShards
public final boolean hasShards()For responses, this returns true if the service returned a value for the Shards property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
shards
The list of shards in the cluster
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasShards()
method.- Returns:
- The list of shards in the cluster
-
multiRegionParameterGroupName
The name of the multi-Region parameter group associated with the cluster configuration.
- Returns:
- The name of the multi-Region parameter group associated with the cluster configuration.
-
multiRegionClusterName
The name for the multi-Region cluster associated with the cluster configuration.
- Returns:
- The name for the multi-Region cluster associated with the cluster configuration.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ClusterConfiguration.Builder,
ClusterConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-