SecurityPolicySummary

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

Bases: object

Summary information for a Security Zones policy. A security policy defines a security requirement for resources in a security zone.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a SecurityPolicySummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a SecurityPolicySummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a SecurityPolicySummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a SecurityPolicySummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a SecurityPolicySummary.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a SecurityPolicySummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a SecurityPolicySummary.
OWNER_CUSTOMER A constant which can be used with the owner property of a SecurityPolicySummary.
OWNER_ORACLE A constant which can be used with the owner property of a SecurityPolicySummary.
category Gets the category of this SecurityPolicySummary.
compartment_id [Required] Gets the compartment_id of this SecurityPolicySummary.
defined_tags Gets the defined_tags of this SecurityPolicySummary.
description Gets the description of this SecurityPolicySummary.
display_name Gets the display_name of this SecurityPolicySummary.
freeform_tags Gets the freeform_tags of this SecurityPolicySummary.
friendly_name Gets the friendly_name of this SecurityPolicySummary.
id [Required] Gets the id of this SecurityPolicySummary.
lifecycle_details Gets the lifecycle_details of this SecurityPolicySummary.
lifecycle_state Gets the lifecycle_state of this SecurityPolicySummary.
owner [Required] Gets the owner of this SecurityPolicySummary.
services Gets the services of this SecurityPolicySummary.
system_tags Gets the system_tags of this SecurityPolicySummary.
time_created Gets the time_created of this SecurityPolicySummary.
time_updated Gets the time_updated of this SecurityPolicySummary.

Methods

__init__(**kwargs) Initializes a new SecurityPolicySummary object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

OWNER_CUSTOMER = 'CUSTOMER'

A constant which can be used with the owner property of a SecurityPolicySummary. This constant has a value of “CUSTOMER”

OWNER_ORACLE = 'ORACLE'

A constant which can be used with the owner property of a SecurityPolicySummary. This constant has a value of “ORACLE”

__init__(**kwargs)

Initializes a new SecurityPolicySummary 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 SecurityPolicySummary.
  • friendly_name (str) – The value to assign to the friendly_name property of this SecurityPolicySummary.
  • display_name (str) – The value to assign to the display_name property of this SecurityPolicySummary.
  • description (str) – The value to assign to the description property of this SecurityPolicySummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this SecurityPolicySummary.
  • owner (str) – The value to assign to the owner property of this SecurityPolicySummary. Allowed values for this property are: “CUSTOMER”, “ORACLE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • category (str) – The value to assign to the category property of this SecurityPolicySummary.
  • services (list[str]) – The value to assign to the services property of this SecurityPolicySummary.
  • time_created (datetime) – The value to assign to the time_created property of this SecurityPolicySummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this SecurityPolicySummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SecurityPolicySummary. 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 SecurityPolicySummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SecurityPolicySummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SecurityPolicySummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SecurityPolicySummary.
category

Gets the category of this SecurityPolicySummary. The category of the security policy

Returns:The category of this SecurityPolicySummary.
Return type:str
compartment_id

[Required] Gets the compartment_id of this SecurityPolicySummary. The OCID of the security policy’s compartment

Returns:The compartment_id of this SecurityPolicySummary.
Return type:str
defined_tags

Gets the defined_tags of this SecurityPolicySummary. 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 SecurityPolicySummary.
Return type:dict(str, dict(str, object))
description

Gets the description of this SecurityPolicySummary. The security policy’s description

Returns:The description of this SecurityPolicySummary.
Return type:str
display_name

Gets the display_name of this SecurityPolicySummary. The security policy’s display name

Returns:The display_name of this SecurityPolicySummary.
Return type:str
freeform_tags

Gets the freeform_tags of this SecurityPolicySummary. 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 SecurityPolicySummary.
Return type:dict(str, str)
friendly_name

Gets the friendly_name of this SecurityPolicySummary. A shorter version of the security policy’s name

Returns:The friendly_name of this SecurityPolicySummary.
Return type:str
id

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

Returns:The id of this SecurityPolicySummary.
Return type:str
lifecycle_details

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

Returns:The lifecycle_details of this SecurityPolicySummary.
Return type:str
lifecycle_state

Gets the lifecycle_state of this SecurityPolicySummary. The current lifecycle state of the security policy

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 SecurityPolicySummary.
Return type:str
owner

[Required] Gets the owner of this SecurityPolicySummary. The owner of the security policy

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

Returns:The owner of this SecurityPolicySummary.
Return type:str
services

Gets the services of this SecurityPolicySummary. The list of services that the security policy protects

Returns:The services of this SecurityPolicySummary.
Return type:list[str]
system_tags

Gets the system_tags of this SecurityPolicySummary. 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 SecurityPolicySummary.
Return type:dict(str, dict(str, object))
time_created

Gets the time_created of this SecurityPolicySummary. The date and time the security policy was created. An RFC3339 formatted datetime string.

Returns:The time_created of this SecurityPolicySummary.
Return type:datetime
time_updated

Gets the time_updated of this SecurityPolicySummary. The date and time the security policy was last updated. An RFC3339 formatted datetime string.

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