Oracle Cloud Infrastructure v2.29.0, Apr 9 25

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.Dns.getSteeringPolicies

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const testSteeringPolicies = oci.Dns.getSteeringPolicies({
    compartmentId: compartmentId,
    displayName: steeringPolicyDisplayName,
    displayNameContains: steeringPolicyDisplayNameContains,
    healthCheckMonitorId: testHttpMonitor.id,
    id: steeringPolicyId,
    state: steeringPolicyState,
    template: steeringPolicyTemplate,
    timeCreatedGreaterThanOrEqualTo: steeringPolicyTimeCreatedGreaterThanOrEqualTo,
    timeCreatedLessThan: steeringPolicyTimeCreatedLessThan,
});

import pulumi
import pulumi_oci as oci

test_steering_policies = oci.Dns.get_steering_policies(compartment_id=compartment_id,
    display_name=steering_policy_display_name,
    display_name_contains=steering_policy_display_name_contains,
    health_check_monitor_id=test_http_monitor["id"],
    id=steering_policy_id,
    state=steering_policy_state,
    template=steering_policy_template,
    time_created_greater_than_or_equal_to=steering_policy_time_created_greater_than_or_equal_to,
    time_created_less_than=steering_policy_time_created_less_than)

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.GetSteeringPolicies(ctx, &dns.GetSteeringPoliciesArgs{
			CompartmentId:                   compartmentId,
			DisplayName:                     pulumi.StringRef(steeringPolicyDisplayName),
			DisplayNameContains:             pulumi.StringRef(steeringPolicyDisplayNameContains),
			HealthCheckMonitorId:            pulumi.StringRef(testHttpMonitor.Id),
			Id:                              pulumi.StringRef(steeringPolicyId),
			State:                           pulumi.StringRef(steeringPolicyState),
			Template:                        pulumi.StringRef(steeringPolicyTemplate),
			TimeCreatedGreaterThanOrEqualTo: pulumi.StringRef(steeringPolicyTimeCreatedGreaterThanOrEqualTo),
			TimeCreatedLessThan:             pulumi.StringRef(steeringPolicyTimeCreatedLessThan),
		}, 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 testSteeringPolicies = Oci.Dns.GetSteeringPolicies.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = steeringPolicyDisplayName,
        DisplayNameContains = steeringPolicyDisplayNameContains,
        HealthCheckMonitorId = testHttpMonitor.Id,
        Id = steeringPolicyId,
        State = steeringPolicyState,
        Template = steeringPolicyTemplate,
        TimeCreatedGreaterThanOrEqualTo = steeringPolicyTimeCreatedGreaterThanOrEqualTo,
        TimeCreatedLessThan = steeringPolicyTimeCreatedLessThan,
    });

});

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.GetSteeringPoliciesArgs;
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 testSteeringPolicies = DnsFunctions.getSteeringPolicies(GetSteeringPoliciesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(steeringPolicyDisplayName)
            .displayNameContains(steeringPolicyDisplayNameContains)
            .healthCheckMonitorId(testHttpMonitor.id())
            .id(steeringPolicyId)
            .state(steeringPolicyState)
            .template(steeringPolicyTemplate)
            .timeCreatedGreaterThanOrEqualTo(steeringPolicyTimeCreatedGreaterThanOrEqualTo)
            .timeCreatedLessThan(steeringPolicyTimeCreatedLessThan)
            .build());

    }
}

variables:
  testSteeringPolicies:
    fn::invoke:
      function: oci:Dns:getSteeringPolicies
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${steeringPolicyDisplayName}
        displayNameContains: ${steeringPolicyDisplayNameContains}
        healthCheckMonitorId: ${testHttpMonitor.id}
        id: ${steeringPolicyId}
        state: ${steeringPolicyState}
        template: ${steeringPolicyTemplate}
        timeCreatedGreaterThanOrEqualTo: ${steeringPolicyTimeCreatedGreaterThanOrEqualTo}
        timeCreatedLessThan: ${steeringPolicyTimeCreatedLessThan}

Using getSteeringPolicies

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.

TypeScript
Python
Go
C#
Java
YAML

