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

Class XksKeyConfigurationType

java.lang.Object

software.amazon.awssdk.services.kms.model.XksKeyConfigurationType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<XksKeyConfigurationType.Builder,XksKeyConfigurationType>

@Generated("software.amazon.awssdk:codegen")
public final class XksKeyConfigurationType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<XksKeyConfigurationType.Builder,XksKeyConfigurationType>

Information about the external key that is associated with a KMS key in an external key store.

This element appears in a CreateKey or DescribeKey response only for a KMS key in an external key store.

The external key is a symmetric encryption key that is hosted by an external key manager outside of Amazon Web Services. When you use the KMS key in an external key store in a cryptographic operation, the cryptographic operation is performed in the external key manager using the specified external key. For more information, see External key in the Key Management Service Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	XksKeyConfigurationType.Builder

Method Summary

Modifier and Type	Method	Description
static XksKeyConfigurationType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID of the external key in its external key manager.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends XksKeyConfigurationType.Builder>	serializableBuilderClass()
XksKeyConfigurationType.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

id

public final String id()

The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

Returns:

The ID of the external key in its external key manager. This is the ID that the external key store proxy uses to identify the external key.

toBuilder

public XksKeyConfigurationType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<XksKeyConfigurationType.Builder,XksKeyConfigurationType>

builder

public static XksKeyConfigurationType.Builder builder()

serializableBuilderClass

public static Class<? extends XksKeyConfigurationType.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