SecurityZone

class oci.cloud_guard.models.SecurityZone(**kwargs)

Bases: object

A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe. Any actions in the zone’s compartment (and any subcompartments in the zone) that violate a policy are denied.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a SecurityZone.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a SecurityZone.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a SecurityZone.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a SecurityZone.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a SecurityZone.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a SecurityZone.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a SecurityZone.

compartment_id

[Required] Gets the compartment_id of this SecurityZone.

defined_tags

Gets the defined_tags of this SecurityZone.

description

Gets the description of this SecurityZone.

display_name

Gets the display_name of this SecurityZone.

freeform_tags

Gets the freeform_tags of this SecurityZone.

id

[Required] Gets the id of this SecurityZone.

inherited_by_compartments

Gets the inherited_by_compartments of this SecurityZone.

is_inheritance_after_delete_enabled

Gets the is_inheritance_after_delete_enabled of this SecurityZone.

lifecycle_details

Gets the lifecycle_details of this SecurityZone.

lifecycle_state

Gets the lifecycle_state of this SecurityZone.

security_zone_recipe_id

[Required] Gets the security_zone_recipe_id of this SecurityZone.

security_zone_target_id

Gets the security_zone_target_id of this SecurityZone.

system_tags

Gets the system_tags of this SecurityZone.

time_created

Gets the time_created of this SecurityZone.

time_updated

Gets the time_updated of this SecurityZone.

Methods:

__init__(**kwargs)

Initializes a new SecurityZone object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a SecurityZone. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a SecurityZone. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a SecurityZone. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a SecurityZone. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a SecurityZone. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a SecurityZone. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a SecurityZone. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new SecurityZone 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 SecurityZone.

  • display_name (str) – The value to assign to the display_name property of this SecurityZone.

  • description (str) – The value to assign to the description property of this SecurityZone.

  • compartment_id (str) – The value to assign to the compartment_id property of this SecurityZone.

  • security_zone_recipe_id (str) – The value to assign to the security_zone_recipe_id property of this SecurityZone.

  • security_zone_target_id (str) – The value to assign to the security_zone_target_id property of this SecurityZone.

  • inherited_by_compartments (list[str]) – The value to assign to the inherited_by_compartments property of this SecurityZone.

  • time_created (datetime) – The value to assign to the time_created property of this SecurityZone.

  • time_updated (datetime) – The value to assign to the time_updated property of this SecurityZone.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SecurityZone. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 SecurityZone.

  • is_inheritance_after_delete_enabled (bool) – The value to assign to the is_inheritance_after_delete_enabled property of this SecurityZone.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SecurityZone.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SecurityZone.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SecurityZone.

property compartment_id

[Required] Gets the compartment_id of this SecurityZone. The OCID of the compartment for the security zone

Returns

The compartment_id of this SecurityZone.

Return type

str

property defined_tags

Gets the defined_tags of this SecurityZone. 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 SecurityZone.

Return type

dict(str, dict(str, object))

property description

Gets the description of this SecurityZone. The security zone’s description

Returns

The description of this SecurityZone.

Return type

str

property display_name

Gets the display_name of this SecurityZone. The security zone’s display name

Returns

The display_name of this SecurityZone.

Return type

str

property freeform_tags

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

Avoid entering confidential information.

Returns

The freeform_tags of this SecurityZone.

Return type

dict(str, str)

property id

[Required] Gets the id of this SecurityZone. Unique identifier that can’t be changed after creation

Returns

The id of this SecurityZone.

Return type

str

property inherited_by_compartments

Gets the inherited_by_compartments of this SecurityZone. List of inherited compartments

Returns

The inherited_by_compartments of this SecurityZone.

Return type

list[str]

property is_inheritance_after_delete_enabled

Gets the is_inheritance_after_delete_enabled of this SecurityZone. Indicates if upon deletion of the security zone the comparment should inherit parent security zone

Returns

The is_inheritance_after_delete_enabled of this SecurityZone.

Return type

bool

property lifecycle_details

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

Returns

The lifecycle_details of this SecurityZone.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this SecurityZone. The current lifecycle state of the security zone

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “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 SecurityZone.

Return type

str

property security_zone_recipe_id

[Required] Gets the security_zone_recipe_id of this SecurityZone. The OCID of the recipe (SecurityRecipe resource) for the security zone

Returns

The security_zone_recipe_id of this SecurityZone.

Return type

str

property security_zone_target_id

Gets the security_zone_target_id of this SecurityZone. The OCID of the target associated with the security zone

Returns

The security_zone_target_id of this SecurityZone.

Return type

str

property system_tags

Gets the system_tags of this SecurityZone. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

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

Returns

The system_tags of this SecurityZone.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this SecurityZone. The time the security zone was created. An RFC3339 formatted datetime string.

Returns

The time_created of this SecurityZone.

Return type

datetime

property time_updated

Gets the time_updated of this SecurityZone. The time the security zone was last updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this SecurityZone.

Return type

datetime