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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MultiRegionConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static MultiRegionConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReplicaKeys()	For responses, this returns true if the service returned a value for the ReplicaKeys property.
MultiRegionKeyType	multiRegionKeyType()	Indicates whether the KMS key is a PRIMARY or REPLICA key.
String	multiRegionKeyTypeAsString()	Indicates whether the KMS key is a PRIMARY or REPLICA key.
MultiRegionKey	primaryKey()	Displays the key ARN and Region of the primary key.
List<MultiRegionKey>	replicaKeys()	displays the key ARNs and Regions of all replica keys.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MultiRegionConfiguration.Builder>	serializableBuilderClass()
MultiRegionConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

MultiRegionKeyType

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:

MultiRegionKeyType

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

Specified by:

toBuilder in interface ToCopyableBuilder<MultiRegionConfiguration.Builder,MultiRegionConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo