Package com.pulumi.aws.vpc

Class RouteServer

  • public class RouteServer
extends com.pulumi.resources.CustomResource
    Provides a resource for managing a VPC Route Server. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.vpc.RouteServer;
 import com.pulumi.aws.vpc.RouteServerArgs;
 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 test = new RouteServer("test", RouteServerArgs.builder()
             .amazonSideAsn(65534)
             .tags(Map.of("Name", "Test"))
             .build());
 
     }
 }
    ### Persist Route and SNS Notification 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.vpc.RouteServer;
 import com.pulumi.aws.vpc.RouteServerArgs;
 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 test = new RouteServer("test", RouteServerArgs.builder()
             .amazonSideAsn(65534)
             .persistRoutes("enable")
             .persistRoutesDuration(2)
             .snsNotificationsEnabled(true)
             .tags(Map.of("Name", "Main Route Server"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import VPC Route Server using the `routeServerId`. For example: ```sh $ pulumi import aws:vpc/routeServer:RouteServer example rs-12345678 ```

    • 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.lang.Integer> amazonSideAsn()  
      com.pulumi.core.Output<java.lang.String> arn()  
      static RouteServer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RouteServerState 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> persistRoutes()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> persistRoutesDuration()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> routeServerId()  
      com.pulumi.core.Output<java.lang.Boolean> snsNotificationsEnabled()  
      com.pulumi.core.Output<java.lang.String> snsTopicArn()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<RouteServerTimeouts>> timeouts()  

      • 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

      • RouteServer

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

      • RouteServer

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

      • RouteServer

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

      • amazonSideAsn

        public com.pulumi.core.Output<java.lang.Integer> amazonSideAsn()
        Returns:
        Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. The following arguments are optional:

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the route server.

      • persistRoutes

        public com.pulumi.core.Output<java.lang.String> persistRoutes()
        Returns:
        Whether routes should be persisted after all BGP sessions are terminated. Valid values are `enable`, `disable`, `reset`

      • persistRoutesDuration

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> persistRoutesDuration()
        Returns:
        Number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if `persistRoutes` is enabled.

      • 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.

      • routeServerId

        public com.pulumi.core.Output<java.lang.String> routeServerId()
        Returns:
        Unique identifier of the route server.

      • snsNotificationsEnabled

        public com.pulumi.core.Output<java.lang.Boolean> snsNotificationsEnabled()
        Returns:
        Whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS.

      • snsTopicArn

        public com.pulumi.core.Output<java.lang.String> snsTopicArn()
        Returns:
        ARN of the SNS topic where notifications are published.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

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