@Generated(value="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.
Modifier and Type | Class and Description |
---|---|
static interface |
MultiRegionConfiguration.Builder |
Modifier and Type | Method and 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.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends MultiRegionConfiguration.Builder> |
serializableBuilderClass() |
MultiRegionConfiguration.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
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()
.
PRIMARY
or REPLICA
key.MultiRegionKeyType
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()
.
PRIMARY
or REPLICA
key.MultiRegionKeyType
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.
public final boolean hasReplicaKeys()
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.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.
public MultiRegionConfiguration.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<MultiRegionConfiguration.Builder,MultiRegionConfiguration>
public static MultiRegionConfiguration.Builder builder()
public static Class<? extends MultiRegionConfiguration.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2022. All rights reserved.