OperatorControlAssignment¶

class oci.operator_access_control.models.OperatorControlAssignment(**kwargs)¶

Bases: object

An Operator Control Assignment identifies the target resource that is placed under the governance of an Operator Control. Creating an Operator Control Assignment Assignment with a time duration ensures that human accesses to the target resource will be governed by Operator Control for the duration specified.

Attributes

`LIFECYCLE_STATE_APPLIED`	A constant which can be used with the lifecycle_state property of a OperatorControlAssignment.
`LIFECYCLE_STATE_APPLYFAILED`	A constant which can be used with the lifecycle_state property of a OperatorControlAssignment.
`LIFECYCLE_STATE_CREATED`	A constant which can be used with the lifecycle_state property of a OperatorControlAssignment.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OperatorControlAssignment.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OperatorControlAssignment.
`LIFECYCLE_STATE_DELETIONFAILED`	A constant which can be used with the lifecycle_state property of a OperatorControlAssignment.
`LIFECYCLE_STATE_UPDATEFAILED`	A constant which can be used with the lifecycle_state property of a OperatorControlAssignment.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OperatorControlAssignment.
`RESOURCE_TYPE_AUTONOMOUSVMCLUSTER`	A constant which can be used with the resource_type property of a OperatorControlAssignment.
`RESOURCE_TYPE_CCCINFRASTRUCTURE`	A constant which can be used with the resource_type property of a OperatorControlAssignment.
`RESOURCE_TYPE_CLOUDAUTONOMOUSVMCLUSTER`	A constant which can be used with the resource_type property of a OperatorControlAssignment.
`RESOURCE_TYPE_EXACC`	A constant which can be used with the resource_type property of a OperatorControlAssignment.
`RESOURCE_TYPE_EXADATAINFRASTRUCTURE`	A constant which can be used with the resource_type property of a OperatorControlAssignment.
`assigner_id`	Gets the assigner_id of this OperatorControlAssignment.
`comment`	Gets the comment of this OperatorControlAssignment.
`compartment_id`	Gets the compartment_id of this OperatorControlAssignment.
`defined_tags`	Gets the defined_tags of this OperatorControlAssignment.
`detachment_description`	Gets the detachment_description of this OperatorControlAssignment.
`error_code`	Gets the error_code of this OperatorControlAssignment.
`error_message`	Gets the error_message of this OperatorControlAssignment.
`freeform_tags`	Gets the freeform_tags of this OperatorControlAssignment.
`id`	[Required] Gets the id of this OperatorControlAssignment.
`is_auto_approve_during_maintenance`	Gets the is_auto_approve_during_maintenance of this OperatorControlAssignment.
`is_default_assignment`	Gets the is_default_assignment of this OperatorControlAssignment.
`is_enforced_always`	Gets the is_enforced_always of this OperatorControlAssignment.
`is_hypervisor_log_forwarded`	Gets the is_hypervisor_log_forwarded of this OperatorControlAssignment.
`is_log_forwarded`	Gets the is_log_forwarded of this OperatorControlAssignment.
`lifecycle_details`	Gets the lifecycle_details of this OperatorControlAssignment.
`lifecycle_state`	Gets the lifecycle_state of this OperatorControlAssignment.
`op_control_name`	Gets the op_control_name of this OperatorControlAssignment.
`operator_control_id`	[Required] Gets the operator_control_id of this OperatorControlAssignment.
`remote_syslog_server_address`	Gets the remote_syslog_server_address of this OperatorControlAssignment.
`remote_syslog_server_ca_cert`	Gets the remote_syslog_server_ca_cert of this OperatorControlAssignment.
`remote_syslog_server_port`	Gets the remote_syslog_server_port of this OperatorControlAssignment.
`resource_compartment_id`	Gets the resource_compartment_id of this OperatorControlAssignment.
`resource_id`	[Required] Gets the resource_id of this OperatorControlAssignment.
`resource_name`	[Required] Gets the resource_name of this OperatorControlAssignment.
`resource_type`	Gets the resource_type of this OperatorControlAssignment.
`time_assignment_from`	Gets the time_assignment_from of this OperatorControlAssignment.
`time_assignment_to`	Gets the time_assignment_to of this OperatorControlAssignment.
`time_of_assignment`	Gets the time_of_assignment of this OperatorControlAssignment.
`time_of_deletion`	Gets the time_of_deletion of this OperatorControlAssignment.
`unassigner_id`	Gets the unassigner_id of this OperatorControlAssignment.