function getSteeringPolicies(args: GetSteeringPoliciesArgs, opts?: InvokeOptions): Promise<GetSteeringPoliciesResult>
function getSteeringPoliciesOutput(args: GetSteeringPoliciesOutputArgs, opts?: InvokeOptions): Output<GetSteeringPoliciesResult>

def get_steering_policies(compartment_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          display_name_contains: Optional[str] = None,
                          filters: Optional[Sequence[_dns.GetSteeringPoliciesFilter]] = None,
                          health_check_monitor_id: Optional[str] = None,
                          id: Optional[str] = None,
                          state: Optional[str] = None,
                          template: Optional[str] = None,
                          time_created_greater_than_or_equal_to: Optional[str] = None,
                          time_created_less_than: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetSteeringPoliciesResult
def get_steering_policies_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          display_name_contains: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_dns.GetSteeringPoliciesFilterArgs]]]] = None,
                          health_check_monitor_id: Optional[pulumi.Input[str]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          state: Optional[pulumi.Input[str]] = None,
                          template: Optional[pulumi.Input[str]] = None,
                          time_created_greater_than_or_equal_to: Optional[pulumi.Input[str]] = None,
                          time_created_less_than: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetSteeringPoliciesResult]

func GetSteeringPolicies(ctx *Context, args *GetSteeringPoliciesArgs, opts ...InvokeOption) (*GetSteeringPoliciesResult, error)
func GetSteeringPoliciesOutput(ctx *Context, args *GetSteeringPoliciesOutputArgs, opts ...InvokeOption) GetSteeringPoliciesResultOutput

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

