ResponderRecipe¶

class oci.cloud_guard.models.ResponderRecipe(**kwargs)¶

Bases: object

A ResponderRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat).

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

Attributes

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

Methods

__init__(**kwargs) Initializes a new ResponderRecipe object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ResponderRecipe. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ResponderRecipe. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ResponderRecipe. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ResponderRecipe. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ResponderRecipe. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a ResponderRecipe. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ResponderRecipe. This constant has a value of “UPDATING”

OWNER_CUSTOMER = 'CUSTOMER'¶: A constant which can be used with the owner property of a ResponderRecipe. This constant has a value of “CUSTOMER”

OWNER_ORACLE = 'ORACLE'¶: A constant which can be used with the owner property of a ResponderRecipe. This constant has a value of “ORACLE”

__init__(**kwargs)¶

Initializes a new ResponderRecipe 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 ResponderRecipe.
display_name (str) – The value to assign to the display_name property of this ResponderRecipe.
description (str) – The value to assign to the description property of this ResponderRecipe.
owner (str) – The value to assign to the owner property of this ResponderRecipe. 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’.
responder_rules (list[oci.cloud_guard.models.ResponderRecipeResponderRule]) – The value to assign to the responder_rules property of this ResponderRecipe.
effective_responder_rules (list[oci.cloud_guard.models.ResponderRecipeResponderRule]) – The value to assign to the effective_responder_rules property of this ResponderRecipe.
source_responder_recipe_id (str) – The value to assign to the source_responder_recipe_id property of this ResponderRecipe.
compartment_id (str) – The value to assign to the compartment_id property of this ResponderRecipe.
time_created (datetime) – The value to assign to the time_created property of this ResponderRecipe.
time_updated (datetime) – The value to assign to the time_updated property of this ResponderRecipe.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ResponderRecipe. 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 ResponderRecipe.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ResponderRecipe.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ResponderRecipe.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ResponderRecipe.

compartment_id¶

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

Returns:	The compartment_id of this ResponderRecipe.
Return type:	str

defined_tags¶

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

description¶

Gets the description of this ResponderRecipe. Responder recipe description

Returns:	The description of this ResponderRecipe.
Return type:	str

display_name¶

Gets the display_name of this ResponderRecipe. Responder recipe display name

Returns:	The display_name of this ResponderRecipe.
Return type:	str

effective_responder_rules¶

Gets the effective_responder_rules of this ResponderRecipe. List of currently enabled responder rules for the responder type, for recipe after applying defaults

Returns:	The effective_responder_rules of this ResponderRecipe.
Return type:	list[oci.cloud_guard.models.ResponderRecipeResponderRule]

freeform_tags¶

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

id¶

[Required] Gets the id of this ResponderRecipe. Unique identifier for the responder recip

Returns:	The id of this ResponderRecipe.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ResponderRecipe. 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 ResponderRecipe.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this ResponderRecipe. The current lifecycle state of the example

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

owner¶

Gets the owner of this ResponderRecipe. Owner of responder recipe

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

responder_rules¶

Gets the responder_rules of this ResponderRecipe. List of responder rules associated with the recipe

Returns:	The responder_rules of this ResponderRecipe.
Return type:	list[oci.cloud_guard.models.ResponderRecipeResponderRule]

source_responder_recipe_id¶

Gets the source_responder_recipe_id of this ResponderRecipe. The unique identifier of the source responder recipe

Returns:	The source_responder_recipe_id of this ResponderRecipe.
Return type:	str

system_tags¶

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

time_created¶

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

Returns:	The time_created of this ResponderRecipe.
Return type:	datetime

time_updated¶

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

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