Class XksProxyConfigurationType
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The part of the external key store proxy authentication credential that uniquely identifies the secret access key.builder()
final XksProxyConnectivityType
Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.final String
Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends XksProxyConfigurationType.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The URI endpoint for the external key store proxy.final String
uriPath()
The path to the external key store proxy APIs.final String
The Amazon VPC endpoint service used to communicate with the external key store proxy.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnXksProxyConnectivityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectivityAsString()
.- 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
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 returnXksProxyConnectivityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromconnectivityAsString()
.- 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
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
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
The path to the external key store proxy APIs.
- Returns:
- The path to the external key store proxy APIs.
-
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.
-
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 interfaceToCopyableBuilder<XksProxyConfigurationType.Builder,
XksProxyConfigurationType> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-