ZprPolicy¶

class oci.zpr.models.ZprPolicy(**kwargs)¶

Bases: object

A ZprPolicy is a rule that governs the communication between specific endpoints identified by their security attributes.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ZprPolicy.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ZprPolicy.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ZprPolicy.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ZprPolicy.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ZprPolicy.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a ZprPolicy.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ZprPolicy.
`compartment_id`	[Required] Gets the compartment_id of this ZprPolicy.
`defined_tags`	[Required] Gets the defined_tags of this ZprPolicy.
`description`	[Required] Gets the description of this ZprPolicy.
`freeform_tags`	[Required] Gets the freeform_tags of this ZprPolicy.
`id`	[Required] Gets the id of this ZprPolicy.
`lifecycle_details`	Gets the lifecycle_details of this ZprPolicy.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ZprPolicy.
`name`	[Required] Gets the name of this ZprPolicy.
`statements`	[Required] Gets the statements of this ZprPolicy.
`system_tags`	Gets the system_tags of this ZprPolicy.
`time_created`	[Required] Gets the time_created of this ZprPolicy.
`time_updated`	Gets the time_updated of this ZprPolicy.

Methods

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

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

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

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

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

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

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a ZprPolicy. This constant has a value of “NEEDS_ATTENTION”

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

__init__(**kwargs)¶

Initializes a new ZprPolicy 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 ZprPolicy.
name (str) – The value to assign to the name property of this ZprPolicy.
description (str) – The value to assign to the description property of this ZprPolicy.
compartment_id (str) – The value to assign to the compartment_id property of this ZprPolicy.
statements (list[str]) – The value to assign to the statements property of this ZprPolicy.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ZprPolicy. Allowed values for this property are: “ACTIVE”, “CREATING”, “FAILED”, “UPDATING”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, ‘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 ZprPolicy.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ZprPolicy.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ZprPolicy.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ZprPolicy.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ZprPolicy.
time_updated (datetime) – The value to assign to the time_updated property of this ZprPolicy.

compartment_id¶

[Required] Gets the compartment_id of this ZprPolicy. The OCID of the compartment.

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

defined_tags¶

[Required] Gets the defined_tags of this ZprPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

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

description¶

[Required] Gets the description of this ZprPolicy. The description you assign to the ZprPolicy during creation. Does not have to be unique, and it’s changeable.

Returns:	The description of this ZprPolicy.
Return type:	str

freeform_tags¶

[Required] Gets the freeform_tags of this ZprPolicy. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

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

id¶

[Required] Gets the id of this ZprPolicy. The OCID of the ZprPolicy.

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

lifecycle_details¶

Gets the lifecycle_details of this ZprPolicy. A message that describes the current state of the ZprPolicy in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

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

lifecycle_state¶

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

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

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

name¶

[Required] Gets the name of this ZprPolicy. The name you assign to the ZprPolicy during creation. The name must be unique across all ZPL policies in the tenancy.

Returns:	The name of this ZprPolicy.
Return type:	str

statements¶

[Required] Gets the statements of this ZprPolicy. An array of ZprPolicy statements (up to 25 statements per ZprPolicy) written in the Zero Trust Packet Routing Policy Language.

Returns:	The statements of this ZprPolicy.
Return type:	list[str]

system_tags¶

Gets the system_tags of this ZprPolicy. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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

time_created¶

[Required] Gets the time_created of this ZprPolicy. The date and time the ZprPolicy was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

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

time_updated¶

Gets the time_updated of this ZprPolicy. The date and time the ZprPolicy was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

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