SecurityRecipeSummary¶
- class oci.cloud_guard.models.SecurityRecipeSummary(**kwargs)¶
Bases:
objectSummary information for a Security Zones recipe.
Attributes:
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary.
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary.
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary.
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary.
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary.
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary.
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary.
A constant which can be used with the owner property of a SecurityRecipeSummary.
A constant which can be used with the owner property of a SecurityRecipeSummary.
[Required] Gets the compartment_id of this SecurityRecipeSummary.
Gets the defined_tags of this SecurityRecipeSummary.
Gets the description of this SecurityRecipeSummary.
Gets the display_name of this SecurityRecipeSummary.
Gets the freeform_tags of this SecurityRecipeSummary.
[Required] Gets the id of this SecurityRecipeSummary.
Gets the lifecycle_details of this SecurityRecipeSummary.
Gets the lifecycle_state of this SecurityRecipeSummary.
[Required] Gets the owner of this SecurityRecipeSummary.
[Required] Gets the security_policies of this SecurityRecipeSummary.
Gets the system_tags of this SecurityRecipeSummary.
Gets the time_created of this SecurityRecipeSummary.
Gets the time_updated of this SecurityRecipeSummary.
Methods:
__init__(**kwargs)Initializes a new SecurityRecipeSummary object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a SecurityRecipeSummary. This constant has a value of “UPDATING”
- OWNER_CUSTOMER = 'CUSTOMER'¶
A constant which can be used with the owner property of a SecurityRecipeSummary. This constant has a value of “CUSTOMER”
- OWNER_ORACLE = 'ORACLE'¶
A constant which can be used with the owner property of a SecurityRecipeSummary. This constant has a value of “ORACLE”
- __init__(**kwargs)¶
Initializes a new SecurityRecipeSummary 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 SecurityRecipeSummary.
display_name (str) – The value to assign to the display_name property of this SecurityRecipeSummary.
description (str) – The value to assign to the description property of this SecurityRecipeSummary.
compartment_id (str) – The value to assign to the compartment_id property of this SecurityRecipeSummary.
owner (str) – The value to assign to the owner property of this SecurityRecipeSummary. 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’.
security_policies (list[str]) – The value to assign to the security_policies property of this SecurityRecipeSummary.
time_created (datetime) – The value to assign to the time_created property of this SecurityRecipeSummary.
time_updated (datetime) – The value to assign to the time_updated property of this SecurityRecipeSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SecurityRecipeSummary. 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 SecurityRecipeSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SecurityRecipeSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SecurityRecipeSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SecurityRecipeSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this SecurityRecipeSummary. The OCID of the compartment that contains the recipe
- Returns
The compartment_id of this SecurityRecipeSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this SecurityRecipeSummary. 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 SecurityRecipeSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this SecurityRecipeSummary. The recipe’s description
- Returns
The description of this SecurityRecipeSummary.
- Return type
str
- property display_name¶
Gets the display_name of this SecurityRecipeSummary. The recipe’s name
- Returns
The display_name of this SecurityRecipeSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this SecurityRecipeSummary. 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 SecurityRecipeSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this SecurityRecipeSummary. Unique identifier that can’t be changed after creation
- Returns
The id of this SecurityRecipeSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this SecurityRecipeSummary. A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the Failed state.
- Returns
The lifecycle_details of this SecurityRecipeSummary.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this SecurityRecipeSummary. The current lifecycle state of the recipe
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 SecurityRecipeSummary.
- Return type
str
- property owner¶
[Required] Gets the owner of this SecurityRecipeSummary. The owner of the 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 SecurityRecipeSummary.
- Return type
str
- property security_policies¶
[Required] Gets the security_policies of this SecurityRecipeSummary. The list of security policy IDs that are included in the recipe
- Returns
The security_policies of this SecurityRecipeSummary.
- Return type
list[str]
- property system_tags¶
Gets the system_tags of this SecurityRecipeSummary. 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 SecurityRecipeSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
Gets the time_created of this SecurityRecipeSummary. The time the recipe was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this SecurityRecipeSummary.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this SecurityRecipeSummary. The time the recipe was last updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this SecurityRecipeSummary.
- Return type
datetime