EkmsPrivateEndpointSummary¶

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

Bases: object

EKMS private endpoints summary

Attributes

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

Methods

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new EkmsPrivateEndpointSummary 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 EkmsPrivateEndpointSummary.
subnet_id (str) – The value to assign to the subnet_id property of this EkmsPrivateEndpointSummary.
compartment_id (str) – The value to assign to the compartment_id property of this EkmsPrivateEndpointSummary.
time_created (datetime) – The value to assign to the time_created property of this EkmsPrivateEndpointSummary.
time_updated (datetime) – The value to assign to the time_updated property of this EkmsPrivateEndpointSummary.
display_name (str) – The value to assign to the display_name property of this EkmsPrivateEndpointSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this EkmsPrivateEndpointSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this EkmsPrivateEndpointSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this EkmsPrivateEndpointSummary. 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’.

compartment_id¶

[Required] Gets the compartment_id of this EkmsPrivateEndpointSummary. Identifier of the compartment this EKMS private endpoint belongs to

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

defined_tags¶

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

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

display_name¶

[Required] Gets the display_name of this EkmsPrivateEndpointSummary. Mutable name of the EKMS private endpoint

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

freeform_tags¶

Gets the freeform_tags of this EkmsPrivateEndpointSummary. 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 EkmsPrivateEndpointSummary.
Return type:	dict(str, str)

id¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this EkmsPrivateEndpointSummary. 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 EkmsPrivateEndpointSummary.
Return type:	str

subnet_id¶

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

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

time_created¶

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

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

time_updated¶

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

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