class Amazonite::Kms::XksProxyConfigurationType

Overview

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.

Included Modules

Defined in:

kms/xks_proxy_configuration_type.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(connectivity : XksProxyConnectivityType | Nil = nil, access_key_id : String | Nil = nil, uri_endpoint : String | Nil = nil, uri_path : String | Nil = nil, vpc_endpoint_service_name : String | Nil = nil, vpc_endpoint_service_owner : String | Nil = nil) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def access_key_id : String | Nil #

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


[View source]
def access_key_id=(access_key_id : String | Nil) #

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


[View source]
def connectivity : XksProxyConnectivityType | Nil #

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


[View source]
def connectivity=(connectivity : XksProxyConnectivityType | Nil) #

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


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def uri_endpoint : String | Nil #

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.


[View source]
def uri_endpoint=(uri_endpoint : String | Nil) #

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.


[View source]
def uri_path : String | Nil #

The path to the external key store proxy APIs.


[View source]
def uri_path=(uri_path : String | Nil) #

The path to the external key store proxy APIs.


[View source]
def validate! : Nil #

[View source]
def vpc_endpoint_service_name : String | Nil #

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.


[View source]
def vpc_endpoint_service_name=(vpc_endpoint_service_name : String | Nil) #

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.


[View source]
def vpc_endpoint_service_owner : String | Nil #

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.


[View source]
def vpc_endpoint_service_owner=(vpc_endpoint_service_owner : String | Nil) #

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.


[View source]