Skip to content

XksProxyConfigurationType

Source code in docs_src/capo_kms/types/xks_proxy_configuration_type.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class XksProxyConfigurationType(TypedDict, closed=True):
    connectivity: NotRequired[
        "capo_kms.types.xks_proxy_connectivity_type.XksProxyConnectivityType"
    ]
    """<p>Indicates whether the external key store proxy uses a public endpoint or an Amazon VPC endpoint service to communicate with KMS.</p>"""
    access_key_id: NotRequired[
        "capo_kms.types.xks_proxy_authentication_access_key_id_type.XksProxyAuthenticationAccessKeyIdType"
    ]
    """<p>The part of the external key store <a href="https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateCustomKeyStore.html#KMS-CreateCustomKeyStore-request-XksProxyAuthenticationCredential">proxy authentication credential</a> that uniquely identifies the secret access key.</p>"""
    uri_endpoint: NotRequired[
        "capo_kms.types.xks_proxy_uri_endpoint_type.XksProxyUriEndpointType"
    ]
    """<p>The URI endpoint for the external key store proxy.</p> <p>If the external key store proxy has a public endpoint, it is displayed here.</p> <p>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.</p>"""
    uri_path: NotRequired["capo_kms.types.xks_proxy_uri_path_type.XksProxyUriPathType"]
    """<p>The path to the external key store proxy APIs.</p>"""
    vpc_endpoint_service_name: NotRequired[
        "capo_kms.types.xks_proxy_vpc_endpoint_service_name_type.XksProxyVpcEndpointServiceNameType"
    ]
    """<p>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.</p>"""
    vpc_endpoint_service_owner: NotRequired[
        "capo_kms.types.account_id_type.AccountIdType"
    ]
    """<p>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.</p>"""

access_key_id instance-attribute 

access_key_id: NotRequired[XksProxyAuthenticationAccessKeyIdType]

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

connectivity instance-attribute 

connectivity: NotRequired[XksProxyConnectivityType]

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

uri_endpoint instance-attribute 

uri_endpoint: NotRequired[XksProxyUriEndpointType]

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 instance-attribute 

uri_path: NotRequired[XksProxyUriPathType]

The path to the external key store proxy APIs.

vpc_endpoint_service_name instance-attribute 

vpc_endpoint_service_name: NotRequired[XksProxyVpcEndpointServiceNameType]

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 instance-attribute 

vpc_endpoint_service_owner: NotRequired[AccountIdType]

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.