1. Packages
  2. AWS Classic
  3. API Docs
  4. route53
  5. getTrafficPolicyDocument

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

aws.route53.getTrafficPolicyDocument

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

    Generates an Route53 traffic policy document in JSON format for use with resources that expect policy documents such as aws.route53.TrafficPolicy.

    Example Usage

    Basic Example

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const current = aws.getRegion({});
    const example = Promise.all([current, current]).then(([current, current1]) => aws.route53.getTrafficPolicyDocument({
        recordType: "A",
        startRule: "site_switch",
        endpoints: [
            {
                id: "my_elb",
                type: "elastic-load-balancer",
                value: `elb-111111.${current.name}.elb.amazonaws.com`,
            },
            {
                id: "site_down_banner",
                type: "s3-website",
                region: current1.name,
                value: "www.example.com",
            },
        ],
        rules: [{
            id: "site_switch",
            type: "failover",
            primary: {
                endpointReference: "my_elb",
            },
            secondary: {
                endpointReference: "site_down_banner",
            },
        }],
    }));
    const exampleTrafficPolicy = new aws.route53.TrafficPolicy("example", {
        name: "example",
        comment: "example comment",
        document: example.then(example => example.json),
    });
    
    import pulumi
    import pulumi_aws as aws
    
    current = aws.get_region()
    example = aws.route53.get_traffic_policy_document(record_type="A",
        start_rule="site_switch",
        endpoints=[
            aws.route53.GetTrafficPolicyDocumentEndpointArgs(
                id="my_elb",
                type="elastic-load-balancer",
                value=f"elb-111111.{current.name}.elb.amazonaws.com",
            ),
            aws.route53.GetTrafficPolicyDocumentEndpointArgs(
                id="site_down_banner",
                type="s3-website",
                region=current.name,
                value="www.example.com",
            ),
        ],
        rules=[aws.route53.GetTrafficPolicyDocumentRuleArgs(
            id="site_switch",
            type="failover",
            primary=aws.route53.GetTrafficPolicyDocumentRulePrimaryArgs(
                endpoint_reference="my_elb",
            ),
            secondary=aws.route53.GetTrafficPolicyDocumentRuleSecondaryArgs(
                endpoint_reference="site_down_banner",
            ),
        )])
    example_traffic_policy = aws.route53.TrafficPolicy("example",
        name="example",
        comment="example comment",
        document=example.json)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		current, err := aws.GetRegion(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		example, err := route53.GetTrafficPolicyDocument(ctx, &route53.GetTrafficPolicyDocumentArgs{
    			RecordType: pulumi.StringRef("A"),
    			StartRule:  pulumi.StringRef("site_switch"),
    			Endpoints: []route53.GetTrafficPolicyDocumentEndpoint{
    				{
    					Id:    "my_elb",
    					Type:  pulumi.StringRef("elastic-load-balancer"),
    					Value: pulumi.StringRef(fmt.Sprintf("elb-111111.%v.elb.amazonaws.com", current.Name)),
    				},
    				{
    					Id:     "site_down_banner",
    					Type:   pulumi.StringRef("s3-website"),
    					Region: pulumi.StringRef(current.Name),
    					Value:  pulumi.StringRef("www.example.com"),
    				},
    			},
    			Rules: []route53.GetTrafficPolicyDocumentRule{
    				{
    					Id:   "site_switch",
    					Type: pulumi.StringRef("failover"),
    					Primary: {
    						EndpointReference: pulumi.StringRef("my_elb"),
    					},
    					Secondary: {
    						EndpointReference: pulumi.StringRef("site_down_banner"),
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = route53.NewTrafficPolicy(ctx, "example", &route53.TrafficPolicyArgs{
    			Name:     pulumi.String("example"),
    			Comment:  pulumi.String("example comment"),
    			Document: *pulumi.String(example.Json),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var current = Aws.GetRegion.Invoke();
    
        var example = Aws.Route53.GetTrafficPolicyDocument.Invoke(new()
        {
            RecordType = "A",
            StartRule = "site_switch",
            Endpoints = new[]
            {
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentEndpointInputArgs
                {
                    Id = "my_elb",
                    Type = "elastic-load-balancer",
                    Value = $"elb-111111.{current.Apply(getRegionResult => getRegionResult.Name)}.elb.amazonaws.com",
                },
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentEndpointInputArgs
                {
                    Id = "site_down_banner",
                    Type = "s3-website",
                    Region = current.Apply(getRegionResult => getRegionResult.Name),
                    Value = "www.example.com",
                },
            },
            Rules = new[]
            {
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentRuleInputArgs
                {
                    Id = "site_switch",
                    Type = "failover",
                    Primary = new Aws.Route53.Inputs.GetTrafficPolicyDocumentRulePrimaryInputArgs
                    {
                        EndpointReference = "my_elb",
                    },
                    Secondary = new Aws.Route53.Inputs.GetTrafficPolicyDocumentRuleSecondaryInputArgs
                    {
                        EndpointReference = "site_down_banner",
                    },
                },
            },
        });
    
        var exampleTrafficPolicy = new Aws.Route53.TrafficPolicy("example", new()
        {
            Name = "example",
            Comment = "example comment",
            Document = example.Apply(getTrafficPolicyDocumentResult => getTrafficPolicyDocumentResult.Json),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.AwsFunctions;
    import com.pulumi.aws.inputs.GetRegionArgs;
    import com.pulumi.aws.route53.Route53Functions;
    import com.pulumi.aws.route53.inputs.GetTrafficPolicyDocumentArgs;
    import com.pulumi.aws.route53.TrafficPolicy;
    import com.pulumi.aws.route53.TrafficPolicyArgs;
    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 current = AwsFunctions.getRegion();
    
            final var example = Route53Functions.getTrafficPolicyDocument(GetTrafficPolicyDocumentArgs.builder()
                .recordType("A")
                .startRule("site_switch")
                .endpoints(            
                    GetTrafficPolicyDocumentEndpointArgs.builder()
                        .id("my_elb")
                        .type("elastic-load-balancer")
                        .value(String.format("elb-111111.%s.elb.amazonaws.com", current.applyValue(getRegionResult -> getRegionResult.name())))
                        .build(),
                    GetTrafficPolicyDocumentEndpointArgs.builder()
                        .id("site_down_banner")
                        .type("s3-website")
                        .region(current.applyValue(getRegionResult -> getRegionResult.name()))
                        .value("www.example.com")
                        .build())
                .rules(GetTrafficPolicyDocumentRuleArgs.builder()
                    .id("site_switch")
                    .type("failover")
                    .primary(GetTrafficPolicyDocumentRulePrimaryArgs.builder()
                        .endpointReference("my_elb")
                        .build())
                    .secondary(GetTrafficPolicyDocumentRuleSecondaryArgs.builder()
                        .endpointReference("site_down_banner")
                        .build())
                    .build())
                .build());
    
            var exampleTrafficPolicy = new TrafficPolicy("exampleTrafficPolicy", TrafficPolicyArgs.builder()        
                .name("example")
                .comment("example comment")
                .document(example.applyValue(getTrafficPolicyDocumentResult -> getTrafficPolicyDocumentResult.json()))
                .build());
    
        }
    }
    
    resources:
      exampleTrafficPolicy:
        type: aws:route53:TrafficPolicy
        name: example
        properties:
          name: example
          comment: example comment
          document: ${example.json}
    variables:
      current:
        fn::invoke:
          Function: aws:getRegion
          Arguments: {}
      example:
        fn::invoke:
          Function: aws:route53:getTrafficPolicyDocument
          Arguments:
            recordType: A
            startRule: site_switch
            endpoints:
              - id: my_elb
                type: elastic-load-balancer
                value: elb-111111.${current.name}.elb.amazonaws.com
              - id: site_down_banner
                type: s3-website
                region: ${current.name}
                value: www.example.com
            rules:
              - id: site_switch
                type: failover
                primary:
                  endpointReference: my_elb
                secondary:
                  endpointReference: site_down_banner
    

    Complex Example

    The following example showcases the use of nested rules within the traffic policy document and introduces the geoproximity rule type.

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.route53.getTrafficPolicyDocument({
        recordType: "A",
        startRule: "geoproximity_rule",
        endpoints: [
            {
                id: "na_endpoint_a",
                type: "elastic-load-balancer",
                value: "elb-111111.us-west-1.elb.amazonaws.com",
            },
            {
                id: "na_endpoint_b",
                type: "elastic-load-balancer",
                value: "elb-222222.us-west-1.elb.amazonaws.com",
            },
            {
                id: "eu_endpoint",
                type: "elastic-load-balancer",
                value: "elb-333333.eu-west-1.elb.amazonaws.com",
            },
            {
                id: "ap_endpoint",
                type: "elastic-load-balancer",
                value: "elb-444444.ap-northeast-2.elb.amazonaws.com",
            },
        ],
        rules: [
            {
                id: "na_rule",
                type: "failover",
                primary: {
                    endpointReference: "na_endpoint_a",
                },
                secondary: {
                    endpointReference: "na_endpoint_b",
                },
            },
            {
                id: "geoproximity_rule",
                type: "geoproximity",
                geoProximityLocations: [
                    {
                        region: "aws:route53:us-west-1",
                        bias: "10",
                        evaluateTargetHealth: true,
                        ruleReference: "na_rule",
                    },
                    {
                        region: "aws:route53:eu-west-1",
                        bias: "10",
                        evaluateTargetHealth: true,
                        endpointReference: "eu_endpoint",
                    },
                    {
                        region: "aws:route53:ap-northeast-2",
                        bias: "0",
                        evaluateTargetHealth: true,
                        endpointReference: "ap_endpoint",
                    },
                ],
            },
        ],
    });
    const exampleTrafficPolicy = new aws.route53.TrafficPolicy("example", {
        name: "example",
        comment: "example comment",
        document: example.then(example => example.json),
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.route53.get_traffic_policy_document(record_type="A",
        start_rule="geoproximity_rule",
        endpoints=[
            aws.route53.GetTrafficPolicyDocumentEndpointArgs(
                id="na_endpoint_a",
                type="elastic-load-balancer",
                value="elb-111111.us-west-1.elb.amazonaws.com",
            ),
            aws.route53.GetTrafficPolicyDocumentEndpointArgs(
                id="na_endpoint_b",
                type="elastic-load-balancer",
                value="elb-222222.us-west-1.elb.amazonaws.com",
            ),
            aws.route53.GetTrafficPolicyDocumentEndpointArgs(
                id="eu_endpoint",
                type="elastic-load-balancer",
                value="elb-333333.eu-west-1.elb.amazonaws.com",
            ),
            aws.route53.GetTrafficPolicyDocumentEndpointArgs(
                id="ap_endpoint",
                type="elastic-load-balancer",
                value="elb-444444.ap-northeast-2.elb.amazonaws.com",
            ),
        ],
        rules=[
            aws.route53.GetTrafficPolicyDocumentRuleArgs(
                id="na_rule",
                type="failover",
                primary=aws.route53.GetTrafficPolicyDocumentRulePrimaryArgs(
                    endpoint_reference="na_endpoint_a",
                ),
                secondary=aws.route53.GetTrafficPolicyDocumentRuleSecondaryArgs(
                    endpoint_reference="na_endpoint_b",
                ),
            ),
            aws.route53.GetTrafficPolicyDocumentRuleArgs(
                id="geoproximity_rule",
                type="geoproximity",
                geo_proximity_locations=[
                    aws.route53.GetTrafficPolicyDocumentRuleGeoProximityLocationArgs(
                        region="aws:route53:us-west-1",
                        bias="10",
                        evaluate_target_health=True,
                        rule_reference="na_rule",
                    ),
                    aws.route53.GetTrafficPolicyDocumentRuleGeoProximityLocationArgs(
                        region="aws:route53:eu-west-1",
                        bias="10",
                        evaluate_target_health=True,
                        endpoint_reference="eu_endpoint",
                    ),
                    aws.route53.GetTrafficPolicyDocumentRuleGeoProximityLocationArgs(
                        region="aws:route53:ap-northeast-2",
                        bias="0",
                        evaluate_target_health=True,
                        endpoint_reference="ap_endpoint",
                    ),
                ],
            ),
        ])
    example_traffic_policy = aws.route53.TrafficPolicy("example",
        name="example",
        comment="example comment",
        document=example.json)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/route53"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := route53.GetTrafficPolicyDocument(ctx, &route53.GetTrafficPolicyDocumentArgs{
    			RecordType: pulumi.StringRef("A"),
    			StartRule:  pulumi.StringRef("geoproximity_rule"),
    			Endpoints: []route53.GetTrafficPolicyDocumentEndpoint{
    				{
    					Id:    "na_endpoint_a",
    					Type:  pulumi.StringRef("elastic-load-balancer"),
    					Value: pulumi.StringRef("elb-111111.us-west-1.elb.amazonaws.com"),
    				},
    				{
    					Id:    "na_endpoint_b",
    					Type:  pulumi.StringRef("elastic-load-balancer"),
    					Value: pulumi.StringRef("elb-222222.us-west-1.elb.amazonaws.com"),
    				},
    				{
    					Id:    "eu_endpoint",
    					Type:  pulumi.StringRef("elastic-load-balancer"),
    					Value: pulumi.StringRef("elb-333333.eu-west-1.elb.amazonaws.com"),
    				},
    				{
    					Id:    "ap_endpoint",
    					Type:  pulumi.StringRef("elastic-load-balancer"),
    					Value: pulumi.StringRef("elb-444444.ap-northeast-2.elb.amazonaws.com"),
    				},
    			},
    			Rules: pulumi.Array{
    				route53.GetTrafficPolicyDocumentRule{
    					Id:   "na_rule",
    					Type: pulumi.StringRef("failover"),
    					Primary: route53.GetTrafficPolicyDocumentRulePrimary{
    						EndpointReference: pulumi.StringRef("na_endpoint_a"),
    					},
    					Secondary: route53.GetTrafficPolicyDocumentRuleSecondary{
    						EndpointReference: pulumi.StringRef("na_endpoint_b"),
    					},
    				},
    				route53.GetTrafficPolicyDocumentRule{
    					Id:   "geoproximity_rule",
    					Type: pulumi.StringRef("geoproximity"),
    					GeoProximityLocations: []route53.GetTrafficPolicyDocumentRuleGeoProximityLocation{
    						{
    							Region:               pulumi.StringRef("aws:route53:us-west-1"),
    							Bias:                 pulumi.StringRef("10"),
    							EvaluateTargetHealth: pulumi.BoolRef(true),
    							RuleReference:        pulumi.StringRef("na_rule"),
    						},
    						{
    							Region:               pulumi.StringRef("aws:route53:eu-west-1"),
    							Bias:                 pulumi.StringRef("10"),
    							EvaluateTargetHealth: pulumi.BoolRef(true),
    							EndpointReference:    pulumi.StringRef("eu_endpoint"),
    						},
    						{
    							Region:               pulumi.StringRef("aws:route53:ap-northeast-2"),
    							Bias:                 pulumi.StringRef("0"),
    							EvaluateTargetHealth: pulumi.BoolRef(true),
    							EndpointReference:    pulumi.StringRef("ap_endpoint"),
    						},
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = route53.NewTrafficPolicy(ctx, "example", &route53.TrafficPolicyArgs{
    			Name:     pulumi.String("example"),
    			Comment:  pulumi.String("example comment"),
    			Document: *pulumi.String(example.Json),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Route53.GetTrafficPolicyDocument.Invoke(new()
        {
            RecordType = "A",
            StartRule = "geoproximity_rule",
            Endpoints = new[]
            {
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentEndpointInputArgs
                {
                    Id = "na_endpoint_a",
                    Type = "elastic-load-balancer",
                    Value = "elb-111111.us-west-1.elb.amazonaws.com",
                },
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentEndpointInputArgs
                {
                    Id = "na_endpoint_b",
                    Type = "elastic-load-balancer",
                    Value = "elb-222222.us-west-1.elb.amazonaws.com",
                },
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentEndpointInputArgs
                {
                    Id = "eu_endpoint",
                    Type = "elastic-load-balancer",
                    Value = "elb-333333.eu-west-1.elb.amazonaws.com",
                },
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentEndpointInputArgs
                {
                    Id = "ap_endpoint",
                    Type = "elastic-load-balancer",
                    Value = "elb-444444.ap-northeast-2.elb.amazonaws.com",
                },
            },
            Rules = new[]
            {
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentRuleInputArgs
                {
                    Id = "na_rule",
                    Type = "failover",
                    Primary = new Aws.Route53.Inputs.GetTrafficPolicyDocumentRulePrimaryInputArgs
                    {
                        EndpointReference = "na_endpoint_a",
                    },
                    Secondary = new Aws.Route53.Inputs.GetTrafficPolicyDocumentRuleSecondaryInputArgs
                    {
                        EndpointReference = "na_endpoint_b",
                    },
                },
                new Aws.Route53.Inputs.GetTrafficPolicyDocumentRuleInputArgs
                {
                    Id = "geoproximity_rule",
                    Type = "geoproximity",
                    GeoProximityLocations = new[]
                    {
                        new Aws.Route53.Inputs.GetTrafficPolicyDocumentRuleGeoProximityLocationInputArgs
                        {
                            Region = "aws:route53:us-west-1",
                            Bias = "10",
                            EvaluateTargetHealth = true,
                            RuleReference = "na_rule",
                        },
                        new Aws.Route53.Inputs.GetTrafficPolicyDocumentRuleGeoProximityLocationInputArgs
                        {
                            Region = "aws:route53:eu-west-1",
                            Bias = "10",
                            EvaluateTargetHealth = true,
                            EndpointReference = "eu_endpoint",
                        },
                        new Aws.Route53.Inputs.GetTrafficPolicyDocumentRuleGeoProximityLocationInputArgs
                        {
                            Region = "aws:route53:ap-northeast-2",
                            Bias = "0",
                            EvaluateTargetHealth = true,
                            EndpointReference = "ap_endpoint",
                        },
                    },
                },
            },
        });
    
        var exampleTrafficPolicy = new Aws.Route53.TrafficPolicy("example", new()
        {
            Name = "example",
            Comment = "example comment",
            Document = example.Apply(getTrafficPolicyDocumentResult => getTrafficPolicyDocumentResult.Json),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.route53.Route53Functions;
    import com.pulumi.aws.route53.inputs.GetTrafficPolicyDocumentArgs;
    import com.pulumi.aws.route53.TrafficPolicy;
    import com.pulumi.aws.route53.TrafficPolicyArgs;
    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 example = Route53Functions.getTrafficPolicyDocument(GetTrafficPolicyDocumentArgs.builder()
                .recordType("A")
                .startRule("geoproximity_rule")
                .endpoints(            
                    GetTrafficPolicyDocumentEndpointArgs.builder()
                        .id("na_endpoint_a")
                        .type("elastic-load-balancer")
                        .value("elb-111111.us-west-1.elb.amazonaws.com")
                        .build(),
                    GetTrafficPolicyDocumentEndpointArgs.builder()
                        .id("na_endpoint_b")
                        .type("elastic-load-balancer")
                        .value("elb-222222.us-west-1.elb.amazonaws.com")
                        .build(),
                    GetTrafficPolicyDocumentEndpointArgs.builder()
                        .id("eu_endpoint")
                        .type("elastic-load-balancer")
                        .value("elb-333333.eu-west-1.elb.amazonaws.com")
                        .build(),
                    GetTrafficPolicyDocumentEndpointArgs.builder()
                        .id("ap_endpoint")
                        .type("elastic-load-balancer")
                        .value("elb-444444.ap-northeast-2.elb.amazonaws.com")
                        .build())
                .rules(            
                    GetTrafficPolicyDocumentRuleArgs.builder()
                        .id("na_rule")
                        .type("failover")
                        .primary(GetTrafficPolicyDocumentRulePrimaryArgs.builder()
                            .endpointReference("na_endpoint_a")
                            .build())
                        .secondary(GetTrafficPolicyDocumentRuleSecondaryArgs.builder()
                            .endpointReference("na_endpoint_b")
                            .build())
                        .build(),
                    GetTrafficPolicyDocumentRuleArgs.builder()
                        .id("geoproximity_rule")
                        .type("geoproximity")
                        .geoProximityLocations(                    
                            GetTrafficPolicyDocumentRuleGeoProximityLocationArgs.builder()
                                .region("aws:route53:us-west-1")
                                .bias(10)
                                .evaluateTargetHealth(true)
                                .ruleReference("na_rule")
                                .build(),
                            GetTrafficPolicyDocumentRuleGeoProximityLocationArgs.builder()
                                .region("aws:route53:eu-west-1")
                                .bias(10)
                                .evaluateTargetHealth(true)
                                .endpointReference("eu_endpoint")
                                .build(),
                            GetTrafficPolicyDocumentRuleGeoProximityLocationArgs.builder()
                                .region("aws:route53:ap-northeast-2")
                                .bias(0)
                                .evaluateTargetHealth(true)
                                .endpointReference("ap_endpoint")
                                .build())
                        .build())
                .build());
    
            var exampleTrafficPolicy = new TrafficPolicy("exampleTrafficPolicy", TrafficPolicyArgs.builder()        
                .name("example")
                .comment("example comment")
                .document(example.applyValue(getTrafficPolicyDocumentResult -> getTrafficPolicyDocumentResult.json()))
                .build());
    
        }
    }
    
    resources:
      exampleTrafficPolicy:
        type: aws:route53:TrafficPolicy
        name: example
        properties:
          name: example
          comment: example comment
          document: ${example.json}
    variables:
      example:
        fn::invoke:
          Function: aws:route53:getTrafficPolicyDocument
          Arguments:
            recordType: A
            startRule: geoproximity_rule
            endpoints:
              - id: na_endpoint_a
                type: elastic-load-balancer
                value: elb-111111.us-west-1.elb.amazonaws.com
              - id: na_endpoint_b
                type: elastic-load-balancer
                value: elb-222222.us-west-1.elb.amazonaws.com
              - id: eu_endpoint
                type: elastic-load-balancer
                value: elb-333333.eu-west-1.elb.amazonaws.com
              - id: ap_endpoint
                type: elastic-load-balancer
                value: elb-444444.ap-northeast-2.elb.amazonaws.com
            rules:
              - id: na_rule
                type: failover
                primary:
                  endpointReference: na_endpoint_a
                secondary:
                  endpointReference: na_endpoint_b
              - id: geoproximity_rule
                type: geoproximity
                geoProximityLocations:
                  - region: aws:route53:us-west-1
                    bias: 10
                    evaluateTargetHealth: true
                    ruleReference: na_rule
                  - region: aws:route53:eu-west-1
                    bias: 10
                    evaluateTargetHealth: true
                    endpointReference: eu_endpoint
                  - region: aws:route53:ap-northeast-2
                    bias: 0
                    evaluateTargetHealth: true
                    endpointReference: ap_endpoint
    

    Using getTrafficPolicyDocument

    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 getTrafficPolicyDocument(args: GetTrafficPolicyDocumentArgs, opts?: InvokeOptions): Promise<GetTrafficPolicyDocumentResult>
    function getTrafficPolicyDocumentOutput(args: GetTrafficPolicyDocumentOutputArgs, opts?: InvokeOptions): Output<GetTrafficPolicyDocumentResult>
    def get_traffic_policy_document(endpoints: Optional[Sequence[GetTrafficPolicyDocumentEndpoint]] = None,
                                    record_type: Optional[str] = None,
                                    rules: Optional[Sequence[GetTrafficPolicyDocumentRule]] = None,
                                    start_endpoint: Optional[str] = None,
                                    start_rule: Optional[str] = None,
                                    version: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetTrafficPolicyDocumentResult
    def get_traffic_policy_document_output(endpoints: Optional[pulumi.Input[Sequence[pulumi.Input[GetTrafficPolicyDocumentEndpointArgs]]]] = None,
                                    record_type: Optional[pulumi.Input[str]] = None,
                                    rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetTrafficPolicyDocumentRuleArgs]]]] = None,
                                    start_endpoint: Optional[pulumi.Input[str]] = None,
                                    start_rule: Optional[pulumi.Input[str]] = None,
                                    version: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetTrafficPolicyDocumentResult]
    func GetTrafficPolicyDocument(ctx *Context, args *GetTrafficPolicyDocumentArgs, opts ...InvokeOption) (*GetTrafficPolicyDocumentResult, error)
    func GetTrafficPolicyDocumentOutput(ctx *Context, args *GetTrafficPolicyDocumentOutputArgs, opts ...InvokeOption) GetTrafficPolicyDocumentResultOutput

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

    public static class GetTrafficPolicyDocument 
    {
        public static Task<GetTrafficPolicyDocumentResult> InvokeAsync(GetTrafficPolicyDocumentArgs args, InvokeOptions? opts = null)
        public static Output<GetTrafficPolicyDocumentResult> Invoke(GetTrafficPolicyDocumentInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTrafficPolicyDocumentResult> getTrafficPolicyDocument(GetTrafficPolicyDocumentArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:route53/getTrafficPolicyDocument:getTrafficPolicyDocument
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Endpoints List<GetTrafficPolicyDocumentEndpoint>
    Configuration block for the definitions of the endpoints that you want to use in this traffic policy. See below
    RecordType string
    DNS type of all of the resource record sets that Amazon Route 53 will create based on this traffic policy.
    Rules List<GetTrafficPolicyDocumentRule>
    Configuration block for definitions of the rules that you want to use in this traffic policy. See below
    StartEndpoint string
    An endpoint to be as the starting point for the traffic policy.
    StartRule string
    A rule to be as the starting point for the traffic policy.
    Version string
    Version of the traffic policy format.
    Endpoints []GetTrafficPolicyDocumentEndpoint
    Configuration block for the definitions of the endpoints that you want to use in this traffic policy. See below
    RecordType string
    DNS type of all of the resource record sets that Amazon Route 53 will create based on this traffic policy.
    Rules []GetTrafficPolicyDocumentRule
    Configuration block for definitions of the rules that you want to use in this traffic policy. See below
    StartEndpoint string
    An endpoint to be as the starting point for the traffic policy.
    StartRule string
    A rule to be as the starting point for the traffic policy.
    Version string
    Version of the traffic policy format.
    endpoints List<GetTrafficPolicyDocumentEndpoint>
    Configuration block for the definitions of the endpoints that you want to use in this traffic policy. See below
    recordType String
    DNS type of all of the resource record sets that Amazon Route 53 will create based on this traffic policy.
    rules List<GetTrafficPolicyDocumentRule>
    Configuration block for definitions of the rules that you want to use in this traffic policy. See below
    startEndpoint String
    An endpoint to be as the starting point for the traffic policy.
    startRule String
    A rule to be as the starting point for the traffic policy.
    version String
    Version of the traffic policy format.
    endpoints GetTrafficPolicyDocumentEndpoint[]
    Configuration block for the definitions of the endpoints that you want to use in this traffic policy. See below
    recordType string
    DNS type of all of the resource record sets that Amazon Route 53 will create based on this traffic policy.
    rules GetTrafficPolicyDocumentRule[]
    Configuration block for definitions of the rules that you want to use in this traffic policy. See below
    startEndpoint string
    An endpoint to be as the starting point for the traffic policy.
    startRule string
    A rule to be as the starting point for the traffic policy.
    version string
    Version of the traffic policy format.
    endpoints Sequence[GetTrafficPolicyDocumentEndpoint]
    Configuration block for the definitions of the endpoints that you want to use in this traffic policy. See below
    record_type str
    DNS type of all of the resource record sets that Amazon Route 53 will create based on this traffic policy.
    rules Sequence[GetTrafficPolicyDocumentRule]
    Configuration block for definitions of the rules that you want to use in this traffic policy. See below
    start_endpoint str
    An endpoint to be as the starting point for the traffic policy.
    start_rule str
    A rule to be as the starting point for the traffic policy.
    version str
    Version of the traffic policy format.
    endpoints List<Property Map>
    Configuration block for the definitions of the endpoints that you want to use in this traffic policy. See below
    recordType String
    DNS type of all of the resource record sets that Amazon Route 53 will create based on this traffic policy.
    rules List<Property Map>
    Configuration block for definitions of the rules that you want to use in this traffic policy. See below
    startEndpoint String
    An endpoint to be as the starting point for the traffic policy.
    startRule String
    A rule to be as the starting point for the traffic policy.
    version String
    Version of the traffic policy format.

    getTrafficPolicyDocument Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Json string
    Standard JSON policy document rendered based on the arguments above.
    Endpoints List<GetTrafficPolicyDocumentEndpoint>
    RecordType string
    Rules List<GetTrafficPolicyDocumentRule>
    StartEndpoint string
    StartRule string
    Version string
    Id string
    The provider-assigned unique ID for this managed resource.
    Json string
    Standard JSON policy document rendered based on the arguments above.
    Endpoints []GetTrafficPolicyDocumentEndpoint
    RecordType string
    Rules []GetTrafficPolicyDocumentRule
    StartEndpoint string
    StartRule string
    Version string
    id String
    The provider-assigned unique ID for this managed resource.
    json String
    Standard JSON policy document rendered based on the arguments above.
    endpoints List<GetTrafficPolicyDocumentEndpoint>
    recordType String
    rules List<GetTrafficPolicyDocumentRule>
    startEndpoint String
    startRule String
    version String
    id string
    The provider-assigned unique ID for this managed resource.
    json string
    Standard JSON policy document rendered based on the arguments above.
    endpoints GetTrafficPolicyDocumentEndpoint[]
    recordType string
    rules GetTrafficPolicyDocumentRule[]
    startEndpoint string
    startRule string
    version string
    id str
    The provider-assigned unique ID for this managed resource.
    json str
    Standard JSON policy document rendered based on the arguments above.
    endpoints Sequence[GetTrafficPolicyDocumentEndpoint]
    record_type str
    rules Sequence[GetTrafficPolicyDocumentRule]
    start_endpoint str
    start_rule str
    version str
    id String
    The provider-assigned unique ID for this managed resource.
    json String
    Standard JSON policy document rendered based on the arguments above.
    endpoints List<Property Map>
    recordType String
    rules List<Property Map>
    startEndpoint String
    startRule String
    version String

    Supporting Types

    GetTrafficPolicyDocumentEndpoint

    Id string
    ID of an endpoint you want to assign.
    Region string
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    Type string
    Type of the endpoint. Valid values are value , cloudfront , elastic-load-balancer, s3-website
    Value string
    Value of the type.
    Id string
    ID of an endpoint you want to assign.
    Region string
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    Type string
    Type of the endpoint. Valid values are value , cloudfront , elastic-load-balancer, s3-website
    Value string
    Value of the type.
    id String
    ID of an endpoint you want to assign.
    region String
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    type String
    Type of the endpoint. Valid values are value , cloudfront , elastic-load-balancer, s3-website
    value String
    Value of the type.
    id string
    ID of an endpoint you want to assign.
    region string
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    type string
    Type of the endpoint. Valid values are value , cloudfront , elastic-load-balancer, s3-website
    value string
    Value of the type.
    id str
    ID of an endpoint you want to assign.
    region str
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    type str
    Type of the endpoint. Valid values are value , cloudfront , elastic-load-balancer, s3-website
    value str
    Value of the type.
    id String
    ID of an endpoint you want to assign.
    region String
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    type String
    Type of the endpoint. Valid values are value , cloudfront , elastic-load-balancer, s3-website
    value String
    Value of the type.

    GetTrafficPolicyDocumentRule

    Id string
    ID of a rule you want to assign.
    GeoProximityLocations List<GetTrafficPolicyDocumentRuleGeoProximityLocation>
    Configuration block for when you add a geoproximity rule, you configure Amazon Route 53 to route traffic to your resources based on the geographic location of your resources. Only valid for geoproximity type. See below
    Items List<GetTrafficPolicyDocumentRuleItem>
    Configuration block for when you add a multivalue answer rule, you configure your traffic policy to route traffic approximately randomly to your healthy resources. Only valid for multivalue type. See below
    Locations List<GetTrafficPolicyDocumentRuleLocation>
    Configuration block for when you add a geolocation rule, you configure your traffic policy to route your traffic based on the geographic location of your users. Only valid for geo type. See below
    Primary GetTrafficPolicyDocumentRulePrimary
    Configuration block for the settings for the rule or endpoint that you want to route traffic to whenever the corresponding resources are available. Only valid for failover type. See below
    Regions List<GetTrafficPolicyDocumentRuleRegion>
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    Secondary GetTrafficPolicyDocumentRuleSecondary
    Configuration block for the rule or endpoint that you want to route traffic to whenever the primary resources are not available. Only valid for failover type. See below
    Type string
    Type of the rule.
    Id string
    ID of a rule you want to assign.
    GeoProximityLocations []GetTrafficPolicyDocumentRuleGeoProximityLocation
    Configuration block for when you add a geoproximity rule, you configure Amazon Route 53 to route traffic to your resources based on the geographic location of your resources. Only valid for geoproximity type. See below
    Items []GetTrafficPolicyDocumentRuleItem
    Configuration block for when you add a multivalue answer rule, you configure your traffic policy to route traffic approximately randomly to your healthy resources. Only valid for multivalue type. See below
    Locations []GetTrafficPolicyDocumentRuleLocation
    Configuration block for when you add a geolocation rule, you configure your traffic policy to route your traffic based on the geographic location of your users. Only valid for geo type. See below
    Primary GetTrafficPolicyDocumentRulePrimary
    Configuration block for the settings for the rule or endpoint that you want to route traffic to whenever the corresponding resources are available. Only valid for failover type. See below
    Regions []GetTrafficPolicyDocumentRuleRegion
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    Secondary GetTrafficPolicyDocumentRuleSecondary
    Configuration block for the rule or endpoint that you want to route traffic to whenever the primary resources are not available. Only valid for failover type. See below
    Type string
    Type of the rule.
    id String
    ID of a rule you want to assign.
    geoProximityLocations List<GetTrafficPolicyDocumentRuleGeoProximityLocation>
    Configuration block for when you add a geoproximity rule, you configure Amazon Route 53 to route traffic to your resources based on the geographic location of your resources. Only valid for geoproximity type. See below
    items List<GetTrafficPolicyDocumentRuleItem>
    Configuration block for when you add a multivalue answer rule, you configure your traffic policy to route traffic approximately randomly to your healthy resources. Only valid for multivalue type. See below
    locations List<GetTrafficPolicyDocumentRuleLocation>
    Configuration block for when you add a geolocation rule, you configure your traffic policy to route your traffic based on the geographic location of your users. Only valid for geo type. See below
    primary GetTrafficPolicyDocumentRulePrimary
    Configuration block for the settings for the rule or endpoint that you want to route traffic to whenever the corresponding resources are available. Only valid for failover type. See below
    regions List<GetTrafficPolicyDocumentRuleRegion>
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    secondary GetTrafficPolicyDocumentRuleSecondary
    Configuration block for the rule or endpoint that you want to route traffic to whenever the primary resources are not available. Only valid for failover type. See below
    type String
    Type of the rule.
    id string
    ID of a rule you want to assign.
    geoProximityLocations GetTrafficPolicyDocumentRuleGeoProximityLocation[]
    Configuration block for when you add a geoproximity rule, you configure Amazon Route 53 to route traffic to your resources based on the geographic location of your resources. Only valid for geoproximity type. See below
    items GetTrafficPolicyDocumentRuleItem[]
    Configuration block for when you add a multivalue answer rule, you configure your traffic policy to route traffic approximately randomly to your healthy resources. Only valid for multivalue type. See below
    locations GetTrafficPolicyDocumentRuleLocation[]
    Configuration block for when you add a geolocation rule, you configure your traffic policy to route your traffic based on the geographic location of your users. Only valid for geo type. See below
    primary GetTrafficPolicyDocumentRulePrimary
    Configuration block for the settings for the rule or endpoint that you want to route traffic to whenever the corresponding resources are available. Only valid for failover type. See below
    regions GetTrafficPolicyDocumentRuleRegion[]
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    secondary GetTrafficPolicyDocumentRuleSecondary
    Configuration block for the rule or endpoint that you want to route traffic to whenever the primary resources are not available. Only valid for failover type. See below
    type string
    Type of the rule.
    id str
    ID of a rule you want to assign.
    geo_proximity_locations Sequence[GetTrafficPolicyDocumentRuleGeoProximityLocation]
    Configuration block for when you add a geoproximity rule, you configure Amazon Route 53 to route traffic to your resources based on the geographic location of your resources. Only valid for geoproximity type. See below
    items Sequence[GetTrafficPolicyDocumentRuleItem]
    Configuration block for when you add a multivalue answer rule, you configure your traffic policy to route traffic approximately randomly to your healthy resources. Only valid for multivalue type. See below
    locations Sequence[GetTrafficPolicyDocumentRuleLocation]
    Configuration block for when you add a geolocation rule, you configure your traffic policy to route your traffic based on the geographic location of your users. Only valid for geo type. See below
    primary GetTrafficPolicyDocumentRulePrimary
    Configuration block for the settings for the rule or endpoint that you want to route traffic to whenever the corresponding resources are available. Only valid for failover type. See below
    regions Sequence[GetTrafficPolicyDocumentRuleRegion]
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    secondary GetTrafficPolicyDocumentRuleSecondary
    Configuration block for the rule or endpoint that you want to route traffic to whenever the primary resources are not available. Only valid for failover type. See below
    type str
    Type of the rule.
    id String
    ID of a rule you want to assign.
    geoProximityLocations List<Property Map>
    Configuration block for when you add a geoproximity rule, you configure Amazon Route 53 to route traffic to your resources based on the geographic location of your resources. Only valid for geoproximity type. See below
    items List<Property Map>
    Configuration block for when you add a multivalue answer rule, you configure your traffic policy to route traffic approximately randomly to your healthy resources. Only valid for multivalue type. See below
    locations List<Property Map>
    Configuration block for when you add a geolocation rule, you configure your traffic policy to route your traffic based on the geographic location of your users. Only valid for geo type. See below
    primary Property Map
    Configuration block for the settings for the rule or endpoint that you want to route traffic to whenever the corresponding resources are available. Only valid for failover type. See below
    regions List<Property Map>
    To route traffic to an Amazon S3 bucket that is configured as a website endpoint, specify the region in which you created the bucket for region.
    secondary Property Map
    Configuration block for the rule or endpoint that you want to route traffic to whenever the primary resources are not available. Only valid for failover type. See below
    type String
    Type of the rule.

    GetTrafficPolicyDocumentRuleGeoProximityLocation

    Bias string
    Specify a value for bias if you want to route more traffic to an endpoint from nearby endpoints (positive values) or route less traffic to an endpoint (negative values).
    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    Latitude string
    Represents the location south (negative) or north (positive) of the equator. Valid values are -90 degrees to 90 degrees.
    Longitude string
    Represents the location west (negative) or east (positive) of the prime meridian. Valid values are -180 degrees to 180 degrees.
    Region string
    If your endpoint is an AWS resource, specify the AWS Region that you created the resource in.
    RuleReference string
    References to a rule.
    Bias string
    Specify a value for bias if you want to route more traffic to an endpoint from nearby endpoints (positive values) or route less traffic to an endpoint (negative values).
    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    Latitude string
    Represents the location south (negative) or north (positive) of the equator. Valid values are -90 degrees to 90 degrees.
    Longitude string
    Represents the location west (negative) or east (positive) of the prime meridian. Valid values are -180 degrees to 180 degrees.
    Region string
    If your endpoint is an AWS resource, specify the AWS Region that you created the resource in.
    RuleReference string
    References to a rule.
    bias String
    Specify a value for bias if you want to route more traffic to an endpoint from nearby endpoints (positive values) or route less traffic to an endpoint (negative values).
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    latitude String
    Represents the location south (negative) or north (positive) of the equator. Valid values are -90 degrees to 90 degrees.
    longitude String
    Represents the location west (negative) or east (positive) of the prime meridian. Valid values are -180 degrees to 180 degrees.
    region String
    If your endpoint is an AWS resource, specify the AWS Region that you created the resource in.
    ruleReference String
    References to a rule.
    bias string
    Specify a value for bias if you want to route more traffic to an endpoint from nearby endpoints (positive values) or route less traffic to an endpoint (negative values).
    endpointReference string
    References to an endpoint.
    evaluateTargetHealth boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck string
    If you want to associate a health check with the endpoint or rule.
    latitude string
    Represents the location south (negative) or north (positive) of the equator. Valid values are -90 degrees to 90 degrees.
    longitude string
    Represents the location west (negative) or east (positive) of the prime meridian. Valid values are -180 degrees to 180 degrees.
    region string
    If your endpoint is an AWS resource, specify the AWS Region that you created the resource in.
    ruleReference string
    References to a rule.
    bias str
    Specify a value for bias if you want to route more traffic to an endpoint from nearby endpoints (positive values) or route less traffic to an endpoint (negative values).
    endpoint_reference str
    References to an endpoint.
    evaluate_target_health bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    health_check str
    If you want to associate a health check with the endpoint or rule.
    latitude str
    Represents the location south (negative) or north (positive) of the equator. Valid values are -90 degrees to 90 degrees.
    longitude str
    Represents the location west (negative) or east (positive) of the prime meridian. Valid values are -180 degrees to 180 degrees.
    region str
    If your endpoint is an AWS resource, specify the AWS Region that you created the resource in.
    rule_reference str
    References to a rule.
    bias String
    Specify a value for bias if you want to route more traffic to an endpoint from nearby endpoints (positive values) or route less traffic to an endpoint (negative values).
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    latitude String
    Represents the location south (negative) or north (positive) of the equator. Valid values are -90 degrees to 90 degrees.
    longitude String
    Represents the location west (negative) or east (positive) of the prime meridian. Valid values are -180 degrees to 180 degrees.
    region String
    If your endpoint is an AWS resource, specify the AWS Region that you created the resource in.
    ruleReference String
    References to a rule.

    GetTrafficPolicyDocumentRuleItem

    EndpointReference string
    References to an endpoint.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    EndpointReference string
    References to an endpoint.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    endpointReference String
    References to an endpoint.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    endpointReference string
    References to an endpoint.
    healthCheck string
    If you want to associate a health check with the endpoint or rule.
    endpoint_reference str
    References to an endpoint.
    health_check str
    If you want to associate a health check with the endpoint or rule.
    endpointReference String
    References to an endpoint.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.

    GetTrafficPolicyDocumentRuleLocation

    Continent string
    Value of a continent.
    Country string
    Value of a country.
    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    IsDefault bool
    Indicates whether this set of values represents the default location.
    RuleReference string
    References to a rule.
    Subdivision string
    Value of a subdivision.
    Continent string
    Value of a continent.
    Country string
    Value of a country.
    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    IsDefault bool
    Indicates whether this set of values represents the default location.
    RuleReference string
    References to a rule.
    Subdivision string
    Value of a subdivision.
    continent String
    Value of a continent.
    country String
    Value of a country.
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    isDefault Boolean
    Indicates whether this set of values represents the default location.
    ruleReference String
    References to a rule.
    subdivision String
    Value of a subdivision.
    continent string
    Value of a continent.
    country string
    Value of a country.
    endpointReference string
    References to an endpoint.
    evaluateTargetHealth boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck string
    If you want to associate a health check with the endpoint or rule.
    isDefault boolean
    Indicates whether this set of values represents the default location.
    ruleReference string
    References to a rule.
    subdivision string
    Value of a subdivision.
    continent str
    Value of a continent.
    country str
    Value of a country.
    endpoint_reference str
    References to an endpoint.
    evaluate_target_health bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    health_check str
    If you want to associate a health check with the endpoint or rule.
    is_default bool
    Indicates whether this set of values represents the default location.
    rule_reference str
    References to a rule.
    subdivision str
    Value of a subdivision.
    continent String
    Value of a continent.
    country String
    Value of a country.
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    isDefault Boolean
    Indicates whether this set of values represents the default location.
    ruleReference String
    References to a rule.
    subdivision String
    Value of a subdivision.

    GetTrafficPolicyDocumentRulePrimary

    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    RuleReference string
    References to a rule.
    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    RuleReference string
    References to a rule.
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    ruleReference String
    References to a rule.
    endpointReference string
    References to an endpoint.
    evaluateTargetHealth boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck string
    If you want to associate a health check with the endpoint or rule.
    ruleReference string
    References to a rule.
    endpoint_reference str
    References to an endpoint.
    evaluate_target_health bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    health_check str
    If you want to associate a health check with the endpoint or rule.
    rule_reference str
    References to a rule.
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    ruleReference String
    References to a rule.

    GetTrafficPolicyDocumentRuleRegion

    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    Region string
    Region code for the AWS Region that you created the resource in.
    RuleReference string
    References to a rule.
    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    Region string
    Region code for the AWS Region that you created the resource in.
    RuleReference string
    References to a rule.
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    region String
    Region code for the AWS Region that you created the resource in.
    ruleReference String
    References to a rule.
    endpointReference string
    References to an endpoint.
    evaluateTargetHealth boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck string
    If you want to associate a health check with the endpoint or rule.
    region string
    Region code for the AWS Region that you created the resource in.
    ruleReference string
    References to a rule.
    endpoint_reference str
    References to an endpoint.
    evaluate_target_health bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    health_check str
    If you want to associate a health check with the endpoint or rule.
    region str
    Region code for the AWS Region that you created the resource in.
    rule_reference str
    References to a rule.
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    region String
    Region code for the AWS Region that you created the resource in.
    ruleReference String
    References to a rule.

    GetTrafficPolicyDocumentRuleSecondary

    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    RuleReference string
    References to a rule.
    EndpointReference string
    References to an endpoint.
    EvaluateTargetHealth bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    HealthCheck string
    If you want to associate a health check with the endpoint or rule.
    RuleReference string
    References to a rule.
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    ruleReference String
    References to a rule.
    endpointReference string
    References to an endpoint.
    evaluateTargetHealth boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck string
    If you want to associate a health check with the endpoint or rule.
    ruleReference string
    References to a rule.
    endpoint_reference str
    References to an endpoint.
    evaluate_target_health bool
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    health_check str
    If you want to associate a health check with the endpoint or rule.
    rule_reference str
    References to a rule.
    endpointReference String
    References to an endpoint.
    evaluateTargetHealth Boolean
    Indicates whether you want Amazon Route 53 to evaluate the health of the endpoint and route traffic only to healthy endpoints.
    healthCheck String
    If you want to associate a health check with the endpoint or rule.
    ruleReference String
    References to a rule.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi