Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Dns
  5. getSteeringPolicy
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Dns.getSteeringPolicy

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Steering Policy resource in Oracle Cloud Infrastructure DNS service.

    Gets information about the specified steering policy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSteeringPolicy = oci.Dns.getSteeringPolicy({
    steeringPolicyId: testSteeringPolicyOciDnsSteeringPolicy.id,
});

    import pulumi
import pulumi_oci as oci

test_steering_policy = oci.Dns.get_steering_policy(steering_policy_id=test_steering_policy_oci_dns_steering_policy["id"])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Dns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Dns.GetSteeringPolicy(ctx, &dns.GetSteeringPolicyArgs{
			SteeringPolicyId: testSteeringPolicyOciDnsSteeringPolicy.Id,
		}, nil)
		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 = Oci.Dns.GetSteeringPolicy.Invoke(new()
    {
        SteeringPolicyId = testSteeringPolicyOciDnsSteeringPolicy.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Dns.DnsFunctions;
import com.pulumi.oci.Dns.inputs.GetSteeringPolicyArgs;
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) {
        final var testSteeringPolicy = DnsFunctions.getSteeringPolicy(GetSteeringPolicyArgs.builder()
            .steeringPolicyId(testSteeringPolicyOciDnsSteeringPolicy.id())
            .build());

    }
}

    variables:
  testSteeringPolicy:
    fn::invoke:
      Function: oci:Dns:getSteeringPolicy
      Arguments:
        steeringPolicyId: ${testSteeringPolicyOciDnsSteeringPolicy.id}

    Using getSteeringPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSteeringPolicy(args: GetSteeringPolicyArgs, opts?: InvokeOptions): Promise<GetSteeringPolicyResult>
