SecurityZoneSummary

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

Bases: object

Summary information for a security zone. A security zone is associated with a security zone recipe and enforces all security zone policies in the recipe.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

compartment_id

[Required] Gets the compartment_id of this SecurityZoneSummary.

defined_tags

Gets the defined_tags of this SecurityZoneSummary.

description

Gets the description of this SecurityZoneSummary.

display_name

Gets the display_name of this SecurityZoneSummary.

freeform_tags

Gets the freeform_tags of this SecurityZoneSummary.

id

[Required] Gets the id of this SecurityZoneSummary.

is_inheritance_after_delete_enabled

Gets the is_inheritance_after_delete_enabled of this SecurityZoneSummary.

lifecycle_details

Gets the lifecycle_details of this SecurityZoneSummary.

lifecycle_state

Gets the lifecycle_state of this SecurityZoneSummary.

security_zone_recipe_id

[Required] Gets the security_zone_recipe_id of this SecurityZoneSummary.

system_tags

Gets the system_tags of this SecurityZoneSummary.

time_created

Gets the time_created of this SecurityZoneSummary.

time_updated

Gets the time_updated of this SecurityZoneSummary.

Methods:

__init__(**kwargs)

Initializes a new SecurityZoneSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

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

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

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

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

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SecurityZoneSummary. 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 SecurityZoneSummary.

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

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

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

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

property compartment_id

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

Returns

The compartment_id of this SecurityZoneSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this SecurityZoneSummary.

Return type

str

property display_name

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

Returns

The display_name of this SecurityZoneSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this SecurityZoneSummary. 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 SecurityZoneSummary.

Return type

dict(str, str)

property id

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

Returns

The id of this SecurityZoneSummary.

Return type

str

property is_inheritance_after_delete_enabled

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

Returns

The is_inheritance_after_delete_enabled of this SecurityZoneSummary.

Return type

bool

property lifecycle_details

Gets the lifecycle_details of this SecurityZoneSummary. 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 SecurityZoneSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this SecurityZoneSummary. 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 SecurityZoneSummary.

Return type

str

property security_zone_recipe_id

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

Returns

The security_zone_recipe_id of this SecurityZoneSummary.

Return type

str

property system_tags

Gets the system_tags of this SecurityZoneSummary. 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 SecurityZoneSummary.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this SecurityZoneSummary.

Return type

datetime

property time_updated

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

Returns

The time_updated of this SecurityZoneSummary.

Return type

datetime