ResponderRule

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

Bases: object

A ResponderRule resource contains the default settings for a single responder rule that Cloud Guard provides.

A ResponderRule resource: * Is used as the original source for a rule in an Oracle-managed responder of the specified type. * Is not directly visible in the Cloud Guard UI. * Can’t be modified by users, programmatically or through the UI. * May be modified from time to time by Cloud Guard.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

SUPPORTED_MODES_AUTOACTION

A constant which can be used with the supported_modes property of a ResponderRule.

SUPPORTED_MODES_USERACTION

A constant which can be used with the supported_modes property of a ResponderRule.

TYPE_NOTIFICATION

A constant which can be used with the type property of a ResponderRule.

TYPE_REMEDIATION

A constant which can be used with the type property of a ResponderRule.

description

[Required] Gets the description of this ResponderRule.

details

Gets the details of this ResponderRule.

display_name

[Required] Gets the display_name of this ResponderRule.

id

[Required] Gets the id of this ResponderRule.

lifecycle_details

Gets the lifecycle_details of this ResponderRule.

lifecycle_state

Gets the lifecycle_state of this ResponderRule.

locks

Gets the locks of this ResponderRule.

policies

Gets the policies of this ResponderRule.

supported_modes

Gets the supported_modes of this ResponderRule.

time_created

Gets the time_created of this ResponderRule.

time_updated

Gets the time_updated of this ResponderRule.

type

[Required] Gets the type of this ResponderRule.

Methods:

__init__(**kwargs)

Initializes a new ResponderRule object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SUPPORTED_MODES_AUTOACTION = 'AUTOACTION'

A constant which can be used with the supported_modes property of a ResponderRule. This constant has a value of “AUTOACTION”

SUPPORTED_MODES_USERACTION = 'USERACTION'

A constant which can be used with the supported_modes property of a ResponderRule. This constant has a value of “USERACTION”

TYPE_NOTIFICATION = 'NOTIFICATION'

A constant which can be used with the type property of a ResponderRule. This constant has a value of “NOTIFICATION”

TYPE_REMEDIATION = 'REMEDIATION'

A constant which can be used with the type property of a ResponderRule. This constant has a value of “REMEDIATION”

__init__(**kwargs)

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

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

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

  • type (str) – The value to assign to the type property of this ResponderRule. Allowed values for this property are: “REMEDIATION”, “NOTIFICATION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

  • supported_modes (list[str]) – The value to assign to the supported_modes property of this ResponderRule. Allowed values for items in this list are: “AUTOACTION”, “USERACTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • details (oci.cloud_guard.models.ResponderRuleDetails) – The value to assign to the details property of this ResponderRule.

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

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

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

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

property description

[Required] Gets the description of this ResponderRule. Responder rule description

Returns

The description of this ResponderRule.

Return type

str

property details

Gets the details of this ResponderRule.

Returns

The details of this ResponderRule.

Return type

oci.cloud_guard.models.ResponderRuleDetails

property display_name

[Required] Gets the display_name of this ResponderRule. Responder rule display name

Returns

The display_name of this ResponderRule.

Return type

str

property id

[Required] Gets the id of this ResponderRule. Unique identifier for the responder rule

Returns

The id of this ResponderRule.

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this ResponderRule.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this ResponderRule. The current lifecycle state of the responder rule.

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 ResponderRule.

Return type

str

property locks

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

Returns

The locks of this ResponderRule.

Return type

list[oci.cloud_guard.models.ResourceLock]

property policies

Gets the policies of this ResponderRule. List of policies

Returns

The policies of this ResponderRule.

Return type

list[str]

property supported_modes

Gets the supported_modes of this ResponderRule. Supported execution modes for the responder rule

Allowed values for items in this list are: “AUTOACTION”, “USERACTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The supported_modes of this ResponderRule.

Return type

list[str]

property time_created

Gets the time_created of this ResponderRule. The date and time the responder rule was created. Format defined by RFC3339.

Returns

The time_created of this ResponderRule.

Return type

datetime

property time_updated

Gets the time_updated of this ResponderRule. The date and time the responder rule was last updated. Format defined by RFC3339.

Returns

The time_updated of this ResponderRule.

Return type

datetime

property type

[Required] Gets the type of this ResponderRule. Type of responder

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

Returns

The type of this ResponderRule.

Return type

str