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

Class XksProxyConfigurationType

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

Detailed information about the external key store proxy (XKS proxy). Your external key store proxy translates KMS requests into a format that your external key manager can understand. These fields appear in a DescribeCustomKeyStores response only when the CustomKeyStoreType is EXTERNAL_KEY_STORE.

See Also:

  • Method Details

    • connectivity

      public final XksProxyConnectivityType connectivity()

      Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.

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

      Returns:
      Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.
      See Also:

    • connectivityAsString

      public final String connectivityAsString()

      Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.

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

      Returns:
      Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.
      See Also:

    • accessKeyId

      public final String accessKeyId()

      The part of the external key store proxy authentication credential that uniquely identifies the secret access key.

      Returns:
      The part of the external key store proxy authentication credential that uniquely identifies the secret access key.

    • uriEndpoint

      public final String uriEndpoint()

      The URI endpoint for the external key store proxy.

      If the external key store proxy has a public endpoint, it is displayed here.

      If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.

      Returns:
      The URI endpoint for the external key store proxy.

      If the external key store proxy has a public endpoint, it is displayed here.

      If the external key store proxy uses an Amazon VPC endpoint service name, this field displays the private DNS name associated with the VPC endpoint service.

    • uriPath

      public final String uriPath()

      The path to the external key store proxy APIs.

      Returns:
      The path to the external key store proxy APIs.

    • vpcEndpointServiceName

      public final String vpcEndpointServiceName()

      The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.

      Returns:
      The Amazon VPC endpoint service used to communicate with the external key store proxy. This field appears only when the external key store proxy uses an Amazon VPC endpoint service to communicate with KMS.

    • vpcEndpointServiceOwner

      public final String vpcEndpointServiceOwner()

      The Amazon Web Services account ID that owns the Amazon VPC endpoint service used to communicate with the external key store proxy (XKS). This field appears only when the XKS uses an VPC endpoint service to communicate with KMS.

      Returns:
      The Amazon Web Services account ID that owns the Amazon VPC endpoint service used to communicate with the external key store proxy (XKS). This field appears only when the XKS uses an VPC endpoint service to communicate with KMS.

    • toBuilder

      public XksProxyConfigurationType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<XksProxyConfigurationType.Builder,XksProxyConfigurationType>

    • builder

      public static XksProxyConfigurationType.Builder builder()

    • serializableBuilderClass

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