ResponderRecipeResponderRule

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

Bases: object

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

A ResponderRecipeRule resource: * Is effectively a copy of a ResponderRule resource in which users can make certain changes if it’s Oracle-managed, and other changes if it’s user-managed. * Can also be created by cloning an existing ResponderRecipe resource, either user-managed or Oracle-managed; cloning the ResponderRecipe resource also clones its associated ResponderRule resources as ResponderRecipeRule resources. * Is visible on the Cloud Guard Responder Recipes, Responder Details page. * Is effectively located in a specific OCI compartment, through the ResponderRecipe resource to which it belongs. * Can be modified by users, programmatically or through the UI. * Changes that can be made here apply globally, to all resources in OCI compartments mapped to a target that attaches the associated responder recipe (in a TargetResponderRecipe resource), but are overridden by changes made in the corresponding TargetResponderRecipe resource (which is effectively a copy of the ResponderRecipe resource). type: object

Attributes:

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_INACTIVE

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

LIFECYCLE_STATE_UPDATING

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

SUPPORTED_MODES_AUTOACTION

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

SUPPORTED_MODES_USERACTION

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

TYPE_NOTIFICATION

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

TYPE_REMEDIATION

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

compartment_id

[Required] Gets the compartment_id of this ResponderRecipeResponderRule.

description

Gets the description of this ResponderRecipeResponderRule.

details

Gets the details of this ResponderRecipeResponderRule.

display_name

Gets the display_name of this ResponderRecipeResponderRule.

lifecycle_details

Gets the lifecycle_details of this ResponderRecipeResponderRule.

lifecycle_state

Gets the lifecycle_state of this ResponderRecipeResponderRule.

locks

Gets the locks of this ResponderRecipeResponderRule.

policies

Gets the policies of this ResponderRecipeResponderRule.

responder_rule_id

[Required] Gets the responder_rule_id of this ResponderRecipeResponderRule.

supported_modes

Gets the supported_modes of this ResponderRecipeResponderRule.

time_created

Gets the time_created of this ResponderRecipeResponderRule.

time_updated

Gets the time_updated of this ResponderRecipeResponderRule.

type

Gets the type of this ResponderRecipeResponderRule.

Methods:

__init__(**kwargs)

Initializes a new ResponderRecipeResponderRule object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SUPPORTED_MODES_AUTOACTION = 'AUTOACTION'

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

SUPPORTED_MODES_USERACTION = 'USERACTION'

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

TYPE_NOTIFICATION = 'NOTIFICATION'

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

TYPE_REMEDIATION = 'REMEDIATION'

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

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

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

property compartment_id

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

Returns

The compartment_id of this ResponderRecipeResponderRule.

Return type

str

property description

Gets the description of this ResponderRecipeResponderRule. Responder rule description

Returns

The description of this ResponderRecipeResponderRule.

Return type

str

property details

Gets the details of this ResponderRecipeResponderRule.

Returns

The details of this ResponderRecipeResponderRule.

Return type

oci.cloud_guard.models.ResponderRuleDetails

property display_name

Gets the display_name of this ResponderRecipeResponderRule. Responder rule display name

Returns

The display_name of this ResponderRecipeResponderRule.

Return type

str

property lifecycle_details

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

Return type

str

property lifecycle_state

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

Return type

str

property locks

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

Returns

The locks of this ResponderRecipeResponderRule.

Return type

list[oci.cloud_guard.models.ResourceLock]

property policies

Gets the policies of this ResponderRecipeResponderRule. List of policies

Returns

The policies of this ResponderRecipeResponderRule.

Return type

list[str]

property responder_rule_id

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

Returns

The responder_rule_id of this ResponderRecipeResponderRule.

Return type

str

property supported_modes

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

Return type

list[str]

property time_created

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

Returns

The time_created of this ResponderRecipeResponderRule.

Return type

datetime

property time_updated

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

Returns

The time_updated of this ResponderRecipeResponderRule.

Return type

datetime

property type

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

Return type

str