WaasPolicy

class oci.waas.models.WaasPolicy(**kwargs)

Bases: object

The details of a Web Application Acceleration and Security (WAAS) policy. A policy describes how the WAAS service should operate for the configured web application.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a WaasPolicy. This constant has a value of "ACTIVE"

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a WaasPolicy. This constant has a value of "CREATING"

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a WaasPolicy. This constant has a value of "DELETED"

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a WaasPolicy. This constant has a value of "DELETING"

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a WaasPolicy. This constant has a value of "FAILED"

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a WaasPolicy. This constant has a value of "UPDATING"

__init__(**kwargs)

Initializes a new WaasPolicy 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 WaasPolicy.
  • compartment_id (str) -- The value to assign to the compartment_id property of this WaasPolicy.
  • display_name (str) -- The value to assign to the display_name property of this WaasPolicy.
  • domain (str) -- The value to assign to the domain property of this WaasPolicy.
  • additional_domains (list[str]) -- The value to assign to the additional_domains property of this WaasPolicy.
  • cname (str) -- The value to assign to the cname property of this WaasPolicy.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this WaasPolicy. Allowed values for this property are: "CREATING", "ACTIVE", "FAILED", "UPDATING", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • time_created (datetime) -- The value to assign to the time_created property of this WaasPolicy.
  • origins (dict(str, Origin)) -- The value to assign to the origins property of this WaasPolicy.
  • origin_groups (dict(str, OriginGroup)) -- The value to assign to the origin_groups property of this WaasPolicy.
  • policy_config (PolicyConfig) -- The value to assign to the policy_config property of this WaasPolicy.
  • waf_config (WafConfig) -- The value to assign to the waf_config property of this WaasPolicy.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this WaasPolicy.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this WaasPolicy.
additional_domains

Gets the additional_domains of this WaasPolicy. An array of additional domains for this web application.

Returns:The additional_domains of this WaasPolicy.
Return type:list[str]
cname

Gets the cname of this WaasPolicy. The CNAME record to add to your DNS configuration to route traffic for the domain, and all additional domains, through the WAF.

Returns:The cname of this WaasPolicy.
Return type:str
compartment_id

Gets the compartment_id of this WaasPolicy. The OCID of the WAAS policy's compartment.

Returns:The compartment_id of this WaasPolicy.
Return type:str
defined_tags

Gets the defined_tags of this WaasPolicy. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Returns:The defined_tags of this WaasPolicy.
Return type:dict(str, dict(str, object))
display_name

Gets the display_name of this WaasPolicy. The user-friendly name of the WAAS policy. The name can be changed and does not need to be unique.

Returns:The display_name of this WaasPolicy.
Return type:str
domain

Gets the domain of this WaasPolicy. The web application domain that the WAAS policy protects.

Returns:The domain of this WaasPolicy.
Return type:str
freeform_tags

Gets the freeform_tags of this WaasPolicy. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Returns:The freeform_tags of this WaasPolicy.
Return type:dict(str, str)
id

Gets the id of this WaasPolicy. The OCID of the WAAS policy.

Returns:The id of this WaasPolicy.
Return type:str
lifecycle_state

Gets the lifecycle_state of this WaasPolicy. The current lifecycle state of the WAAS policy.

Allowed values for this property are: "CREATING", "ACTIVE", "FAILED", "UPDATING", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this WaasPolicy.
Return type:str
origin_groups

Gets the origin_groups of this WaasPolicy. The map of origin groups and their keys used to associate origins to the wafConfig.

Returns:The origin_groups of this WaasPolicy.
Return type:dict(str, OriginGroup)
origins

Gets the origins of this WaasPolicy. A map of host servers (origins) and their keys for the web application. Origin keys are used to associate origins to specific protection rules. The key should be a user-friendly name for the host. Examples: primary or secondary.

Returns:The origins of this WaasPolicy.
Return type:dict(str, Origin)
policy_config

Gets the policy_config of this WaasPolicy.

Returns:The policy_config of this WaasPolicy.
Return type:PolicyConfig
time_created

Gets the time_created of this WaasPolicy. The date and time the policy was created, expressed in RFC 3339 timestamp format.

Returns:The time_created of this WaasPolicy.
Return type:datetime
waf_config

Gets the waf_config of this WaasPolicy.

Returns:The waf_config of this WaasPolicy.
Return type:WafConfig