Package software.amazon.awssdk.services.kms.model

Class MultiRegionConfiguration

java.lang.Object
software.amazon.awssdk.services.kms.model.MultiRegionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MultiRegionConfiguration.Builder,MultiRegionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class MultiRegionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MultiRegionConfiguration.Builder,MultiRegionConfiguration>

Describes the configuration of this multi-Region key. This field appears only when the KMS key is a primary or replica of a multi-Region key.

For more information about any listed KMS key, use the DescribeKey operation.

See Also:

  • Method Details

    • multiRegionKeyType

      public final MultiRegionKeyType multiRegionKeyType()

      Indicates whether the KMS key is a PRIMARY or REPLICA key.

      If the service returns an enum value that is not available in the current SDK version, multiRegionKeyType will return MultiRegionKeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from multiRegionKeyTypeAsString().

      Returns:
      Indicates whether the KMS key is a PRIMARY or REPLICA key.
      See Also:

    • multiRegionKeyTypeAsString

      public final String multiRegionKeyTypeAsString()

      Indicates whether the KMS key is a PRIMARY or REPLICA key.

      If the service returns an enum value that is not available in the current SDK version, multiRegionKeyType will return MultiRegionKeyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from multiRegionKeyTypeAsString().

      Returns:
      Indicates whether the KMS key is a PRIMARY or REPLICA key.
      See Also:

    • primaryKey

      public final MultiRegionKey primaryKey()

      Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

      Returns:
      Displays the key ARN and Region of the primary key. This field includes the current KMS key if it is the primary key.

    • hasReplicaKeys

      public final boolean hasReplicaKeys()
      For responses, this returns true if the service returned a value for the ReplicaKeys 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.

    • replicaKeys

      public final List<MultiRegionKey> replicaKeys()

      displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

      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 hasReplicaKeys() method.

      Returns:
      displays the key ARNs and Regions of all replica keys. This field includes the current KMS key if it is a replica key.

    • toBuilder

      public MultiRegionConfiguration.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<MultiRegionConfiguration.Builder,MultiRegionConfiguration>
      Returns:
      a builder for type T

    • builder

      public static MultiRegionConfiguration.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.