TrafficPolicy class

Manages a Route53 Traffic Policy.

Example Usage

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

const example = new aws.route53.TrafficPolicy("example", {
    name: "example",
    comment: "example comment",
    document: `{
  \\"AWSPolicyFormatVersion\\": \\"2015-10-01\\",
  \\"RecordType\\": \\"A\\",
  \\"Endpoints\\": {
    \\"endpoint-start-NkPh\\": {
      \\"Type\\": \\"value\\",
      \\"Value\\": \\"10.0.0.2\\"
    }
  },
  \\"StartEndpoint\\": \\"endpoint-start-NkPh\\"
}
`,
});
import pulumi
import pulumi_aws as aws

example = aws.route53.TrafficPolicy("example",
    name="example",
    comment="example comment",
    document="""{
  \"AWSPolicyFormatVersion\": \"2015-10-01\",
  \"RecordType\": \"A\",
  \"Endpoints\": {
    \"endpoint-start-NkPh\": {
      \"Type\": \"value\",
      \"Value\": \"10.0.0.2\"
    }
  },
  \"StartEndpoint\": \"endpoint-start-NkPh\"
}
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Route53.TrafficPolicy("example", new()
    {
        Name = "example",
        Comment = "example comment",
        Document = @"{
  \""AWSPolicyFormatVersion\"": \""2015-10-01\"",
  \""RecordType\"": \""A\"",
  \""Endpoints\"": {
    \""endpoint-start-NkPh\"": {
      \""Type\"": \""value\"",
      \""Value\"": \""10.0.0.2\""
    }
  },
  \""StartEndpoint\"": \""endpoint-start-NkPh\""
}
",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := route53.NewTrafficPolicy(ctx, "example", &route53.TrafficPolicyArgs{
			Name:    pulumi.String("example"),
			Comment: pulumi.String("example comment"),
			Document: pulumi.String(`{
  \"AWSPolicyFormatVersion\": \"2015-10-01\",
  \"RecordType\": \"A\",
  \"Endpoints\": {
    \"endpoint-start-NkPh\": {
      \"Type\": \"value\",
      \"Value\": \"10.0.0.2\"
    }
  },
  \"StartEndpoint\": \"endpoint-start-NkPh\"
}
`),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_route53_trafficpolicy" "example" {
  name     = "example"
  comment  = "example comment"
  document = "{\n  \\\"AWSPolicyFormatVersion\\\": \\\"2015-10-01\\\",\n  \\\"RecordType\\\": \\\"A\\\",\n  \\\"Endpoints\\\": {\n    \\\"endpoint-start-NkPh\\\": {\n      \\\"Type\\\": \\\"value\\\",\n      \\\"Value\\\": \\\"10.0.0.2\\\"\n    }\n  },\n  \\\"StartEndpoint\\\": \\\"endpoint-start-NkPh\\\"\n}\n"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.TrafficPolicy;
import com.pulumi.aws.route53.TrafficPolicyArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new TrafficPolicy("example", TrafficPolicyArgs.builder()
            .name("example")
            .comment("example comment")
            .document("""
{
  \"AWSPolicyFormatVersion\": \"2015-10-01\",
  \"RecordType\": \"A\",
  \"Endpoints\": {
    \"endpoint-start-NkPh\": {
      \"Type\": \"value\",
      \"Value\": \"10.0.0.2\"
    }
  },
  \"StartEndpoint\": \"endpoint-start-NkPh\"
}
            """)
            .build());

    }
}
resources:
  example:
    type: aws:route53:TrafficPolicy
    properties:
      name: example
      comment: example comment
      document: |
        {
          \"AWSPolicyFormatVersion\": \"2015-10-01\",
          \"RecordType\": \"A\",
          \"Endpoints\": {
            \"endpoint-start-NkPh\": {
              \"Type\": \"value\",
              \"Value\": \"10.0.0.2\"
            }
          },
          \"StartEndpoint\": \"endpoint-start-NkPh\"
        }

Import

Using pulumi import, import Route53 Traffic Policy using the id and version. For example:

$ pulumi import aws:route53/trafficPolicy:TrafficPolicy example 01a52019-d16f-422a-ae72-c306d2b6df7e/1

Constructors

TrafficPolicy(String name, {TrafficPolicyArgs? args, CustomResourceOptions? options})
Creates a new TrafficPolicy. name The Pulumi resource name. args Arguments used to configure this TrafficPolicy. The set of arguments for TrafficPolicy. options Resource options controlling this resource's behavior.
TrafficPolicy.reference(String urn)
Creates a typed reference to an existing TrafficPolicy resource.

Properties

arn ↔ Output<String>
ARN of the traffic policy.
latefinal
childResources → Set<Resource>
finalinherited
comment ↔ Output<String?>
Comment for the traffic policy.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
document ↔ Output<String>
Policy document. This is a JSON formatted string. For more information about building Route53 traffic policy documents, see the AWS Route53 Traffic Policy document format
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of the traffic policy.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>
DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.
latefinal
urn ↔ Output<String>
latefinalinherited
version ↔ Output<int>
Version number of the traffic policy. This value is automatically incremented by AWS after each update of this resource.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TrafficPolicyState? state, CustomResourceOptions? options}) → TrafficPolicy
Gets an existing TrafficPolicy resource's state with the given name and id.