Class CreateMultiRegionClusterRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.memorydb.model.MemoryDbRequest
software.amazon.awssdk.services.memorydb.model.CreateMultiRegionClusterRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateMultiRegionClusterRequest.Builder,CreateMultiRegionClusterRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMultiRegionClusterRequest extends MemoryDbRequest implements ToCopyableBuilder<CreateMultiRegionClusterRequest.Builder,CreateMultiRegionClusterRequest>

  • Method Details

    • multiRegionClusterNameSuffix

      public final String multiRegionClusterNameSuffix()

      A suffix to be added to the Multi-Region cluster name. Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.

      Returns:
      A suffix to be added to the Multi-Region cluster name. Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.

    • description

      public final String description()

      A description for the multi-Region cluster.

      Returns:
      A description for the multi-Region cluster.

    • engine

      public final String engine()

      The name of the engine to be used for the multi-Region cluster.

      Returns:
      The name of the engine to be used for the multi-Region cluster.

    • engineVersion

      public final String engineVersion()

      The version of the engine to be used for the multi-Region cluster.

      Returns:
      The version of the engine to be used for the multi-Region cluster.

    • nodeType

      public final String nodeType()

      The node type to be used for the multi-Region cluster.

      Returns:
      The node type to be used for the multi-Region cluster.

    • multiRegionParameterGroupName

      public final String multiRegionParameterGroupName()

      The name of the multi-Region parameter group to be associated with the cluster.

      Returns:
      The name of the multi-Region parameter group to be associated with the cluster.

    • numShards

      public final Integer numShards()

      The number of shards for the multi-Region cluster.

      Returns:
      The number of shards for the multi-Region cluster.

    • tlsEnabled

      public final Boolean tlsEnabled()

      Whether to enable TLS encryption for the multi-Region cluster.

      Returns:
      Whether to enable TLS encryption for the multi-Region cluster.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • tags

      public final List<Tag> tags()

      A list of tags to be applied to the multi-Region 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 hasTags() method.

      Returns:
      A list of tags to be applied to the multi-Region cluster.

    • toBuilder

      public CreateMultiRegionClusterRequest.Builder 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 interface ToCopyableBuilder<CreateMultiRegionClusterRequest.Builder,CreateMultiRegionClusterRequest>
      Specified by:
      toBuilder in class MemoryDbRequest
      Returns:
      a builder for type T

    • builder

      public static CreateMultiRegionClusterRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateMultiRegionClusterRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.