CreateSteeringPolicyDetails

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

Bases: object

The body for defining a new steering policy.

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

TEMPLATE_CUSTOM = 'CUSTOM'

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

TEMPLATE_FAILOVER = 'FAILOVER'

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

TEMPLATE_LOAD_BALANCE = 'LOAD_BALANCE'

A constant which can be used with the template property of a CreateSteeringPolicyDetails. 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 CreateSteeringPolicyDetails. 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 CreateSteeringPolicyDetails. 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 CreateSteeringPolicyDetails. This constant has a value of "ROUTE_BY_IP"

__init__(**kwargs)

Initializes a new CreateSteeringPolicyDetails 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 CreateSteeringPolicyDetails.
  • display_name (str) -- The value to assign to the display_name property of this CreateSteeringPolicyDetails.
  • ttl (int) -- The value to assign to the ttl property of this CreateSteeringPolicyDetails.
  • health_check_monitor_id (str) -- The value to assign to the health_check_monitor_id property of this CreateSteeringPolicyDetails.
  • template (str) -- The value to assign to the template property of this CreateSteeringPolicyDetails. Allowed values for this property are: "FAILOVER", "LOAD_BALANCE", "ROUTE_BY_GEO", "ROUTE_BY_ASN", "ROUTE_BY_IP", "CUSTOM"
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this CreateSteeringPolicyDetails.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this CreateSteeringPolicyDetails.
  • answers (list[SteeringPolicyAnswer]) -- The value to assign to the answers property of this CreateSteeringPolicyDetails.
  • rules (list[SteeringPolicyRule]) -- The value to assign to the rules property of this CreateSteeringPolicyDetails.
answers

Gets the answers of this CreateSteeringPolicyDetails. The set of all answers that can potentially issue from the steering policy.

Returns:The answers of this CreateSteeringPolicyDetails.
Return type:list[SteeringPolicyAnswer]
compartment_id

[Required] Gets the compartment_id of this CreateSteeringPolicyDetails. The OCID of the compartment containing the steering policy.

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

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

[Required] Gets the display_name of this CreateSteeringPolicyDetails. 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 CreateSteeringPolicyDetails.
Return type:str
freeform_tags

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

Gets the health_check_monitor_id of this CreateSteeringPolicyDetails. 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 CreateSteeringPolicyDetails.
Return type:str
rules

Gets the rules of this CreateSteeringPolicyDetails. The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request.

The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response.

Returns:The rules of this CreateSteeringPolicyDetails.
Return type:list[SteeringPolicyRule]
template

[Required] Gets the template of this CreateSteeringPolicyDetails. 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"

Returns:The template of this CreateSteeringPolicyDetails.
Return type:str
ttl

Gets the ttl of this CreateSteeringPolicyDetails. 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 CreateSteeringPolicyDetails.
Return type:int