Lockbox¶

class oci.lockbox.models.Lockbox(**kwargs)¶

Bases: object

Description of Lockbox.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Lockbox.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Lockbox.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Lockbox.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Lockbox.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Lockbox.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Lockbox.
`LOCKBOX_PARTNER_CANARY`	A constant which can be used with the lockbox_partner property of a Lockbox.
`LOCKBOX_PARTNER_FAAAS`	A constant which can be used with the lockbox_partner property of a Lockbox.
`access_context_attributes`	Gets the access_context_attributes of this Lockbox.
`approval_template_id`	Gets the approval_template_id of this Lockbox.
`compartment_id`	[Required] Gets the compartment_id of this Lockbox.
`defined_tags`	[Required] Gets the defined_tags of this Lockbox.
`display_name`	[Required] Gets the display_name of this Lockbox.
`freeform_tags`	[Required] Gets the freeform_tags of this Lockbox.
`id`	[Required] Gets the id of this Lockbox.
`lifecycle_details`	Gets the lifecycle_details of this Lockbox.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Lockbox.
`lockbox_partner`	Gets the lockbox_partner of this Lockbox.
`max_access_duration`	Gets the max_access_duration of this Lockbox.
`parent_lockbox_id`	Gets the parent_lockbox_id of this Lockbox.
`partner_compartment_id`	Gets the partner_compartment_id of this Lockbox.
`partner_id`	Gets the partner_id of this Lockbox.
`resource_id`	[Required] Gets the resource_id of this Lockbox.
`system_tags`	Gets the system_tags of this Lockbox.
`time_created`	[Required] Gets the time_created of this Lockbox.
`time_updated`	Gets the time_updated of this Lockbox.

Methods

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

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

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

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

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

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Lockbox. This constant has a value of “UPDATING”

LOCKBOX_PARTNER_CANARY = 'CANARY'¶: A constant which can be used with the lockbox_partner property of a Lockbox. This constant has a value of “CANARY”

LOCKBOX_PARTNER_FAAAS = 'FAAAS'¶: A constant which can be used with the lockbox_partner property of a Lockbox. This constant has a value of “FAAAS”

__init__(**kwargs)¶

Initializes a new Lockbox 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 Lockbox.
display_name (str) – The value to assign to the display_name property of this Lockbox.
compartment_id (str) – The value to assign to the compartment_id property of this Lockbox.
partner_id (str) – The value to assign to the partner_id property of this Lockbox.
parent_lockbox_id (str) – The value to assign to the parent_lockbox_id property of this Lockbox.
partner_compartment_id (str) – The value to assign to the partner_compartment_id property of this Lockbox.
resource_id (str) – The value to assign to the resource_id property of this Lockbox.
lockbox_partner (str) – The value to assign to the lockbox_partner property of this Lockbox. Allowed values for this property are: “FAAAS”, “CANARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this Lockbox.
time_updated (datetime) – The value to assign to the time_updated property of this Lockbox.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Lockbox. Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
access_context_attributes (oci.lockbox.models.AccessContextAttributeCollection) – The value to assign to the access_context_attributes property of this Lockbox.
approval_template_id (str) – The value to assign to the approval_template_id property of this Lockbox.
max_access_duration (str) – The value to assign to the max_access_duration property of this Lockbox.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this Lockbox.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Lockbox.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Lockbox.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Lockbox.

access_context_attributes¶

Gets the access_context_attributes of this Lockbox.

Returns:	The access_context_attributes of this Lockbox.
Return type:	oci.lockbox.models.AccessContextAttributeCollection

approval_template_id¶

Gets the approval_template_id of this Lockbox. Approval template ID

Returns:	The approval_template_id of this Lockbox.
Return type:	str

compartment_id¶

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

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

defined_tags¶

[Required] Gets the defined_tags of this Lockbox. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

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

display_name¶

[Required] Gets the display_name of this Lockbox. Lockbox Identifier, can be renamed

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

freeform_tags¶

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

id¶

[Required] Gets the id of this Lockbox. Unique identifier that is immutable on creation

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

lifecycle_details¶

Gets the lifecycle_details of this Lockbox. 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 Lockbox.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Lockbox. The current state of the Lockbox.

Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “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 Lockbox.
Return type:	str

lockbox_partner¶

Gets the lockbox_partner of this Lockbox. The partner using this lockbox to lock a resource.

Allowed values for this property are: “FAAAS”, “CANARY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lockbox_partner of this Lockbox.
Return type:	str

max_access_duration¶

Gets the max_access_duration of this Lockbox. The maximum amount of time operator has access to associated resources.

Returns:	The max_access_duration of this Lockbox.
Return type:	str

parent_lockbox_id¶

Gets the parent_lockbox_id of this Lockbox. The unique identifier (OCID) of lockbox resource using to reference parent lockbox in hybrid oma setup

Returns:	The parent_lockbox_id of this Lockbox.
Return type:	str

partner_compartment_id¶

Gets the partner_compartment_id of this Lockbox. Compartment Identifier

Returns:	The partner_compartment_id of this Lockbox.
Return type:	str

partner_id¶

Gets the partner_id of this Lockbox. The unique identifier (OCID) of partner resource using this lockbox to lock a resource

Returns:	The partner_id of this Lockbox.
Return type:	str

resource_id¶

[Required] Gets the resource_id of this Lockbox. The unique identifier (OCID) of associated resource that the lockbox is created for.

Returns:	The resource_id of this Lockbox.
Return type:	str

system_tags¶

Gets the system_tags of this Lockbox. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this Lockbox.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this Lockbox. The time the the Lockbox was created. An RFC3339 formatted datetime string

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

time_updated¶

Gets the time_updated of this Lockbox. The time the Lockbox was updated. An RFC3339 formatted datetime string

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