Package com.pulumi.aws.ec2transitgateway

Class Route

  • public class Route
extends com.pulumi.resources.CustomResource
    Manages an EC2 Transit Gateway Route. ## Example Usage ### Standard usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2transitgateway.Route;
 import com.pulumi.aws.ec2transitgateway.RouteArgs;
 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 Route("example", RouteArgs.builder()
             .destinationCidrBlock("0.0.0.0/0")
             .transitGatewayAttachmentId(exampleAwsEc2TransitGatewayVpcAttachment.id())
             .transitGatewayRouteTableId(exampleAwsEc2TransitGateway.associationDefaultRouteTableId())
             .build());
 
     }
 }
    ### Blackhole route 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2transitgateway.Route;
 import com.pulumi.aws.ec2transitgateway.RouteArgs;
 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 Route("example", RouteArgs.builder()
             .destinationCidrBlock("0.0.0.0/0")
             .blackhole(true)
             .transitGatewayRouteTableId(exampleAwsEc2TransitGateway.associationDefaultRouteTableId())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `destinationCidrBlock` (String) IPv4 or IPv6 CIDR block used for destination matches. * `transitGatewayRouteTableId` (String) Identifier of EC2 Transit Gateway Route Table. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import `aws.ec2transitgateway.Route` using the EC2 Transit Gateway Route Table, an underscore, and the destination. For example: ```sh $ pulumi import aws:ec2transitgateway/route:Route example tgw-rtb-12345678_0.0.0.0/0 ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Route​(java.lang.String name)  
      Route​(java.lang.String name, RouteArgs args)  
      Route​(java.lang.String name, RouteArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blackhole()  
      com.pulumi.core.Output<java.lang.String> destinationCidrBlock()  
      static Route get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RouteState 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> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> transitGatewayAttachmentId()  
      com.pulumi.core.Output<java.lang.String> transitGatewayRouteTableId()  

      • 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

      • Route

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

      • Route

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

      • Route

        public Route​(java.lang.String name,
             RouteArgs 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

      • blackhole

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> blackhole()
        Returns:
        Indicates whether to drop traffic that matches this route (default to `false`).

      • destinationCidrBlock

        public com.pulumi.core.Output<java.lang.String> destinationCidrBlock()
        Returns:
        IPv4 or IPv6 RFC1924 CIDR used for destination matches. Routing decisions are based on the most specific match.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • transitGatewayAttachmentId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> transitGatewayAttachmentId()
        Returns:
        Identifier of EC2 Transit Gateway Attachment (required if `blackhole` is set to false).

      • transitGatewayRouteTableId

        public com.pulumi.core.Output<java.lang.String> transitGatewayRouteTableId()
        Returns:
        Identifier of EC2 Transit Gateway Route Table.

      • get

        public static Route get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        RouteState 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.