Methods

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

LIFECYCLE_STATE_APPLIED = 'APPLIED'¶: A constant which can be used with the lifecycle_state property of a OperatorControlAssignment. This constant has a value of “APPLIED”

LIFECYCLE_STATE_APPLYFAILED = 'APPLYFAILED'¶: A constant which can be used with the lifecycle_state property of a OperatorControlAssignment. This constant has a value of “APPLYFAILED”

LIFECYCLE_STATE_CREATED = 'CREATED'¶: A constant which can be used with the lifecycle_state property of a OperatorControlAssignment. This constant has a value of “CREATED”

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

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

LIFECYCLE_STATE_DELETIONFAILED = 'DELETIONFAILED'¶: A constant which can be used with the lifecycle_state property of a OperatorControlAssignment. This constant has a value of “DELETIONFAILED”

LIFECYCLE_STATE_UPDATEFAILED = 'UPDATEFAILED'¶: A constant which can be used with the lifecycle_state property of a OperatorControlAssignment. This constant has a value of “UPDATEFAILED”

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

RESOURCE_TYPE_AUTONOMOUSVMCLUSTER = 'AUTONOMOUSVMCLUSTER'¶: A constant which can be used with the resource_type property of a OperatorControlAssignment. This constant has a value of “AUTONOMOUSVMCLUSTER”

RESOURCE_TYPE_CCCINFRASTRUCTURE = 'CCCINFRASTRUCTURE'¶: A constant which can be used with the resource_type property of a OperatorControlAssignment. This constant has a value of “CCCINFRASTRUCTURE”

RESOURCE_TYPE_CLOUDAUTONOMOUSVMCLUSTER = 'CLOUDAUTONOMOUSVMCLUSTER'¶: A constant which can be used with the resource_type property of a OperatorControlAssignment. This constant has a value of “CLOUDAUTONOMOUSVMCLUSTER”

RESOURCE_TYPE_EXACC = 'EXACC'¶: A constant which can be used with the resource_type property of a OperatorControlAssignment. This constant has a value of “EXACC”

RESOURCE_TYPE_EXADATAINFRASTRUCTURE = 'EXADATAINFRASTRUCTURE'¶: A constant which can be used with the resource_type property of a OperatorControlAssignment. This constant has a value of “EXADATAINFRASTRUCTURE”

__init__(**kwargs)¶