function getSteeringPolicyOutput(args: GetSteeringPolicyOutputArgs, opts?: InvokeOptions): Output<GetSteeringPolicyResult>
    def get_steering_policy(steering_policy_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSteeringPolicyResult
def get_steering_policy_output(steering_policy_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSteeringPolicyResult]
    func GetSteeringPolicy(ctx *Context, args *GetSteeringPolicyArgs, opts ...InvokeOption) (*GetSteeringPolicyResult, error)
func GetSteeringPolicyOutput(ctx *Context, args *GetSteeringPolicyOutputArgs, opts ...InvokeOption) GetSteeringPolicyResultOutput

    > Note: This function is named GetSteeringPolicy in the Go SDK.

    public static class GetSteeringPolicy 
{
    public static Task<GetSteeringPolicyResult> InvokeAsync(GetSteeringPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetSteeringPolicyResult> Invoke(GetSteeringPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSteeringPolicyResult> getSteeringPolicy(GetSteeringPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Dns/getSteeringPolicy:getSteeringPolicy
  arguments:
    # arguments dictionary

    The following arguments are supported:

    SteeringPolicyId string
    The OCID of the target steering policy.
    SteeringPolicyId string
    The OCID of the target steering policy.
    steeringPolicyId String
    The OCID of the target steering policy.
    steeringPolicyId string
    The OCID of the target steering policy.
    steering_policy_id str
    The OCID of the target steering policy.
    steeringPolicyId String
    The OCID of the target steering policy.

    getSteeringPolicy Result

    The following output properties are available:

    Answers List<GetSteeringPolicyAnswer>
    The set of all answers that can potentially issue from the steering policy.
    CompartmentId string
    The OCID of the compartment containing the steering policy.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    DisplayName string
    A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    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.
    HealthCheckMonitorId string
    The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy.
    Id string
    The OCID of the resource.
    Rules List<GetSteeringPolicyRule>
    The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request.
    Self string
    The canonical absolute URL of the resource.
    State string
    The current state of the resource.
    SteeringPolicyId string
    Template string
    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.
    TimeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format.
    Ttl int
    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.
    Answers []GetSteeringPolicyAnswer
    The set of all answers that can potentially issue from the steering policy.
    CompartmentId string
    The OCID of the compartment containing the steering policy.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    DisplayName string
    A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
    FreeformTags map[string]string
    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.
    HealthCheckMonitorId string
    The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy.
    Id string
    The OCID of the resource.
    Rules []GetSteeringPolicyRule
    The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request.
    Self string
    The canonical absolute URL of the resource.
    State string
    The current state of the resource.
    SteeringPolicyId string
    Template string
    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.
    TimeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format.
    Ttl int
    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.
    answers List<GetSteeringPolicyAnswer>
    The set of all answers that can potentially issue from the steering policy.
    compartmentId String
    The OCID of the compartment containing the steering policy.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName String
    A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
    freeformTags Map<String,String>
    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.
    healthCheckMonitorId String
    The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy.
    id String
    The OCID of the resource.
    rules List<GetSteeringPolicyRule>
    The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request.
    self String
    The canonical absolute URL of the resource.
    state String
    The current state of the resource.
    steeringPolicyId String
    template String
    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.
    timeCreated String
    The date and time the resource was created, expressed in RFC 3339 timestamp format.
    ttl Integer
    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.
    answers GetSteeringPolicyAnswer[]
    The set of all answers that can potentially issue from the steering policy.
    compartmentId string
    The OCID of the compartment containing the steering policy.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName string
    A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    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.
    healthCheckMonitorId string
    The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy.
    id string
    The OCID of the resource.
    rules GetSteeringPolicyRule[]
    The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request.
    self string
    The canonical absolute URL of the resource.
    state string
    The current state of the resource.
    steeringPolicyId string
    template string
    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.
    timeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format.
    ttl number
    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.
    answers Sequence[dns.GetSteeringPolicyAnswer]
    The set of all answers that can potentially issue from the steering policy.
    compartment_id str
    The OCID of the compartment containing the steering policy.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    display_name str
    A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    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_monitor_id str
    The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy.
    id str
    The OCID of the resource.
    rules Sequence[dns.GetSteeringPolicyRule]
    The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request.
    self str
    The canonical absolute URL of the resource.
    state str
    The current state of the resource.
    steering_policy_id str
    template str
    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.
    time_created str
    The date and time the resource was created, expressed in RFC 3339 timestamp format.
    ttl int
    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.
    answers List<Property Map>
    The set of all answers that can potentially issue from the steering policy.
    compartmentId String
    The OCID of the compartment containing the steering policy.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    displayName String
    A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
    freeformTags Map<String>
    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.
    healthCheckMonitorId String
    The OCID of the health check monitor providing health data about the answers of the steering policy. A steering policy answer with rdata matching a monitored endpoint will use the health data of that endpoint. A steering policy answer with rdata not matching any monitored endpoint will be assumed healthy.
    id String
    The OCID of the resource.
    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.
    self String
    The canonical absolute URL of the resource.
    state String
    The current state of the resource.
    steeringPolicyId String
    template String
    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.
    timeCreated String
    The date and time the resource was created, expressed in RFC 3339 timestamp format.
    ttl Number
    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.

    Supporting Types

    GetSteeringPolicyAnswer

    IsDisabled 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's isDisabled property can be referenced in answerCondition properties in rules using answer.isDisabled.
    Name string
    A user-friendly name for the answer, unique within the steering policy. An answer's name property can be referenced in answerCondition properties of rules using answer.name.
    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 in answerCondition properties of rules using answer.pool.
    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.
    IsDisabled 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's isDisabled property can be referenced in answerCondition properties in rules using answer.isDisabled.
    Name string
    A user-friendly name for the answer, unique within the steering policy. An answer's name property can be referenced in answerCondition properties of rules using answer.name.
    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 in answerCondition properties of rules using answer.pool.
    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.
    isDisabled 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's isDisabled property can be referenced in answerCondition properties in rules using answer.isDisabled.
    name String
    A user-friendly name for the answer, unique within the steering policy. An answer's name property can be referenced in answerCondition properties of rules using answer.name.
    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 in answerCondition properties of rules using answer.pool.
    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.
    isDisabled 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's isDisabled property can be referenced in answerCondition properties in rules using answer.isDisabled.
    name string
    A user-friendly name for the answer, unique within the steering policy. An answer's name property can be referenced in answerCondition properties of rules using answer.name.
    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 in answerCondition properties of rules using answer.pool.
    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's isDisabled property can be referenced in answerCondition properties in rules using answer.isDisabled.
    name str
    A user-friendly name for the answer, unique within the steering policy. An answer's name property can be referenced in answerCondition properties of rules using answer.name.
    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 in answerCondition properties of rules using answer.pool.
    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.
    isDisabled 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's isDisabled property can be referenced in answerCondition properties in rules using answer.isDisabled.
    name String
    A user-friendly name for the answer, unique within the steering policy. An answer's name property can be referenced in answerCondition properties of rules using answer.name.
    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 in answerCondition properties of rules using answer.pool.
    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.

    GetSteeringPolicyRule

    Cases List<GetSteeringPolicyRuleCase>
    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 of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query.
    DefaultAnswerDatas List<GetSteeringPolicyRuleDefaultAnswerData>
    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 matching answerConditions in its answerData. defaultAnswerData is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed.
    DefaultCount int
    Defines a default count if cases is not defined for the rule or a matching case does not define count. defaultCount is not applied if cases 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.
    RuleType 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 their shouldKeep value is true.
    • HEALTH - Removes answers from the list if their rdata 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 between 0 and 255.
    • LIMIT - Filters answers that are too far down the list. Parameter defaultCount specifies how many answers to keep. Example: If defaultCount has a value of 2 and there are five answers left, when the LIMIT rule is processed, only the first two answers will remain in the list.
    Cases []GetSteeringPolicyRuleCase
    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 of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query.
    DefaultAnswerDatas []GetSteeringPolicyRuleDefaultAnswerData
    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 matching answerConditions in its answerData. defaultAnswerData is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed.
    DefaultCount int
    Defines a default count if cases is not defined for the rule or a matching case does not define count. defaultCount is not applied if cases 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.
    RuleType 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 their shouldKeep value is true.
    • HEALTH - Removes answers from the list if their rdata 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 between 0 and 255.
    • LIMIT - Filters answers that are too far down the list. Parameter defaultCount specifies how many answers to keep. Example: If defaultCount has a value of 2 and there are five answers left, when the LIMIT rule is processed, only the first two answers will remain in the list.
    cases List<GetSteeringPolicyRuleCase>
    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 of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query.
    defaultAnswerDatas List<GetSteeringPolicyRuleDefaultAnswerData>
    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 matching answerConditions in its answerData. defaultAnswerData is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed.
    defaultCount Integer
    Defines a default count if cases is not defined for the rule or a matching case does not define count. defaultCount is not applied if cases 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.
    ruleType 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 their shouldKeep value is true.
    • HEALTH - Removes answers from the list if their rdata 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 between 0 and 255.
    • LIMIT - Filters answers that are too far down the list. Parameter defaultCount specifies how many answers to keep. Example: If defaultCount has a value of 2 and there are five answers left, when the LIMIT rule is processed, only the first two answers will remain in the list.
    cases GetSteeringPolicyRuleCase[]
    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 of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query.
    defaultAnswerDatas GetSteeringPolicyRuleDefaultAnswerData[]
    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 matching answerConditions in its answerData. defaultAnswerData is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed.
    defaultCount number
    Defines a default count if cases is not defined for the rule or a matching case does not define count. defaultCount is not applied if cases 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.
    ruleType 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 their shouldKeep value is true.
    • HEALTH - Removes answers from the list if their rdata 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 between 0 and 255.
    • LIMIT - Filters answers that are too far down the list. Parameter defaultCount specifies how many answers to keep. Example: If defaultCount has a value of 2 and there are five answers left, when the LIMIT rule is processed, only the first two answers will remain in the list.
    cases Sequence[dns.GetSteeringPolicyRuleCase]
    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 of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query.
    default_answer_datas Sequence[dns.GetSteeringPolicyRuleDefaultAnswerData]
    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 matching answerConditions in its answerData. defaultAnswerData is not applied if cases 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 define count. defaultCount is not applied if cases 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 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 their shouldKeep value is true.
    • HEALTH - Removes answers from the list if their rdata 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 between 0 and 255.
    • LIMIT - Filters answers that are too far down the list. Parameter defaultCount specifies how many answers to keep. Example: If defaultCount has a value of 2 and there are five answers left, when the LIMIT 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 of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query.
    defaultAnswerDatas List<Property Map>
    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 matching answerConditions in its answerData. defaultAnswerData is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed.
    defaultCount Number
    Defines a default count if cases is not defined for the rule or a matching case does not define count. defaultCount is not applied if cases 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.
    ruleType 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 their shouldKeep value is true.
    • HEALTH - Removes answers from the list if their rdata 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 between 0 and 255.
    • LIMIT - Filters answers that are too far down the list. Parameter defaultCount specifies how many answers to keep. Example: If defaultCount has a value of 2 and there are five answers left, when the LIMIT rule is processed, only the first two answers will remain in the list.

    GetSteeringPolicyRuleCase

    AnswerDatas List<GetSteeringPolicyRuleCaseAnswerData>
    An array of SteeringPolicyPriorityAnswerData objects.
    CaseCondition 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 a caseCondition expression query.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 to 2 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.
    AnswerDatas []GetSteeringPolicyRuleCaseAnswerData
    An array of SteeringPolicyPriorityAnswerData objects.
    CaseCondition 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 a caseCondition expression query.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 to 2 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.
    answerDatas List<GetSteeringPolicyRuleCaseAnswerData>
    An array of SteeringPolicyPriorityAnswerData objects.
    caseCondition 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 a caseCondition expression query.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 to 2 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.
    answerDatas GetSteeringPolicyRuleCaseAnswerData[]
    An array of SteeringPolicyPriorityAnswerData objects.
    caseCondition 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 a caseCondition expression query.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 to 2 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.GetSteeringPolicyRuleCaseAnswerData]
    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 a caseCondition expression query.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 to 2 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.
    answerDatas List<Property Map>
    An array of SteeringPolicyPriorityAnswerData objects.
    caseCondition 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 a caseCondition expression query.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 to 2 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.

    GetSteeringPolicyRuleCaseAnswerData

    AnswerCondition string
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    ShouldKeep 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 between 0 and 255.
    AnswerCondition string
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    ShouldKeep 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 between 0 and 255.
    answerCondition String
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    shouldKeep 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 between 0 and 255.
    answerCondition string
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    shouldKeep 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 between 0 and 255.
    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 between 0 and 255.
    answerCondition String
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    shouldKeep 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 between 0 and 255.

    GetSteeringPolicyRuleDefaultAnswerData

    AnswerCondition string
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    ShouldKeep 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 between 0 and 255.
    AnswerCondition string
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    ShouldKeep 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 between 0 and 255.
    answerCondition String
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    shouldKeep 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 between 0 and 255.
    answerCondition string
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    shouldKeep 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 between 0 and 255.
    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 between 0 and 255.
    answerCondition String
    An expression that is used to select a set of answers that match a condition. For example, answers with matching pool properties.
    shouldKeep 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 between 0 and 255.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi
    pulumi/pulumi-oci