public static class GetSteeringPolicies 
{
    public static Task<GetSteeringPoliciesResult> InvokeAsync(GetSteeringPoliciesArgs args, InvokeOptions? opts = null)
    public static Output<GetSteeringPoliciesResult> Invoke(GetSteeringPoliciesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSteeringPoliciesResult> getSteeringPolicies(GetSteeringPoliciesArgs args, InvokeOptions options)
public static Output<GetSteeringPoliciesResult> getSteeringPolicies(GetSteeringPoliciesArgs args, InvokeOptions options)

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

The following arguments are supported:

CompartmentId string: The OCID of the compartment the resource belongs to.
DisplayName string: The displayName of a resource.
DisplayNameContains string: The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.
Filters List<GetSteeringPoliciesFilter>
HealthCheckMonitorId string: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
Id string: The OCID of a resource.
State string: The state of a resource.
Template string: Search by steering template type. Will match any resource whose template type matches the provided value.
TimeCreatedGreaterThanOrEqualTo string: An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
TimeCreatedLessThan string: An RFC 3339 timestamp that states all returned resources were created before the indicated time.

CompartmentId string: The OCID of the compartment the resource belongs to.
DisplayName string: The displayName of a resource.
DisplayNameContains string: The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.
Filters []GetSteeringPoliciesFilter
HealthCheckMonitorId string: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
Id string: The OCID of a resource.
State string: The state of a resource.
Template string: Search by steering template type. Will match any resource whose template type matches the provided value.
TimeCreatedGreaterThanOrEqualTo string: An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
TimeCreatedLessThan string: An RFC 3339 timestamp that states all returned resources were created before the indicated time.

compartmentId String: The OCID of the compartment the resource belongs to.
displayName String: The displayName of a resource.
displayNameContains String: The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.
filters List<GetSteeringPoliciesFilter>
healthCheckMonitorId String: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
id String: The OCID of a resource.
state String: The state of a resource.
template String: Search by steering template type. Will match any resource whose template type matches the provided value.
timeCreatedGreaterThanOrEqualTo String: An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
timeCreatedLessThan String: An RFC 3339 timestamp that states all returned resources were created before the indicated time.

compartmentId string: The OCID of the compartment the resource belongs to.
displayName string: The displayName of a resource.
displayNameContains string: The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.
filters GetSteeringPoliciesFilter[]
healthCheckMonitorId string: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
id string: The OCID of a resource.
state string: The state of a resource.
template string: Search by steering template type. Will match any resource whose template type matches the provided value.
timeCreatedGreaterThanOrEqualTo string: An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
timeCreatedLessThan string: An RFC 3339 timestamp that states all returned resources were created before the indicated time.

compartment_id str: The OCID of the compartment the resource belongs to.
display_name str: The displayName of a resource.
display_name_contains str: The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.
filters Sequence[dns.GetSteeringPoliciesFilter]
health_check_monitor_id str: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
id str: The OCID of a resource.
state str: The state of a resource.
template str: Search by steering template type. Will match any resource whose template type matches the provided value.
time_created_greater_than_or_equal_to str: An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
time_created_less_than str: An RFC 3339 timestamp that states all returned resources were created before the indicated time.

compartmentId String: The OCID of the compartment the resource belongs to.
displayName String: The displayName of a resource.
displayNameContains String: The partial displayName of a resource. Will match any resource whose name (case-insensitive) contains the provided value.
filters List<Property Map>
healthCheckMonitorId String: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
id String: The OCID of a resource.
state String: The state of a resource.
template String: Search by steering template type. Will match any resource whose template type matches the provided value.
timeCreatedGreaterThanOrEqualTo String: An RFC 3339 timestamp that states all returned resources were created on or after the indicated time.
timeCreatedLessThan String: An RFC 3339 timestamp that states all returned resources were created before the indicated time.

getSteeringPolicies Result

The following output properties are available:

CompartmentId string: The OCID of the compartment containing the steering policy.
SteeringPolicies List<GetSteeringPoliciesSteeringPolicy>: The list of steering_policies.
DisplayName string: A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
DisplayNameContains string
Filters List<GetSteeringPoliciesFilter>
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.
State string: The current state of the resource.
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.
TimeCreatedGreaterThanOrEqualTo string
TimeCreatedLessThan string

CompartmentId string: The OCID of the compartment containing the steering policy.
SteeringPolicies []GetSteeringPoliciesSteeringPolicy: The list of steering_policies.
DisplayName string: A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
DisplayNameContains string
Filters []GetSteeringPoliciesFilter
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.
State string: The current state of the resource.
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.
TimeCreatedGreaterThanOrEqualTo string
TimeCreatedLessThan string

compartmentId String: The OCID of the compartment containing the steering policy.
steeringPolicies List<GetSteeringPoliciesSteeringPolicy>: The list of steering_policies.
displayName String: A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
displayNameContains String
filters List<GetSteeringPoliciesFilter>
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.
state String: The current state of the resource.
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.
timeCreatedGreaterThanOrEqualTo String
timeCreatedLessThan String

compartmentId string: The OCID of the compartment containing the steering policy.
steeringPolicies GetSteeringPoliciesSteeringPolicy[]: The list of steering_policies.
displayName string: A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
displayNameContains string
filters GetSteeringPoliciesFilter[]
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.
state string: The current state of the resource.
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.
timeCreatedGreaterThanOrEqualTo string
timeCreatedLessThan string

compartment_id str: The OCID of the compartment containing the steering policy.
steering_policies Sequence[dns.GetSteeringPoliciesSteeringPolicy]: The list of steering_policies.
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.
display_name_contains str
filters Sequence[dns.GetSteeringPoliciesFilter]
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.
state str: The current state of the resource.
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_greater_than_or_equal_to str
time_created_less_than str

compartmentId String: The OCID of the compartment containing the steering policy.
steeringPolicies List<Property Map>: The list of steering_policies.
displayName String: A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
displayNameContains String
filters List<Property Map>
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.
state String: The current state of the resource.
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.
timeCreatedGreaterThanOrEqualTo String
timeCreatedLessThan String

Supporting Types

GetSteeringPoliciesFilter

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.
Values List<string>
Regex bool

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.
Values []string
Regex bool

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.
values List<String>
regex Boolean

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.
values string[]
regex boolean

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.
values Sequence[str]
regex bool

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.
values List<String>
regex Boolean

GetSteeringPoliciesSteeringPolicy

Answers List<GetSteeringPoliciesSteeringPolicyAnswer>: The set of all answers that can potentially issue from the steering policy.
CompartmentId string: The OCID of the compartment the resource belongs to.
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: The displayName of a resource.
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: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
Id string: The OCID of a resource.
Rules List<GetSteeringPoliciesSteeringPolicyRule>: 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 state of a resource.
Template string: Search by steering template type. Will match any resource whose template type matches the provided value.
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 []GetSteeringPoliciesSteeringPolicyAnswer: The set of all answers that can potentially issue from the steering policy.
CompartmentId string: The OCID of the compartment the resource belongs to.
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: The displayName of a resource.
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: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
Id string: The OCID of a resource.
Rules []GetSteeringPoliciesSteeringPolicyRule: 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 state of a resource.
Template string: Search by steering template type. Will match any resource whose template type matches the provided value.
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<GetSteeringPoliciesSteeringPolicyAnswer>: The set of all answers that can potentially issue from the steering policy.
compartmentId String: The OCID of the compartment the resource belongs to.
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: The displayName of a resource.
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: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
id String: The OCID of a resource.
rules List<GetSteeringPoliciesSteeringPolicyRule>: 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 state of a resource.
template String: Search by steering template type. Will match any resource whose template type matches the provided value.
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 GetSteeringPoliciesSteeringPolicyAnswer[]: The set of all answers that can potentially issue from the steering policy.
compartmentId string: The OCID of the compartment the resource belongs to.
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: The displayName of a resource.
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: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
id string: The OCID of a resource.
rules GetSteeringPoliciesSteeringPolicyRule[]: 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 state of a resource.
template string: Search by steering template type. Will match any resource whose template type matches the provided value.
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.GetSteeringPoliciesSteeringPolicyAnswer]: The set of all answers that can potentially issue from the steering policy.
compartment_id str: The OCID of the compartment the resource belongs to.
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: The displayName of a resource.
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: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
id str: The OCID of a resource.
rules Sequence[dns.GetSteeringPoliciesSteeringPolicyRule]: 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 state of a resource.
template str: Search by steering template type. Will match any resource whose template type matches the provided value.
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 the resource belongs to.
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: The displayName of a resource.
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: Search by health check monitor OCID. Will match any resource whose health check monitor ID matches the provided value.
id String: The OCID of a 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 state of a resource.
template String: Search by steering template type. Will match any resource whose template type matches the provided value.
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.

GetSteeringPoliciesSteeringPolicyAnswer

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.

GetSteeringPoliciesSteeringPolicyRule

Cases List<GetSteeringPoliciesSteeringPolicyRuleCase>

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<GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData>

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 []GetSteeringPoliciesSteeringPolicyRuleCase

DefaultAnswerDatas []GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData

DefaultCount int

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<GetSteeringPoliciesSteeringPolicyRuleCase>

defaultAnswerDatas List<GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData>

defaultCount Integer

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 GetSteeringPoliciesSteeringPolicyRuleCase[]

defaultAnswerDatas GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData[]

defaultCount number

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.GetSteeringPoliciesSteeringPolicyRuleCase]

default_answer_datas Sequence[dns.GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData]

default_count int

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>

defaultAnswerDatas List<Property Map>

defaultCount Number

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.

GetSteeringPoliciesSteeringPolicyRuleCase

AnswerDatas List<GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData>: 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.address 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 []GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData: 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.address 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<GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData>: 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.address 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 GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData[]: 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.address 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.GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData]: 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.address 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.address 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.

GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData

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.

GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData

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.

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

pulumi/pulumi-oci

oci.Dns.getSteeringPolicies

On this page

On this page

Example Usage

Using getSteeringPolicies

getSteeringPolicies Result

Supporting Types

GetSteeringPoliciesFilter

GetSteeringPoliciesSteeringPolicy

GetSteeringPoliciesSteeringPolicyAnswer

GetSteeringPoliciesSteeringPolicyRule

GetSteeringPoliciesSteeringPolicyRuleCase

GetSteeringPoliciesSteeringPolicyRuleCaseAnswerData

GetSteeringPoliciesSteeringPolicyRuleDefaultAnswerData

Package Details

On this page

On this page