SteeringPolicySummary

class oci.dns.models.SteeringPolicySummary(**kwargs)

Bases: object

A DNS steering policy.

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 SteeringPolicySummary. This constant has a value of "ACTIVE"

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

TEMPLATE_CUSTOM = 'CUSTOM'

A constant which can be used with the template property of a SteeringPolicySummary. This constant has a value of "CUSTOM"

TEMPLATE_FAILOVER = 'FAILOVER'

A constant which can be used with the template property of a SteeringPolicySummary. This constant has a value of "FAILOVER"

TEMPLATE_LOAD_BALANCE = 'LOAD_BALANCE'

A constant which can be used with the template property of a SteeringPolicySummary. This constant has a value of "LOAD_BALANCE"

TEMPLATE_ROUTE_BY_ASN = 'ROUTE_BY_ASN'

A constant which can be used with the template property of a SteeringPolicySummary. This constant has a value of "ROUTE_BY_ASN"

TEMPLATE_ROUTE_BY_GEO = 'ROUTE_BY_GEO'

A constant which can be used with the template property of a SteeringPolicySummary. This constant has a value of "ROUTE_BY_GEO"

TEMPLATE_ROUTE_BY_IP = 'ROUTE_BY_IP'

A constant which can be used with the template property of a SteeringPolicySummary. This constant has a value of "ROUTE_BY_IP"

__init__(**kwargs)

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

Parameters:
  • compartment_id (str) -- The value to assign to the compartment_id property of this SteeringPolicySummary.
  • display_name (str) -- The value to assign to the display_name property of this SteeringPolicySummary.
  • ttl (int) -- The value to assign to the ttl property of this SteeringPolicySummary.
  • health_check_monitor_id (str) -- The value to assign to the health_check_monitor_id property of this SteeringPolicySummary.
  • template (str) -- The value to assign to the template property of this SteeringPolicySummary. Allowed values for this property are: "FAILOVER", "LOAD_BALANCE", "ROUTE_BY_GEO", "ROUTE_BY_ASN", "ROUTE_BY_IP", "CUSTOM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this SteeringPolicySummary.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this SteeringPolicySummary.
  • _self (str) -- The value to assign to the _self property of this SteeringPolicySummary.
  • id (str) -- The value to assign to the id property of this SteeringPolicySummary.
  • time_created (datetime) -- The value to assign to the time_created property of this SteeringPolicySummary.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this SteeringPolicySummary. Allowed values for this property are: "ACTIVE", "CREATING", "DELETED", "DELETING", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
compartment_id

Gets the compartment_id of this SteeringPolicySummary. The OCID of the compartment containing the steering policy.

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

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

Gets the display_name of this SteeringPolicySummary. A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.

Returns:The display_name of this SteeringPolicySummary.
Return type:str
freeform_tags

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

Gets the health_check_monitor_id of this SteeringPolicySummary. The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy.

Note: To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see Managing Health Checks.

Returns:The health_check_monitor_id of this SteeringPolicySummary.
Return type:str
id

Gets the id of this SteeringPolicySummary. The OCID of the resource.

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

Gets the lifecycle_state of this SteeringPolicySummary. The current state of the resource.

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

Returns:The lifecycle_state of this SteeringPolicySummary.
Return type:str
template

Gets the template of this SteeringPolicySummary. A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management's rules in a different order to produce the desired results when answering DNS queries.

Example: The FAILOVER template determines answers by filtering the policy's answers using the FILTER rule first, then the following rules in succession: HEALTH, PRIORITY, and LIMIT. This gives the domain dynamic failover capability.

It is strongly recommended to use a template other than CUSTOM when creating a steering policy.

All templates require the rule order to begin with an unconditional FILTER rule that keeps answers contingent upon answer.isDisabled != true, except for CUSTOM. A defined HEALTH rule must follow the FILTER rule if the policy references a healthCheckMonitorId. The last rule of a template must must be a LIMIT rule. For more information about templates and code examples, see Traffic Management API Guide.

Template Types

  • FAILOVER - Uses health check information on your endpoints to determine which DNS answers

to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy.

  • LOAD_BALANCE - Distributes web traffic to specified endpoints based on defined weights.
  • ROUTE_BY_GEO - Answers DNS queries based on the query's geographic location. For a list of geographic

locations to route by, see Traffic Management Geographic Locations.

  • ROUTE_BY_ASN - Answers DNS queries based on the query's originating ASN.
  • ROUTE_BY_IP - Answers DNS queries based on the query's IP address.
  • CUSTOM - Allows a customized configuration of rules.

Allowed values for this property are: "FAILOVER", "LOAD_BALANCE", "ROUTE_BY_GEO", "ROUTE_BY_ASN", "ROUTE_BY_IP", "CUSTOM", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The template of this SteeringPolicySummary.
Return type:str
time_created

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

Example: 2016-07-22T17:23:59:60Z

Returns:The time_created of this SteeringPolicySummary.
Return type:datetime
ttl

Gets the ttl of this SteeringPolicySummary. The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used.

Returns:The ttl of this SteeringPolicySummary.
Return type:int