SecurityPolicy

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

Bases: object

A security policy (SecurityPolicy resource) defines security requirements for resources in a security zone. If a security zone enables a security policy through a security recipe (SecurityRecipe resource), then any action that would violate that policy is blocked.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

OWNER_CUSTOMER

A constant which can be used with the owner property of a SecurityPolicy.

OWNER_ORACLE

A constant which can be used with the owner property of a SecurityPolicy.

category

Gets the category of this SecurityPolicy.

compartment_id

[Required] Gets the compartment_id of this SecurityPolicy.

defined_tags

Gets the defined_tags of this SecurityPolicy.

description

Gets the description of this SecurityPolicy.

display_name

Gets the display_name of this SecurityPolicy.

freeform_tags

Gets the freeform_tags of this SecurityPolicy.

friendly_name

Gets the friendly_name of this SecurityPolicy.

id

[Required] Gets the id of this SecurityPolicy.

lifecycle_details

Gets the lifecycle_details of this SecurityPolicy.

lifecycle_state

Gets the lifecycle_state of this SecurityPolicy.

locks

Gets the locks of this SecurityPolicy.

owner

[Required] Gets the owner of this SecurityPolicy.

services

Gets the services of this SecurityPolicy.

system_tags

Gets the system_tags of this SecurityPolicy.

time_created

Gets the time_created of this SecurityPolicy.

time_updated

Gets the time_updated of this SecurityPolicy.

Methods:

__init__(**kwargs)

Initializes a new SecurityPolicy object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

OWNER_CUSTOMER = 'CUSTOMER'

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

OWNER_ORACLE = 'ORACLE'

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

__init__(**kwargs)

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

  • friendly_name (str) – The value to assign to the friendly_name property of this SecurityPolicy.

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

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

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

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

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

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

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

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

  • locks (list[oci.cloud_guard.models.ResourceLock]) – The value to assign to the locks property of this SecurityPolicy.

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

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

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

property category

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

Returns

The category of this SecurityPolicy.

Return type

str

property compartment_id

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

Returns

The compartment_id of this SecurityPolicy.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this SecurityPolicy.

Return type

str

property display_name

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

Returns

The display_name of this SecurityPolicy.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property friendly_name

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

Returns

The friendly_name of this SecurityPolicy.

Return type

str

property id

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

Returns

The id of this SecurityPolicy.

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this SecurityPolicy.

Return type

str

property lifecycle_state

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

Return type

str

property locks

Gets the locks of this SecurityPolicy. Locks associated with this resource.

Returns

The locks of this SecurityPolicy.

Return type

list[oci.cloud_guard.models.ResourceLock]

property owner

[Required] Gets the owner of this SecurityPolicy. 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 SecurityPolicy.

Return type

str

property services

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

Returns

The services of this SecurityPolicy.

Return type

list[str]

property system_tags

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

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this SecurityPolicy.

Return type

datetime

property time_updated

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

Returns

The time_updated of this SecurityPolicy.

Return type

datetime