EkmsPrivateEndpoint¶

class oci.key_management.models.EkmsPrivateEndpoint(**kwargs)¶

Bases: object

EKMS private endpoint created in customer subnet used to connect to external key manager system

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint.
`ca_bundle`	Gets the ca_bundle of this EkmsPrivateEndpoint.
`compartment_id`	[Required] Gets the compartment_id of this EkmsPrivateEndpoint.
`defined_tags`	Gets the defined_tags of this EkmsPrivateEndpoint.
`display_name`	[Required] Gets the display_name of this EkmsPrivateEndpoint.
`external_key_manager_ip`	[Required] Gets the external_key_manager_ip of this EkmsPrivateEndpoint.
`freeform_tags`	Gets the freeform_tags of this EkmsPrivateEndpoint.
`id`	[Required] Gets the id of this EkmsPrivateEndpoint.
`lifecycle_details`	Gets the lifecycle_details of this EkmsPrivateEndpoint.
`lifecycle_state`	[Required] Gets the lifecycle_state of this EkmsPrivateEndpoint.
`port`	Gets the port of this EkmsPrivateEndpoint.
`private_endpoint_ip`	Gets the private_endpoint_ip of this EkmsPrivateEndpoint.
`subnet_id`	[Required] Gets the subnet_id of this EkmsPrivateEndpoint.
`time_created`	[Required] Gets the time_created of this EkmsPrivateEndpoint.
`time_updated`	Gets the time_updated of this EkmsPrivateEndpoint.

Methods

__init__(**kwargs) Initializes a new EkmsPrivateEndpoint object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a EkmsPrivateEndpoint. This constant has a value of “FAILED”

__init__(**kwargs)¶

Initializes a new EkmsPrivateEndpoint object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this EkmsPrivateEndpoint.
compartment_id (str) – The value to assign to the compartment_id property of this EkmsPrivateEndpoint.
subnet_id (str) – The value to assign to the subnet_id property of this EkmsPrivateEndpoint.
display_name (str) – The value to assign to the display_name property of this EkmsPrivateEndpoint.
time_created (datetime) – The value to assign to the time_created property of this EkmsPrivateEndpoint.
time_updated (datetime) – The value to assign to the time_updated property of this EkmsPrivateEndpoint.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EkmsPrivateEndpoint.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EkmsPrivateEndpoint.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EkmsPrivateEndpoint. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this EkmsPrivateEndpoint.
external_key_manager_ip (str) – The value to assign to the external_key_manager_ip property of this EkmsPrivateEndpoint.
port (int) – The value to assign to the port property of this EkmsPrivateEndpoint.
ca_bundle (str) – The value to assign to the ca_bundle property of this EkmsPrivateEndpoint.
private_endpoint_ip (str) – The value to assign to the private_endpoint_ip property of this EkmsPrivateEndpoint.

ca_bundle¶

Gets the ca_bundle of this EkmsPrivateEndpoint. CABundle to validate TLS certificate of the external key manager system in PEM format

Returns:	The ca_bundle of this EkmsPrivateEndpoint.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this EkmsPrivateEndpoint. Compartment Identifier.

Returns:	The compartment_id of this EkmsPrivateEndpoint.
Return type:	str

defined_tags¶

Gets the defined_tags of this EkmsPrivateEndpoint. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this EkmsPrivateEndpoint.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this EkmsPrivateEndpoint. EKMS Private Endpoint display name

Returns:	The display_name of this EkmsPrivateEndpoint.
Return type:	str

external_key_manager_ip¶

[Required] Gets the external_key_manager_ip of this EkmsPrivateEndpoint. Private IP of the external key manager system to connect to from the EKMS private endpoint

Returns:	The external_key_manager_ip of this EkmsPrivateEndpoint.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this EkmsPrivateEndpoint. Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this EkmsPrivateEndpoint.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this EkmsPrivateEndpoint. Unique identifier that is immutable

Returns:	The id of this EkmsPrivateEndpoint.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this EkmsPrivateEndpoint. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in ‘Failed’ state.

Returns:	The lifecycle_details of this EkmsPrivateEndpoint.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this EkmsPrivateEndpoint. The current state of the EKMS private endpoint resource.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this EkmsPrivateEndpoint.
Return type:	str

port¶

Gets the port of this EkmsPrivateEndpoint. The port of the external key manager system

Returns:	The port of this EkmsPrivateEndpoint.
Return type:	int

private_endpoint_ip¶

Gets the private_endpoint_ip of this EkmsPrivateEndpoint. The IP address in the customer’s VCN for the EKMS private endpoint. This is taken from subnet

Returns:	The private_endpoint_ip of this EkmsPrivateEndpoint.
Return type:	str

subnet_id¶

[Required] Gets the subnet_id of this EkmsPrivateEndpoint. Subnet Identifier

Returns:	The subnet_id of this EkmsPrivateEndpoint.
Return type:	str

time_created¶

[Required] Gets the time_created of this EkmsPrivateEndpoint. The time the EKMS private endpoint was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this EkmsPrivateEndpoint.
Return type:	datetime

time_updated¶

Gets the time_updated of this EkmsPrivateEndpoint. The time the EKMS private endpoint was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this EkmsPrivateEndpoint.
Return type:	datetime