Initializes a new OperatorControlAssignment 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 OperatorControlAssignment.
operator_control_id (str) – The value to assign to the operator_control_id property of this OperatorControlAssignment.
resource_id (str) – The value to assign to the resource_id property of this OperatorControlAssignment.
resource_name (str) – The value to assign to the resource_name property of this OperatorControlAssignment.
resource_compartment_id (str) – The value to assign to the resource_compartment_id property of this OperatorControlAssignment.
compartment_id (str) – The value to assign to the compartment_id property of this OperatorControlAssignment.
resource_type (str) – The value to assign to the resource_type property of this OperatorControlAssignment. Allowed values for this property are: “EXACC”, “EXADATAINFRASTRUCTURE”, “AUTONOMOUSVMCLUSTER”, “CLOUDAUTONOMOUSVMCLUSTER”, “CCCINFRASTRUCTURE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_assignment_from (datetime) – The value to assign to the time_assignment_from property of this OperatorControlAssignment.
time_assignment_to (datetime) – The value to assign to the time_assignment_to property of this OperatorControlAssignment.
is_enforced_always (bool) – The value to assign to the is_enforced_always property of this OperatorControlAssignment.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OperatorControlAssignment. Allowed values for this property are: “CREATED”, “APPLIED”, “APPLYFAILED”, “UPDATING”, “UPDATEFAILED”, “DELETING”, “DELETED”, “DELETIONFAILED”, ‘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 OperatorControlAssignment.
assigner_id (str) – The value to assign to the assigner_id property of this OperatorControlAssignment.
time_of_assignment (datetime) – The value to assign to the time_of_assignment property of this OperatorControlAssignment.
comment (str) – The value to assign to the comment property of this OperatorControlAssignment.
unassigner_id (str) – The value to assign to the unassigner_id property of this OperatorControlAssignment.
time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this OperatorControlAssignment.
detachment_description (str) – The value to assign to the detachment_description property of this OperatorControlAssignment.
is_log_forwarded (bool) – The value to assign to the is_log_forwarded property of this OperatorControlAssignment.
remote_syslog_server_address (str) – The value to assign to the remote_syslog_server_address property of this OperatorControlAssignment.
remote_syslog_server_port (int) – The value to assign to the remote_syslog_server_port property of this OperatorControlAssignment.
remote_syslog_server_ca_cert (str) – The value to assign to the remote_syslog_server_ca_cert property of this OperatorControlAssignment.
is_hypervisor_log_forwarded (bool) – The value to assign to the is_hypervisor_log_forwarded property of this OperatorControlAssignment.
op_control_name (str) – The value to assign to the op_control_name property of this OperatorControlAssignment.
is_auto_approve_during_maintenance (bool) – The value to assign to the is_auto_approve_during_maintenance property of this OperatorControlAssignment.
error_code (int) – The value to assign to the error_code property of this OperatorControlAssignment.
error_message (str) – The value to assign to the error_message property of this OperatorControlAssignment.
is_default_assignment (bool) – The value to assign to the is_default_assignment property of this OperatorControlAssignment.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OperatorControlAssignment.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OperatorControlAssignment.

assigner_id¶

Gets the assigner_id of this OperatorControlAssignment. The OCID of the user who created this operator control assignment.

Returns:	The assigner_id of this OperatorControlAssignment.
Return type:	str

comment¶

Gets the comment of this OperatorControlAssignment. Comment about the assignment of the operator control to this target resource.

Returns:	The comment of this OperatorControlAssignment.
Return type:	str

compartment_id¶

Gets the compartment_id of this OperatorControlAssignment. The OCID of the comparment that contains the operator control assignment.

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

defined_tags¶

Gets the defined_tags of this OperatorControlAssignment. Defined tags for this resource. Each key is predefined and scoped to a namespace.

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

detachment_description¶

Gets the detachment_description of this OperatorControlAssignment. description containing reason for releasing of OperatorControl.

Returns:	The detachment_description of this OperatorControlAssignment.
Return type:	str

error_code¶

Gets the error_code of this OperatorControlAssignment. The code identifying the error occurred during Assignment operation.

Returns:	The error_code of this OperatorControlAssignment.
Return type:	int

error_message¶

Gets the error_message of this OperatorControlAssignment. The message describing the error occurred during Assignment operation.

Returns:	The error_message of this OperatorControlAssignment.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this OperatorControlAssignment. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

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

id¶

[Required] Gets the id of this OperatorControlAssignment. The OCID of the operator control assignment.

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

is_auto_approve_during_maintenance¶

Gets the is_auto_approve_during_maintenance of this OperatorControlAssignment. The boolean if true would autoApprove during maintenance.

Returns:	The is_auto_approve_during_maintenance of this OperatorControlAssignment.
Return type:	bool

is_default_assignment¶

Gets the is_default_assignment of this OperatorControlAssignment. Whether the assignment is a default assignment.

Returns:	The is_default_assignment of this OperatorControlAssignment.
Return type:	bool

is_enforced_always¶

Gets the is_enforced_always of this OperatorControlAssignment. If set, then the target resource is always governed by the operator control.

Returns:	The is_enforced_always of this OperatorControlAssignment.
Return type:	bool

is_hypervisor_log_forwarded¶

Gets the is_hypervisor_log_forwarded of this OperatorControlAssignment. If set, then the hypervisor audit logs will be forwarded to the relevant remote syslog server

Returns:	The is_hypervisor_log_forwarded of this OperatorControlAssignment.
Return type:	bool

is_log_forwarded¶

Gets the is_log_forwarded of this OperatorControlAssignment. If set indicates that the audit logs are being forwarded to the relevant remote logging server

