TargetResponderRecipeResponderRule

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

Bases: object

A TargetResponderRecipeResponderRule resource contains a specific instance of a single responder rule.

A TargetResponderRecipeRule resource: * Is effectively a copy of a ResponderRecipeRule resource in which users can make certain changes if it’s Oracle-managed, and other changes if it’s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is effectively located in a specific OCI compartment, through the ThreatResponderRecipe resource to which it belongs. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply locally, to resources in OCI compartments mapped to the target that attaches the associated responder recipe (in a TargetResponderRecipe resource), and override any changes made in rules associated with the corresponding ResponderRecipe resource.

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

SUPPORTED_MODES_AUTOACTION

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

SUPPORTED_MODES_USERACTION

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

TYPE_NOTIFICATION

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

TYPE_REMEDIATION

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

compartment_id

[Required] Gets the compartment_id of this TargetResponderRecipeResponderRule.

description

Gets the description of this TargetResponderRecipeResponderRule.

details

Gets the details of this TargetResponderRecipeResponderRule.

display_name

Gets the display_name of this TargetResponderRecipeResponderRule.

lifecycle_details

Gets the lifecycle_details of this TargetResponderRecipeResponderRule.

lifecycle_state

Gets the lifecycle_state of this TargetResponderRecipeResponderRule.

policies

Gets the policies of this TargetResponderRecipeResponderRule.

responder_rule_id

[Required] Gets the responder_rule_id of this TargetResponderRecipeResponderRule.

supported_modes

Gets the supported_modes of this TargetResponderRecipeResponderRule.

time_created

Gets the time_created of this TargetResponderRecipeResponderRule.

time_updated

Gets the time_updated of this TargetResponderRecipeResponderRule.

type

Gets the type of this TargetResponderRecipeResponderRule.

Methods:

__init__(**kwargs)

Initializes a new TargetResponderRecipeResponderRule object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SUPPORTED_MODES_AUTOACTION = 'AUTOACTION'

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

SUPPORTED_MODES_USERACTION = 'USERACTION'

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

TYPE_NOTIFICATION = 'NOTIFICATION'

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

TYPE_REMEDIATION = 'REMEDIATION'

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

__init__(**kwargs)

Initializes a new TargetResponderRecipeResponderRule object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • responder_rule_id (str) – The value to assign to the responder_rule_id property of this TargetResponderRecipeResponderRule.

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

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

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

  • supported_modes (list[str]) – The value to assign to the supported_modes property of this TargetResponderRecipeResponderRule. 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 TargetResponderRecipeResponderRule.

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

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

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

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

property compartment_id

[Required] Gets the compartment_id of this TargetResponderRecipeResponderRule. Compartment OCID

Returns

The compartment_id of this TargetResponderRecipeResponderRule.

Return type

str

property description

Gets the description of this TargetResponderRecipeResponderRule. Responder rule description

Returns

The description of this TargetResponderRecipeResponderRule.

Return type

str

property details

Gets the details of this TargetResponderRecipeResponderRule.

Returns

The details of this TargetResponderRecipeResponderRule.

Return type

oci.cloud_guard.models.ResponderRuleDetails

property display_name

Gets the display_name of this TargetResponderRecipeResponderRule. Responder rule display name

Returns

The display_name of this TargetResponderRecipeResponderRule.

Return type

str

property lifecycle_details

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

Return type

str

property lifecycle_state

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

Return type

str

property policies

Gets the policies of this TargetResponderRecipeResponderRule. List of policies

Returns

The policies of this TargetResponderRecipeResponderRule.

Return type

list[str]

property responder_rule_id

[Required] Gets the responder_rule_id of this TargetResponderRecipeResponderRule. Unique identifier for the responder rule

Returns

The responder_rule_id of this TargetResponderRecipeResponderRule.

Return type

str

property supported_modes

Gets the supported_modes of this TargetResponderRecipeResponderRule. 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 TargetResponderRecipeResponderRule.

Return type

list[str]

property time_created

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

Returns

The time_created of this TargetResponderRecipeResponderRule.

Return type

datetime

property time_updated

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

Returns

The time_updated of this TargetResponderRecipeResponderRule.

Return type

datetime

property type

Gets the type of this TargetResponderRecipeResponderRule. 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 TargetResponderRecipeResponderRule.

Return type

str