AWSKMSXksProxyConfigurationType

Objective-C

@interface AWSKMSXksProxyConfigurationType

Swift

class AWSKMSXksProxyConfigurationType

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.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable accessKeyId;

    Swift

    var accessKeyId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSKMSXksProxyConnectivityType connectivity;

    Swift

    var connectivity: AWSKMSXksProxyConnectivityType { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable uriEndpoint;

    Swift

    var uriEndpoint: String? { get set }

  • The path to the external key store proxy APIs.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable uriPath;

    Swift

    var uriPath: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable vpcEndpointServiceName;

    Swift

    var vpcEndpointServiceName: String? { get set }