Skip to content

KMS  >  Structures  >  XksProxyConfigurationType

XksProxyConfigurationType

Structure Class

XksProxyConfigurationType dataclass

Bases: _SerdeShape

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.

Attributes

access_key_id class-attribute instance-attribute 
access_key_id: str | None = ...

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

connectivity class-attribute instance-attribute 
connectivity: str | None = ...

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

uri_endpoint class-attribute instance-attribute 
uri_endpoint: str | None = ...

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.

uri_path class-attribute instance-attribute 
uri_path: str | None = ...

The path to the external key store proxy APIs.

vpc_endpoint_service_name class-attribute instance-attribute 
vpc_endpoint_service_name: str | None = ...

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.

vpc_endpoint_service_owner class-attribute instance-attribute 
vpc_endpoint_service_owner: str | None = ...

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.