oci.Dns.SteeringPolicy
Explore with Pulumi AI
This resource provides the Steering Policy resource in Oracle Cloud Infrastructure DNS service.
Creates a new steering policy in the specified compartment. For more information on creating policies with templates, see Traffic Management API Guide.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testSteeringPolicy = new oci.dns.SteeringPolicy("test_steering_policy", {
compartmentId: compartmentId,
displayName: steeringPolicyDisplayName,
template: steeringPolicyTemplate,
answers: [{
name: steeringPolicyAnswersName,
rdata: steeringPolicyAnswersRdata,
rtype: steeringPolicyAnswersRtype,
isDisabled: steeringPolicyAnswersIsDisabled,
pool: steeringPolicyAnswersPool,
}],
definedTags: steeringPolicyDefinedTags,
freeformTags: steeringPolicyFreeformTags,
healthCheckMonitorId: testHttpMonitor.id,
rules: [{
ruleType: steeringPolicyRulesRuleType,
cases: [{
answerDatas: [{
answerCondition: steeringPolicyRulesCasesAnswerDataAnswerCondition,
shouldKeep: steeringPolicyRulesCasesAnswerDataShouldKeep,
value: steeringPolicyRulesCasesAnswerDataValue,
}],
caseCondition: steeringPolicyRulesCasesCaseCondition,
count: steeringPolicyRulesCasesCount,
}],
defaultAnswerDatas: [{
answerCondition: steeringPolicyRulesDefaultAnswerDataAnswerCondition,
shouldKeep: steeringPolicyRulesDefaultAnswerDataShouldKeep,
value: steeringPolicyRulesDefaultAnswerDataValue,
}],
defaultCount: steeringPolicyRulesDefaultCount,
description: steeringPolicyRulesDescription,
}],
ttl: steeringPolicyTtl,
});
import pulumi
import pulumi_oci as oci
test_steering_policy = oci.dns.SteeringPolicy("test_steering_policy",
compartment_id=compartment_id,
display_name=steering_policy_display_name,
template=steering_policy_template,
answers=[oci.dns.SteeringPolicyAnswerArgs(
name=steering_policy_answers_name,
rdata=steering_policy_answers_rdata,
rtype=steering_policy_answers_rtype,
is_disabled=steering_policy_answers_is_disabled,
pool=steering_policy_answers_pool,
)],
defined_tags=steering_policy_defined_tags,
freeform_tags=steering_policy_freeform_tags,
health_check_monitor_id=test_http_monitor["id"],
rules=[oci.dns.SteeringPolicyRuleArgs(
rule_type=steering_policy_rules_rule_type,
cases=[oci.dns.SteeringPolicyRuleCaseArgs(
answer_datas=[oci.dns.SteeringPolicyRuleCaseAnswerDataArgs(
answer_condition=steering_policy_rules_cases_answer_data_answer_condition,
should_keep=steering_policy_rules_cases_answer_data_should_keep,
value=steering_policy_rules_cases_answer_data_value,
)],
case_condition=steering_policy_rules_cases_case_condition,
count=steering_policy_rules_cases_count,
)],
default_answer_datas=[oci.dns.SteeringPolicyRuleDefaultAnswerDataArgs(
answer_condition=steering_policy_rules_default_answer_data_answer_condition,
should_keep=steering_policy_rules_default_answer_data_should_keep,
value=steering_policy_rules_default_answer_data_value,
)],
default_count=steering_policy_rules_default_count,
description=steering_policy_rules_description,
)],
ttl=steering_policy_ttl)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Dns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Dns.NewSteeringPolicy(ctx, "test_steering_policy", &Dns.SteeringPolicyArgs{
CompartmentId: pulumi.Any(compartmentId),
DisplayName: pulumi.Any(steeringPolicyDisplayName),
Template: pulumi.Any(steeringPolicyTemplate),
Answers: dns.SteeringPolicyAnswerArray{
&dns.SteeringPolicyAnswerArgs{
Name: pulumi.Any(steeringPolicyAnswersName),
Rdata: pulumi.Any(steeringPolicyAnswersRdata),
Rtype: pulumi.Any(steeringPolicyAnswersRtype),
IsDisabled: pulumi.Any(steeringPolicyAnswersIsDisabled),
Pool: pulumi.Any(steeringPolicyAnswersPool),
},
},
DefinedTags: pulumi.Any(steeringPolicyDefinedTags),
FreeformTags: pulumi.Any(steeringPolicyFreeformTags),
HealthCheckMonitorId: pulumi.Any(testHttpMonitor.Id),
Rules: dns.SteeringPolicyRuleArray{
&dns.SteeringPolicyRuleArgs{
RuleType: pulumi.Any(steeringPolicyRulesRuleType),
Cases: dns.SteeringPolicyRuleCaseArray{
&dns.SteeringPolicyRuleCaseArgs{
AnswerDatas: dns.SteeringPolicyRuleCaseAnswerDataArray{
&dns.SteeringPolicyRuleCaseAnswerDataArgs{
AnswerCondition: pulumi.Any(steeringPolicyRulesCasesAnswerDataAnswerCondition),
ShouldKeep: pulumi.Any(steeringPolicyRulesCasesAnswerDataShouldKeep),
Value: pulumi.Any(steeringPolicyRulesCasesAnswerDataValue),
},
},
CaseCondition: pulumi.Any(steeringPolicyRulesCasesCaseCondition),
Count: pulumi.Any(steeringPolicyRulesCasesCount),
},
},
DefaultAnswerDatas: dns.SteeringPolicyRuleDefaultAnswerDataArray{
&dns.SteeringPolicyRuleDefaultAnswerDataArgs{
AnswerCondition: pulumi.Any(steeringPolicyRulesDefaultAnswerDataAnswerCondition),
ShouldKeep: pulumi.Any(steeringPolicyRulesDefaultAnswerDataShouldKeep),
Value: pulumi.Any(steeringPolicyRulesDefaultAnswerDataValue),
},
},
DefaultCount: pulumi.Any(steeringPolicyRulesDefaultCount),
Description: pulumi.Any(steeringPolicyRulesDescription),
},
},
Ttl: pulumi.Any(steeringPolicyTtl),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testSteeringPolicy = new Oci.Dns.SteeringPolicy("test_steering_policy", new()
{
CompartmentId = compartmentId,
DisplayName = steeringPolicyDisplayName,
Template = steeringPolicyTemplate,
Answers = new[]
{
new Oci.Dns.Inputs.SteeringPolicyAnswerArgs
{
Name = steeringPolicyAnswersName,
Rdata = steeringPolicyAnswersRdata,
Rtype = steeringPolicyAnswersRtype,
IsDisabled = steeringPolicyAnswersIsDisabled,
Pool = steeringPolicyAnswersPool,
},
},
DefinedTags = steeringPolicyDefinedTags,
FreeformTags = steeringPolicyFreeformTags,
HealthCheckMonitorId = testHttpMonitor.Id,
Rules = new[]
{
new Oci.Dns.Inputs.SteeringPolicyRuleArgs
{
RuleType = steeringPolicyRulesRuleType,
Cases = new[]
{
new Oci.Dns.Inputs.SteeringPolicyRuleCaseArgs
{
AnswerDatas = new[]
{
new Oci.Dns.Inputs.SteeringPolicyRuleCaseAnswerDataArgs
{
AnswerCondition = steeringPolicyRulesCasesAnswerDataAnswerCondition,
ShouldKeep = steeringPolicyRulesCasesAnswerDataShouldKeep,
Value = steeringPolicyRulesCasesAnswerDataValue,
},
},
CaseCondition = steeringPolicyRulesCasesCaseCondition,
Count = steeringPolicyRulesCasesCount,
},
},
DefaultAnswerDatas = new[]
{
new Oci.Dns.Inputs.SteeringPolicyRuleDefaultAnswerDataArgs
{
AnswerCondition = steeringPolicyRulesDefaultAnswerDataAnswerCondition,
ShouldKeep = steeringPolicyRulesDefaultAnswerDataShouldKeep,
Value = steeringPolicyRulesDefaultAnswerDataValue,
},
},
DefaultCount = steeringPolicyRulesDefaultCount,
Description = steeringPolicyRulesDescription,
},
},
Ttl = steeringPolicyTtl,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Dns.SteeringPolicy;
import com.pulumi.oci.Dns.SteeringPolicyArgs;
import com.pulumi.oci.Dns.inputs.SteeringPolicyAnswerArgs;
import com.pulumi.oci.Dns.inputs.SteeringPolicyRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testSteeringPolicy = new SteeringPolicy("testSteeringPolicy", SteeringPolicyArgs.builder()
.compartmentId(compartmentId)
.displayName(steeringPolicyDisplayName)
.template(steeringPolicyTemplate)
.answers(SteeringPolicyAnswerArgs.builder()
.name(steeringPolicyAnswersName)
.rdata(steeringPolicyAnswersRdata)
.rtype(steeringPolicyAnswersRtype)
.isDisabled(steeringPolicyAnswersIsDisabled)
.pool(steeringPolicyAnswersPool)
.build())
.definedTags(steeringPolicyDefinedTags)
.freeformTags(steeringPolicyFreeformTags)
.healthCheckMonitorId(testHttpMonitor.id())
.rules(SteeringPolicyRuleArgs.builder()
.ruleType(steeringPolicyRulesRuleType)
.cases(SteeringPolicyRuleCaseArgs.builder()
.answerDatas(SteeringPolicyRuleCaseAnswerDataArgs.builder()
.answerCondition(steeringPolicyRulesCasesAnswerDataAnswerCondition)
.shouldKeep(steeringPolicyRulesCasesAnswerDataShouldKeep)
.value(steeringPolicyRulesCasesAnswerDataValue)
.build())
.caseCondition(steeringPolicyRulesCasesCaseCondition)
.count(steeringPolicyRulesCasesCount)
.build())
.defaultAnswerDatas(SteeringPolicyRuleDefaultAnswerDataArgs.builder()
.answerCondition(steeringPolicyRulesDefaultAnswerDataAnswerCondition)
.shouldKeep(steeringPolicyRulesDefaultAnswerDataShouldKeep)
.value(steeringPolicyRulesDefaultAnswerDataValue)
.build())
.defaultCount(steeringPolicyRulesDefaultCount)
.description(steeringPolicyRulesDescription)
.build())
.ttl(steeringPolicyTtl)
.build());
}
}
resources:
testSteeringPolicy:
type: oci:Dns:SteeringPolicy
name: test_steering_policy
properties:
compartmentId: ${compartmentId}
displayName: ${steeringPolicyDisplayName}
template: ${steeringPolicyTemplate}
answers:
- name: ${steeringPolicyAnswersName}
rdata: ${steeringPolicyAnswersRdata}
rtype: ${steeringPolicyAnswersRtype}
isDisabled: ${steeringPolicyAnswersIsDisabled}
pool: ${steeringPolicyAnswersPool}
definedTags: ${steeringPolicyDefinedTags}
freeformTags: ${steeringPolicyFreeformTags}
healthCheckMonitorId: ${testHttpMonitor.id}
rules:
- ruleType: ${steeringPolicyRulesRuleType}
cases:
- answerDatas:
- answerCondition: ${steeringPolicyRulesCasesAnswerDataAnswerCondition}
shouldKeep: ${steeringPolicyRulesCasesAnswerDataShouldKeep}
value: ${steeringPolicyRulesCasesAnswerDataValue}
caseCondition: ${steeringPolicyRulesCasesCaseCondition}
count: ${steeringPolicyRulesCasesCount}
defaultAnswerDatas:
- answerCondition: ${steeringPolicyRulesDefaultAnswerDataAnswerCondition}
shouldKeep: ${steeringPolicyRulesDefaultAnswerDataShouldKeep}
value: ${steeringPolicyRulesDefaultAnswerDataValue}
defaultCount: ${steeringPolicyRulesDefaultCount}
description: ${steeringPolicyRulesDescription}
ttl: ${steeringPolicyTtl}
Create SteeringPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SteeringPolicy(name: string, args: SteeringPolicyArgs, opts?: CustomResourceOptions);
@overload
def SteeringPolicy(resource_name: str,
args: SteeringPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SteeringPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
template: Optional[str] = None,
answers: Optional[Sequence[_dns.SteeringPolicyAnswerArgs]] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
health_check_monitor_id: Optional[str] = None,
rules: Optional[Sequence[_dns.SteeringPolicyRuleArgs]] = None,
ttl: Optional[int] = None)
func NewSteeringPolicy(ctx *Context, name string, args SteeringPolicyArgs, opts ...ResourceOption) (*SteeringPolicy, error)
public SteeringPolicy(string name, SteeringPolicyArgs args, CustomResourceOptions? opts = null)
public SteeringPolicy(String name, SteeringPolicyArgs args)
public SteeringPolicy(String name, SteeringPolicyArgs args, CustomResourceOptions options)
type: oci:Dns:SteeringPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SteeringPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SteeringPolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SteeringPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SteeringPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SteeringPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var steeringPolicyResource = new Oci.Dns.SteeringPolicy("steeringPolicyResource", new()
{
CompartmentId = "string",
DisplayName = "string",
Template = "string",
Answers = new[]
{
new Oci.Dns.Inputs.SteeringPolicyAnswerArgs
{
Name = "string",
Rdata = "string",
Rtype = "string",
IsDisabled = false,
Pool = "string",
},
},
DefinedTags =
{
{ "string", "any" },
},
FreeformTags =
{
{ "string", "any" },
},
HealthCheckMonitorId = "string",
Rules = new[]
{
new Oci.Dns.Inputs.SteeringPolicyRuleArgs
{
RuleType = "string",
Cases = new[]
{
new Oci.Dns.Inputs.SteeringPolicyRuleCaseArgs
{
AnswerDatas = new[]
{
new Oci.Dns.Inputs.SteeringPolicyRuleCaseAnswerDataArgs
{
AnswerCondition = "string",
ShouldKeep = false,
Value = 0,
},
},
CaseCondition = "string",
Count = 0,
},
},
DefaultAnswerDatas = new[]
{
new Oci.Dns.Inputs.SteeringPolicyRuleDefaultAnswerDataArgs
{
AnswerCondition = "string",
ShouldKeep = false,
Value = 0,
},
},
DefaultCount = 0,
Description = "string",
},
},
Ttl = 0,
});
example, err := Dns.NewSteeringPolicy(ctx, "steeringPolicyResource", &Dns.SteeringPolicyArgs{
CompartmentId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
Template: pulumi.String("string"),
Answers: dns.SteeringPolicyAnswerArray{
&dns.SteeringPolicyAnswerArgs{
Name: pulumi.String("string"),
Rdata: pulumi.String("string"),
Rtype: pulumi.String("string"),
IsDisabled: pulumi.Bool(false),
Pool: pulumi.String("string"),
},
},
DefinedTags: pulumi.Map{
"string": pulumi.Any("any"),
},
FreeformTags: pulumi.Map{
"string": pulumi.Any("any"),
},
HealthCheckMonitorId: pulumi.String("string"),
Rules: dns.SteeringPolicyRuleArray{
&dns.SteeringPolicyRuleArgs{
RuleType: pulumi.String("string"),
Cases: dns.SteeringPolicyRuleCaseArray{
&dns.SteeringPolicyRuleCaseArgs{
AnswerDatas: dns.SteeringPolicyRuleCaseAnswerDataArray{
&dns.SteeringPolicyRuleCaseAnswerDataArgs{
AnswerCondition: pulumi.String("string"),
ShouldKeep: pulumi.Bool(false),
Value: pulumi.Int(0),
},
},
CaseCondition: pulumi.String("string"),
Count: pulumi.Int(0),
},
},
DefaultAnswerDatas: dns.SteeringPolicyRuleDefaultAnswerDataArray{
&dns.SteeringPolicyRuleDefaultAnswerDataArgs{
AnswerCondition: pulumi.String("string"),
ShouldKeep: pulumi.Bool(false),
Value: pulumi.Int(0),
},
},
DefaultCount: pulumi.Int(0),
Description: pulumi.String("string"),
},
},
Ttl: pulumi.Int(0),
})
var steeringPolicyResource = new SteeringPolicy("steeringPolicyResource", SteeringPolicyArgs.builder()
.compartmentId("string")
.displayName("string")
.template("string")
.answers(SteeringPolicyAnswerArgs.builder()
.name("string")
.rdata("string")
.rtype("string")
.isDisabled(false)
.pool("string")
.build())
.definedTags(Map.of("string", "any"))
.freeformTags(Map.of("string", "any"))
.healthCheckMonitorId("string")
.rules(SteeringPolicyRuleArgs.builder()
.ruleType("string")
.cases(SteeringPolicyRuleCaseArgs.builder()
.answerDatas(SteeringPolicyRuleCaseAnswerDataArgs.builder()
.answerCondition("string")
.shouldKeep(false)
.value(0)
.build())
.caseCondition("string")
.count(0)
.build())
.defaultAnswerDatas(SteeringPolicyRuleDefaultAnswerDataArgs.builder()
.answerCondition("string")
.shouldKeep(false)
.value(0)
.build())
.defaultCount(0)
.description("string")
.build())
.ttl(0)
.build());
steering_policy_resource = oci.dns.SteeringPolicy("steeringPolicyResource",
compartment_id="string",
display_name="string",
template="string",
answers=[oci.dns.SteeringPolicyAnswerArgs(
name="string",
rdata="string",
rtype="string",
is_disabled=False,
pool="string",
)],
defined_tags={
"string": "any",
},
freeform_tags={
"string": "any",
},
health_check_monitor_id="string",
rules=[oci.dns.SteeringPolicyRuleArgs(
rule_type="string",
cases=[oci.dns.SteeringPolicyRuleCaseArgs(
answer_datas=[oci.dns.SteeringPolicyRuleCaseAnswerDataArgs(
answer_condition="string",
should_keep=False,
value=0,
)],
case_condition="string",
count=0,
)],
default_answer_datas=[oci.dns.SteeringPolicyRuleDefaultAnswerDataArgs(
answer_condition="string",
should_keep=False,
value=0,
)],
default_count=0,
description="string",
)],
ttl=0)
const steeringPolicyResource = new oci.dns.SteeringPolicy("steeringPolicyResource", {
compartmentId: "string",
displayName: "string",
template: "string",
answers: [{
name: "string",
rdata: "string",
rtype: "string",
isDisabled: false,
pool: "string",
}],
definedTags: {
string: "any",
},
freeformTags: {
string: "any",
},
healthCheckMonitorId: "string",
rules: [{
ruleType: "string",
cases: [{
answerDatas: [{
answerCondition: "string",
shouldKeep: false,
value: 0,
}],
caseCondition: "string",
count: 0,
}],
defaultAnswerDatas: [{
answerCondition: "string",
shouldKeep: false,
value: 0,
}],
defaultCount: 0,
description: "string",
}],
ttl: 0,
});
type: oci:Dns:SteeringPolicy
properties:
answers:
- isDisabled: false
name: string
pool: string
rdata: string
rtype: string
compartmentId: string
definedTags:
string: any
displayName: string
freeformTags:
string: any
healthCheckMonitorId: string
rules:
- cases:
- answerDatas:
- answerCondition: string
shouldKeep: false
value: 0
caseCondition: string
count: 0
defaultAnswerDatas:
- answerCondition: string
shouldKeep: false
value: 0
defaultCount: 0
description: string
ruleType: string
template: string
ttl: 0
SteeringPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SteeringPolicy resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment containing the steering policy.
- Display
Name string - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- Template string
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- Answers
List<Steering
Policy Answer> - The set of all answers that can potentially issue from the steering policy.
- Dictionary<string, object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Dictionary<string, object>
- (Updatable) 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.
- Health
Check stringMonitor Id (Updatable) 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 withrdata
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.
- Rules
List<Steering
Policy Rule> 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.
- Ttl int
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - (Updatable) The OCID of the compartment containing the steering policy.
- Display
Name string - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- Template string
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- Answers
[]Steering
Policy Answer Args - The set of all answers that can potentially issue from the steering policy.
- map[string]interface{}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- map[string]interface{}
- (Updatable) 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.
- Health
Check stringMonitor Id (Updatable) 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 withrdata
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.
- Rules
[]Steering
Policy Rule Args 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.
- Ttl int
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of the compartment containing the steering policy.
- display
Name String - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- template String
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- answers
List<Steering
Policy Answer> - The set of all answers that can potentially issue from the steering policy.
- Map<String,Object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<String,Object>
- (Updatable) 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.
- health
Check StringMonitor Id (Updatable) 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 withrdata
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.
- rules
List<Steering
Policy Rule> 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.
- ttl Integer
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id string - (Updatable) The OCID of the compartment containing the steering policy.
- display
Name string - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- template string
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- answers
Steering
Policy Answer[] - The set of all answers that can potentially issue from the steering policy.
- {[key: string]: any}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- {[key: string]: any}
- (Updatable) 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.
- health
Check stringMonitor Id (Updatable) 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 withrdata
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.
- rules
Steering
Policy Rule[] 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.
- ttl number
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment_
id str - (Updatable) The OCID of the compartment containing the steering policy.
- display_
name str - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- template str
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- answers
Sequence[dns.
Steering Policy Answer Args] - The set of all answers that can potentially issue from the steering policy.
- Mapping[str, Any]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Mapping[str, Any]
- (Updatable) 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.
- health_
check_ strmonitor_ id (Updatable) 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 withrdata
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.
- rules
Sequence[dns.
Steering Policy Rule Args] 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.
- ttl int
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of the compartment containing the steering policy.
- display
Name String - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- template String
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- answers List<Property Map>
- The set of all answers that can potentially issue from the steering policy.
- Map<Any>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Map<Any>
- (Updatable) 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.
- health
Check StringMonitor Id (Updatable) 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 withrdata
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.
- rules List<Property Map>
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.
- ttl Number
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the SteeringPolicy resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Self string
- The canonical absolute URL of the resource.
- State string
- The current state of the resource.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- Id string
- The provider-assigned unique ID for this managed resource.
- Self string
- The canonical absolute URL of the resource.
- State string
- The current state of the resource.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- id String
- The provider-assigned unique ID for this managed resource.
- self String
- The canonical absolute URL of the resource.
- state String
- The current state of the resource.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- id string
- The provider-assigned unique ID for this managed resource.
- self string
- The canonical absolute URL of the resource.
- state string
- The current state of the resource.
- time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- id str
- The provider-assigned unique ID for this managed resource.
- self str
- The canonical absolute URL of the resource.
- state str
- The current state of the resource.
- time_
created str - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- id String
- The provider-assigned unique ID for this managed resource.
- self String
- The canonical absolute URL of the resource.
- state String
- The current state of the resource.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format.
Look up Existing SteeringPolicy Resource
Get an existing SteeringPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SteeringPolicyState, opts?: CustomResourceOptions): SteeringPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
answers: Optional[Sequence[_dns.SteeringPolicyAnswerArgs]] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
health_check_monitor_id: Optional[str] = None,
rules: Optional[Sequence[_dns.SteeringPolicyRuleArgs]] = None,
self: Optional[str] = None,
state: Optional[str] = None,
template: Optional[str] = None,
time_created: Optional[str] = None,
ttl: Optional[int] = None) -> SteeringPolicy
func GetSteeringPolicy(ctx *Context, name string, id IDInput, state *SteeringPolicyState, opts ...ResourceOption) (*SteeringPolicy, error)
public static SteeringPolicy Get(string name, Input<string> id, SteeringPolicyState? state, CustomResourceOptions? opts = null)
public static SteeringPolicy get(String name, Output<String> id, SteeringPolicyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Answers
List<Steering
Policy Answer> - The set of all answers that can potentially issue from the steering policy.
- Compartment
Id string - (Updatable) The OCID of the compartment containing the steering policy.
- Dictionary<string, object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Display
Name string - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- Dictionary<string, object>
- (Updatable) 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.
- Health
Check stringMonitor Id (Updatable) 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 withrdata
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.
- Rules
List<Steering
Policy Rule> 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.
- Self string
- The canonical absolute URL of the resource.
- State string
- The current state of the resource.
- Template string
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- Ttl int
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Answers
[]Steering
Policy Answer Args - The set of all answers that can potentially issue from the steering policy.
- Compartment
Id string - (Updatable) The OCID of the compartment containing the steering policy.
- map[string]interface{}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- Display
Name string - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- map[string]interface{}
- (Updatable) 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.
- Health
Check stringMonitor Id (Updatable) 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 withrdata
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.
- Rules
[]Steering
Policy Rule Args 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.
- Self string
- The canonical absolute URL of the resource.
- State string
- The current state of the resource.
- Template string
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- Time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- Ttl int
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- answers
List<Steering
Policy Answer> - The set of all answers that can potentially issue from the steering policy.
- compartment
Id String - (Updatable) The OCID of the compartment containing the steering policy.
- Map<String,Object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name String - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- Map<String,Object>
- (Updatable) 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.
- health
Check StringMonitor Id (Updatable) 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 withrdata
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.
- rules
List<Steering
Policy Rule> 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.
- self String
- The canonical absolute URL of the resource.
- state String
- The current state of the resource.
- template String
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- ttl Integer
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- answers
Steering
Policy Answer[] - The set of all answers that can potentially issue from the steering policy.
- compartment
Id string - (Updatable) The OCID of the compartment containing the steering policy.
- {[key: string]: any}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name string - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- {[key: string]: any}
- (Updatable) 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.
- health
Check stringMonitor Id (Updatable) 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 withrdata
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.
- rules
Steering
Policy Rule[] 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.
- self string
- The canonical absolute URL of the resource.
- state string
- The current state of the resource.
- template string
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- time
Created string - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- ttl number
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- answers
Sequence[dns.
Steering Policy Answer Args] - The set of all answers that can potentially issue from the steering policy.
- compartment_
id str - (Updatable) The OCID of the compartment containing the steering policy.
- Mapping[str, Any]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display_
name str - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- Mapping[str, Any]
- (Updatable) 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.
- health_
check_ strmonitor_ id (Updatable) 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 withrdata
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.
- rules
Sequence[dns.
Steering Policy Rule Args] 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.
- self str
- The canonical absolute URL of the resource.
- state str
- The current state of the resource.
- template str
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- time_
created str - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- ttl int
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- answers List<Property Map>
- The set of all answers that can potentially issue from the steering policy.
- compartment
Id String - (Updatable) The OCID of the compartment containing the steering policy.
- Map<Any>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
- display
Name String - (Updatable) A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
- Map<Any>
- (Updatable) 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.
- health
Check StringMonitor Id (Updatable) 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 withrdata
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.
- rules List<Property Map>
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.
- self String
- The canonical absolute URL of the resource.
- state String
- The current state of the resource.
- template String
(Updatable) 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 theFILTER
rule first, then the following rules in succession:HEALTH
,PRIORITY
, andLIMIT
. 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 uponanswer.isDisabled != true
, except forCUSTOM
. A definedHEALTH
rule must follow theFILTER
rule if the policy references ahealthCheckMonitorId
. The last rule of a template must must be aLIMIT
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.
- time
Created String - The date and time the resource was created, expressed in RFC 3339 timestamp format.
- ttl Number
(Updatable) 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.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Supporting Types
SteeringPolicyAnswer, SteeringPolicyAnswerArgs
- Name string
- A user-friendly name for the answer, unique within the steering policy. An answer's
name
property can be referenced inanswerCondition
properties of rules usinganswer.name
. - Rdata string
- The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types.
- Rtype string
- The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see Supported DNS Resource Record Types.
- Is
Disabled bool - Set this property to
true
to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer'sisDisabled
property can be referenced inanswerCondition
properties in rules usinganswer.isDisabled
. - Pool string
- The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's
pool
property can be referenced inanswerCondition
properties of rules usinganswer.pool
.
- Name string
- A user-friendly name for the answer, unique within the steering policy. An answer's
name
property can be referenced inanswerCondition
properties of rules usinganswer.name
. - Rdata string
- The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types.
- Rtype string
- The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see Supported DNS Resource Record Types.
- Is
Disabled bool - Set this property to
true
to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer'sisDisabled
property can be referenced inanswerCondition
properties in rules usinganswer.isDisabled
. - Pool string
- The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's
pool
property can be referenced inanswerCondition
properties of rules usinganswer.pool
.
- name String
- A user-friendly name for the answer, unique within the steering policy. An answer's
name
property can be referenced inanswerCondition
properties of rules usinganswer.name
. - rdata String
- The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types.
- rtype String
- The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see Supported DNS Resource Record Types.
- is
Disabled Boolean - Set this property to
true
to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer'sisDisabled
property can be referenced inanswerCondition
properties in rules usinganswer.isDisabled
. - pool String
- The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's
pool
property can be referenced inanswerCondition
properties of rules usinganswer.pool
.
- name string
- A user-friendly name for the answer, unique within the steering policy. An answer's
name
property can be referenced inanswerCondition
properties of rules usinganswer.name
. - rdata string
- The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types.
- rtype string
- The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see Supported DNS Resource Record Types.
- is
Disabled boolean - Set this property to
true
to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer'sisDisabled
property can be referenced inanswerCondition
properties in rules usinganswer.isDisabled
. - pool string
- The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's
pool
property can be referenced inanswerCondition
properties of rules usinganswer.pool
.
- name str
- A user-friendly name for the answer, unique within the steering policy. An answer's
name
property can be referenced inanswerCondition
properties of rules usinganswer.name
. - rdata str
- The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types.
- rtype str
- The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see Supported DNS Resource Record Types.
- is_
disabled bool - Set this property to
true
to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer'sisDisabled
property can be referenced inanswerCondition
properties in rules usinganswer.isDisabled
. - pool str
- The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's
pool
property can be referenced inanswerCondition
properties of rules usinganswer.pool
.
- name String
- A user-friendly name for the answer, unique within the steering policy. An answer's
name
property can be referenced inanswerCondition
properties of rules usinganswer.name
. - rdata String
- The record's data, as whitespace-delimited tokens in type-specific presentation format. All RDATA is normalized and the returned presentation of your RDATA may differ from its initial input. For more information about RDATA, see Supported DNS Resource Record Types.
- rtype String
- The type of DNS record, such as A or CNAME. Only A, AAAA, and CNAME are supported. For more information, see Supported DNS Resource Record Types.
- is
Disabled Boolean - Set this property to
true
to indicate that the answer is administratively disabled, such as when the corresponding server is down for maintenance. An answer'sisDisabled
property can be referenced inanswerCondition
properties in rules usinganswer.isDisabled
. - pool String
- The freeform name of a group of one or more records in which this record is included, such as "LAX data center". An answer's
pool
property can be referenced inanswerCondition
properties of rules usinganswer.pool
.
SteeringPolicyRule, SteeringPolicyRuleArgs
- Rule
Type string - The type of a rule determines its sorting/filtering behavior.
FILTER
- Filters the list of answers based on their defined boolean data. Answers remain only if theirshouldKeep
value istrue
.HEALTH
- Removes answers from the list if theirrdata
matches a target in the health check monitor referenced by the steering policy and the target is reported down.WEIGHTED
- Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently.PRIORITY
- Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.LIMIT
- Filters answers that are too far down the list. ParameterdefaultCount
specifies how many answers to keep. Example: IfdefaultCount
has a value of2
and there are five answers left, when theLIMIT
rule is processed, only the first two answers will remain in the list.
- Cases
List<Steering
Policy Rule Case> - An array of
caseConditions
. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence ofcases
, it is always evaluated with the same configuration during processing. When a rule has an empty sequence ofcases
, it is always ignored during processing. When a rule has a non-empty sequence ofcases
, its behavior during processing is configured by the first matchingcase
in the sequence. When a rule has no matching cases the rule is ignored. A rule case with nocaseCondition
always matches. A rule case with acaseCondition
matches only when that expression evaluates to true for the given query. - Default
Answer List<SteeringDatas Policy Rule Default Answer Data> - Defines a default set of answer conditions and values that are applied to an answer when
cases
is not defined for the rule, or a matching case does not have any matchinganswerCondition
s in itsanswerData
.defaultAnswerData
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. - Default
Count int - Defines a default count if
cases
is not defined for the rule or a matching case does not definecount
.defaultCount
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. - Description string
- A user-defined description of the rule's purpose or behavior.
- Rule
Type string - The type of a rule determines its sorting/filtering behavior.
FILTER
- Filters the list of answers based on their defined boolean data. Answers remain only if theirshouldKeep
value istrue
.HEALTH
- Removes answers from the list if theirrdata
matches a target in the health check monitor referenced by the steering policy and the target is reported down.WEIGHTED
- Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently.PRIORITY
- Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.LIMIT
- Filters answers that are too far down the list. ParameterdefaultCount
specifies how many answers to keep. Example: IfdefaultCount
has a value of2
and there are five answers left, when theLIMIT
rule is processed, only the first two answers will remain in the list.
- Cases
[]Steering
Policy Rule Case - An array of
caseConditions
. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence ofcases
, it is always evaluated with the same configuration during processing. When a rule has an empty sequence ofcases
, it is always ignored during processing. When a rule has a non-empty sequence ofcases
, its behavior during processing is configured by the first matchingcase
in the sequence. When a rule has no matching cases the rule is ignored. A rule case with nocaseCondition
always matches. A rule case with acaseCondition
matches only when that expression evaluates to true for the given query. - Default
Answer []SteeringDatas Policy Rule Default Answer Data - Defines a default set of answer conditions and values that are applied to an answer when
cases
is not defined for the rule, or a matching case does not have any matchinganswerCondition
s in itsanswerData
.defaultAnswerData
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. - Default
Count int - Defines a default count if
cases
is not defined for the rule or a matching case does not definecount
.defaultCount
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. - Description string
- A user-defined description of the rule's purpose or behavior.
- rule
Type String - The type of a rule determines its sorting/filtering behavior.
FILTER
- Filters the list of answers based on their defined boolean data. Answers remain only if theirshouldKeep
value istrue
.HEALTH
- Removes answers from the list if theirrdata
matches a target in the health check monitor referenced by the steering policy and the target is reported down.WEIGHTED
- Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently.PRIORITY
- Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.LIMIT
- Filters answers that are too far down the list. ParameterdefaultCount
specifies how many answers to keep. Example: IfdefaultCount
has a value of2
and there are five answers left, when theLIMIT
rule is processed, only the first two answers will remain in the list.
- cases
List<Steering
Policy Rule Case> - An array of
caseConditions
. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence ofcases
, it is always evaluated with the same configuration during processing. When a rule has an empty sequence ofcases
, it is always ignored during processing. When a rule has a non-empty sequence ofcases
, its behavior during processing is configured by the first matchingcase
in the sequence. When a rule has no matching cases the rule is ignored. A rule case with nocaseCondition
always matches. A rule case with acaseCondition
matches only when that expression evaluates to true for the given query. - default
Answer List<SteeringDatas Policy Rule Default Answer Data> - Defines a default set of answer conditions and values that are applied to an answer when
cases
is not defined for the rule, or a matching case does not have any matchinganswerCondition
s in itsanswerData
.defaultAnswerData
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. - default
Count Integer - Defines a default count if
cases
is not defined for the rule or a matching case does not definecount
.defaultCount
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. - description String
- A user-defined description of the rule's purpose or behavior.
- rule
Type string - The type of a rule determines its sorting/filtering behavior.
FILTER
- Filters the list of answers based on their defined boolean data. Answers remain only if theirshouldKeep
value istrue
.HEALTH
- Removes answers from the list if theirrdata
matches a target in the health check monitor referenced by the steering policy and the target is reported down.WEIGHTED
- Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently.PRIORITY
- Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.LIMIT
- Filters answers that are too far down the list. ParameterdefaultCount
specifies how many answers to keep. Example: IfdefaultCount
has a value of2
and there are five answers left, when theLIMIT
rule is processed, only the first two answers will remain in the list.
- cases
Steering
Policy Rule Case[] - An array of
caseConditions
. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence ofcases
, it is always evaluated with the same configuration during processing. When a rule has an empty sequence ofcases
, it is always ignored during processing. When a rule has a non-empty sequence ofcases
, its behavior during processing is configured by the first matchingcase
in the sequence. When a rule has no matching cases the rule is ignored. A rule case with nocaseCondition
always matches. A rule case with acaseCondition
matches only when that expression evaluates to true for the given query. - default
Answer SteeringDatas Policy Rule Default Answer Data[] - Defines a default set of answer conditions and values that are applied to an answer when
cases
is not defined for the rule, or a matching case does not have any matchinganswerCondition
s in itsanswerData
.defaultAnswerData
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. - default
Count number - Defines a default count if
cases
is not defined for the rule or a matching case does not definecount
.defaultCount
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. - description string
- A user-defined description of the rule's purpose or behavior.
- rule_
type str - The type of a rule determines its sorting/filtering behavior.
FILTER
- Filters the list of answers based on their defined boolean data. Answers remain only if theirshouldKeep
value istrue
.HEALTH
- Removes answers from the list if theirrdata
matches a target in the health check monitor referenced by the steering policy and the target is reported down.WEIGHTED
- Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently.PRIORITY
- Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.LIMIT
- Filters answers that are too far down the list. ParameterdefaultCount
specifies how many answers to keep. Example: IfdefaultCount
has a value of2
and there are five answers left, when theLIMIT
rule is processed, only the first two answers will remain in the list.
- cases
Sequence[dns.
Steering Policy Rule Case] - An array of
caseConditions
. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence ofcases
, it is always evaluated with the same configuration during processing. When a rule has an empty sequence ofcases
, it is always ignored during processing. When a rule has a non-empty sequence ofcases
, its behavior during processing is configured by the first matchingcase
in the sequence. When a rule has no matching cases the rule is ignored. A rule case with nocaseCondition
always matches. A rule case with acaseCondition
matches only when that expression evaluates to true for the given query. - default_
answer_ Sequence[dns.datas Steering Policy Rule Default Answer Data] - Defines a default set of answer conditions and values that are applied to an answer when
cases
is not defined for the rule, or a matching case does not have any matchinganswerCondition
s in itsanswerData
.defaultAnswerData
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. - default_
count int - Defines a default count if
cases
is not defined for the rule or a matching case does not definecount
.defaultCount
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. - description str
- A user-defined description of the rule's purpose or behavior.
- rule
Type String - The type of a rule determines its sorting/filtering behavior.
FILTER
- Filters the list of answers based on their defined boolean data. Answers remain only if theirshouldKeep
value istrue
.HEALTH
- Removes answers from the list if theirrdata
matches a target in the health check monitor referenced by the steering policy and the target is reported down.WEIGHTED
- Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently.PRIORITY
- Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.LIMIT
- Filters answers that are too far down the list. ParameterdefaultCount
specifies how many answers to keep. Example: IfdefaultCount
has a value of2
and there are five answers left, when theLIMIT
rule is processed, only the first two answers will remain in the list.
- cases List<Property Map>
- An array of
caseConditions
. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence ofcases
, it is always evaluated with the same configuration during processing. When a rule has an empty sequence ofcases
, it is always ignored during processing. When a rule has a non-empty sequence ofcases
, its behavior during processing is configured by the first matchingcase
in the sequence. When a rule has no matching cases the rule is ignored. A rule case with nocaseCondition
always matches. A rule case with acaseCondition
matches only when that expression evaluates to true for the given query. - default
Answer List<Property Map>Datas - Defines a default set of answer conditions and values that are applied to an answer when
cases
is not defined for the rule, or a matching case does not have any matchinganswerCondition
s in itsanswerData
.defaultAnswerData
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. - default
Count Number - Defines a default count if
cases
is not defined for the rule or a matching case does not definecount
.defaultCount
is not applied ifcases
is defined and there are no matching cases. In this scenario, the next rule will be processed. If no rules remain to be processed, the answer will be chosen from the remaining list of answers. - description String
- A user-defined description of the rule's purpose or behavior.
SteeringPolicyRuleCase, SteeringPolicyRuleCaseArgs
- Answer
Datas List<SteeringPolicy Rule Case Answer Data> - An array of
SteeringPolicyPriorityAnswerData
objects. - Case
Condition string - An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. Example: If you have an office that uses the subnet
192.0.2.0/24
you could use acaseCondition
expressionquery.client.subnet in ('192.0.2.0/24')
to define a case that matches queries from that office. - Count int
- The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the
count
property is set to2
and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed.
- Answer
Datas []SteeringPolicy Rule Case Answer Data - An array of
SteeringPolicyPriorityAnswerData
objects. - Case
Condition string - An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. Example: If you have an office that uses the subnet
192.0.2.0/24
you could use acaseCondition
expressionquery.client.subnet in ('192.0.2.0/24')
to define a case that matches queries from that office. - Count int
- The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the
count
property is set to2
and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed.
- answer
Datas List<SteeringPolicy Rule Case Answer Data> - An array of
SteeringPolicyPriorityAnswerData
objects. - case
Condition String - An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. Example: If you have an office that uses the subnet
192.0.2.0/24
you could use acaseCondition
expressionquery.client.subnet in ('192.0.2.0/24')
to define a case that matches queries from that office. - count Integer
- The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the
count
property is set to2
and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed.
- answer
Datas SteeringPolicy Rule Case Answer Data[] - An array of
SteeringPolicyPriorityAnswerData
objects. - case
Condition string - An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. Example: If you have an office that uses the subnet
192.0.2.0/24
you could use acaseCondition
expressionquery.client.subnet in ('192.0.2.0/24')
to define a case that matches queries from that office. - count number
- The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the
count
property is set to2
and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed.
- answer_
datas Sequence[dns.Steering Policy Rule Case Answer Data] - An array of
SteeringPolicyPriorityAnswerData
objects. - case_
condition str - An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. Example: If you have an office that uses the subnet
192.0.2.0/24
you could use acaseCondition
expressionquery.client.subnet in ('192.0.2.0/24')
to define a case that matches queries from that office. - count int
- The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the
count
property is set to2
and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed.
- answer
Datas List<Property Map> - An array of
SteeringPolicyPriorityAnswerData
objects. - case
Condition String - An expression that uses conditions at the time of a DNS query to indicate whether a case matches. Conditions may include the geographical location, IP subnet, or ASN the DNS query originated. Example: If you have an office that uses the subnet
192.0.2.0/24
you could use acaseCondition
expressionquery.client.subnet in ('192.0.2.0/24')
to define a case that matches queries from that office. - count Number
- The number of answers allowed to remain after the limit rule has been processed, keeping only the first of the remaining answers in the list. Example: If the
count
property is set to2
and four answers remain before the limit rule is processed, only the first two answers in the list will remain after the limit rule has been processed.
SteeringPolicyRuleCaseAnswerData, SteeringPolicyRuleCaseAnswerDataArgs
- Answer
Condition string - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- Should
Keep bool - Keeps the answer only if the value is
true
. - Value int
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- Answer
Condition string - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- Should
Keep bool - Keeps the answer only if the value is
true
. - Value int
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- answer
Condition String - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- should
Keep Boolean - Keeps the answer only if the value is
true
. - value Integer
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- answer
Condition string - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- should
Keep boolean - Keeps the answer only if the value is
true
. - value number
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- answer_
condition str - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- should_
keep bool - Keeps the answer only if the value is
true
. - value int
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- answer
Condition String - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- should
Keep Boolean - Keeps the answer only if the value is
true
. - value Number
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
SteeringPolicyRuleDefaultAnswerData, SteeringPolicyRuleDefaultAnswerDataArgs
- Answer
Condition string - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- Should
Keep bool - Keeps the answer only if the value is
true
. - Value int
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- Answer
Condition string - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- Should
Keep bool - Keeps the answer only if the value is
true
. - Value int
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- answer
Condition String - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- should
Keep Boolean - Keeps the answer only if the value is
true
. - value Integer
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- answer
Condition string - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- should
Keep boolean - Keeps the answer only if the value is
true
. - value number
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- answer_
condition str - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- should_
keep bool - Keeps the answer only if the value is
true
. - value int
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
- answer
Condition String - An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
- should
Keep Boolean - Keeps the answer only if the value is
true
. - value Number
- The rank assigned to the set of answers that match the expression in
answerCondition
. Answers with the lowest values move to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between0
and255
.
Import
SteeringPolicies can be imported using the id
, e.g.
$ pulumi import oci:Dns/steeringPolicy:SteeringPolicy test_steering_policy "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.