Returns:	The is_log_forwarded of this OperatorControlAssignment.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this OperatorControlAssignment. More in detail about the lifeCycleState.

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

lifecycle_state¶

Gets the lifecycle_state of this OperatorControlAssignment. The current lifcycle state of the OperatorControl.

Allowed values for this property are: “CREATED”, “APPLIED”, “APPLYFAILED”, “UPDATING”, “UPDATEFAILED”, “DELETING”, “DELETED”, “DELETIONFAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

op_control_name¶

Gets the op_control_name of this OperatorControlAssignment. Name of the operator control name associated.

Returns:	The op_control_name of this OperatorControlAssignment.
Return type:	str

operator_control_id¶

[Required] Gets the operator_control_id of this OperatorControlAssignment. The OCID of the operator control.

Returns:	The operator_control_id of this OperatorControlAssignment.
Return type:	str

remote_syslog_server_address¶

Gets the remote_syslog_server_address of this OperatorControlAssignment. The address of the remote syslog server where the audit logs are being forwarded to. Address in host or IP format.

Returns:	The remote_syslog_server_address of this OperatorControlAssignment.
Return type:	str

remote_syslog_server_ca_cert¶

Gets the remote_syslog_server_ca_cert of this OperatorControlAssignment. The CA certificate of the remote syslog server.

Returns:	The remote_syslog_server_ca_cert of this OperatorControlAssignment.
Return type:	str

remote_syslog_server_port¶

Gets the remote_syslog_server_port of this OperatorControlAssignment. The listening port of the remote syslog server. The port range is 0 - 65535. Only TCP supported.

Returns:	The remote_syslog_server_port of this OperatorControlAssignment.
Return type:	int

resource_compartment_id¶

Gets the resource_compartment_id of this OperatorControlAssignment. The OCID of the compartment that contains the target resource.

Returns:	The resource_compartment_id of this OperatorControlAssignment.
Return type:	str

resource_id¶

[Required] Gets the resource_id of this OperatorControlAssignment. The OCID of the target resource.

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

resource_name¶

[Required] Gets the resource_name of this OperatorControlAssignment. Name of the target resource.

Returns:	The resource_name of this OperatorControlAssignment.
Return type:	str

resource_type¶

Gets the resource_type of this OperatorControlAssignment. resourceType for which the OperatorControlAssignment is applicable

Allowed values for this property are: “EXACC”, “EXADATAINFRASTRUCTURE”, “AUTONOMOUSVMCLUSTER”, “CLOUDAUTONOMOUSVMCLUSTER”, “CCCINFRASTRUCTURE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The resource_type of this OperatorControlAssignment.
Return type:	str

time_assignment_from¶

Gets the time_assignment_from of this OperatorControlAssignment. The time at which the target resource will be brought under the governance of the operator control expressed in `RFC 3339`__ timestamp format. Example: ‘2020-05-22T21:10:29.600Z’

Returns:	The time_assignment_from of this OperatorControlAssignment.
Return type:	datetime

time_assignment_to¶

Gets the time_assignment_to of this OperatorControlAssignment. The time at which the target resource will leave the governance of the operator control expressed in `RFC 3339`__ timestamp format. Example: ‘2020-05-22T21:10:29.600Z’

Returns:	The time_assignment_to of this OperatorControlAssignment.
Return type:	datetime

time_of_assignment¶

Gets the time_of_assignment of this OperatorControlAssignment. Time when the operator control assignment is created in `RFC 3339`__ timestamp format. Example: ‘2020-05-22T21:10:29.600Z’

Returns:	The time_of_assignment of this OperatorControlAssignment.
Return type:	datetime

time_of_deletion¶

Gets the time_of_deletion of this OperatorControlAssignment. Time on which the operator control assignment was deleted in `RFC 3339`__timestamp format.Example: ‘2020-05-22T21:10:29.600Z’

Returns:	The time_of_deletion of this OperatorControlAssignment.
Return type:	datetime

unassigner_id¶

Gets the unassigner_id of this OperatorControlAssignment. User id who released the operatorControl.

Returns:	The unassigner_id of this OperatorControlAssignment.
Return type:	str