Package com.pulumi.aws.route53

Class TrafficPolicy

  • public class TrafficPolicy
extends com.pulumi.resources.CustomResource
    Manages a Route53 Traffic Policy. ## Example Usage <!--Start PulumiCodeChooser --> 
     
 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.List;
 import java.util.ArrayList;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var 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());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import Route53 Traffic Policy using the `id` and `version`. For example: ```sh $ pulumi import aws:route53/trafficPolicy:TrafficPolicy example 01a52019-d16f-422a-ae72-c306d2b6df7e/1 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> comment()  
      com.pulumi.core.Output<java.lang.String> document()  
      static TrafficPolicy get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TrafficPolicyState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> type()  
      com.pulumi.core.Output<java.lang.Integer> version()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TrafficPolicy

        public TrafficPolicy​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • TrafficPolicy

        public TrafficPolicy​(java.lang.String name,
                     TrafficPolicyArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • TrafficPolicy

        public TrafficPolicy​(java.lang.String name,
                     TrafficPolicyArgs args,
                     @Nullable
                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • comment

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> comment()
        Returns:
        Comment for the traffic policy.

      • document

        public com.pulumi.core.Output<java.lang.String> document()
        Returns:
        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](https://docs.aws.amazon.com/Route53/latest/APIReference/api-policies-traffic-policy-document-format.html) The following arguments are optional:

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the traffic policy.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

      • version

        public com.pulumi.core.Output<java.lang.Integer> version()
        Returns:
        Version number of the traffic policy. This value is automatically incremented by AWS after each update of this resource.

      • get

        public static TrafficPolicy get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                TrafficPolicyState state,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.