Class RouteServerPeer


  • public class RouteServerPeer
    extends com.pulumi.resources.CustomResource
    Provides a resource for managing a VPC Route Server Peer. ## 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.RouteServerPeer;
     import com.pulumi.aws.vpc.RouteServerPeerArgs;
     import com.pulumi.aws.vpc.inputs.RouteServerPeerBgpOptionsArgs;
     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 RouteServerPeer("test", RouteServerPeerArgs.builder()
                 .bgpOptions(RouteServerPeerBgpOptionsArgs.builder()
                     .peerAsn(65200)
                     .build())
                 .routeServerEndpointId(example.routeServerEndpointId())
                 .peerAddress("10.0.1.250")
                 .tags(Map.of("Name", "Appliance 1"))
                 .build());
     
         }
     }
     
     
    ### Complete Configuration
     
     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 com.pulumi.aws.vpc.RouteServerVpcAssociation;
     import com.pulumi.aws.vpc.RouteServerVpcAssociationArgs;
     import com.pulumi.aws.vpc.RouteServerEndpoint;
     import com.pulumi.aws.vpc.RouteServerEndpointArgs;
     import com.pulumi.aws.vpc.RouteServerPropagation;
     import com.pulumi.aws.vpc.RouteServerPropagationArgs;
     import com.pulumi.aws.vpc.RouteServerPeer;
     import com.pulumi.aws.vpc.RouteServerPeerArgs;
     import com.pulumi.aws.vpc.inputs.RouteServerPeerBgpOptionsArgs;
     import com.pulumi.resources.CustomResourceOptions;
     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(4294967294)
                 .tags(Map.of("Name", "Test"))
                 .build());
     
             var testRouteServerVpcAssociation = new RouteServerVpcAssociation("testRouteServerVpcAssociation", RouteServerVpcAssociationArgs.builder()
                 .routeServerId(test.routeServerId())
                 .vpcId(testAwsVpc.id())
                 .build());
     
             var testRouteServerEndpoint = new RouteServerEndpoint("testRouteServerEndpoint", RouteServerEndpointArgs.builder()
                 .routeServerId(test.routeServerId())
                 .subnetId(testAwsSubnet.id())
                 .tags(Map.of("Name", "Test Endpoint"))
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(testRouteServerVpcAssociation)
                     .build());
     
             var testRouteServerPropagation = new RouteServerPropagation("testRouteServerPropagation", RouteServerPropagationArgs.builder()
                 .routeServerId(test.routeServerId())
                 .routeTableId(testAwsRouteTable.id())
                 .build(), CustomResourceOptions.builder()
                     .dependsOn(testRouteServerVpcAssociation)
                     .build());
     
             var testRouteServerPeer = new RouteServerPeer("testRouteServerPeer", RouteServerPeerArgs.builder()
                 .bgpOptions(RouteServerPeerBgpOptionsArgs.builder()
                     .peerAsn(65000)
                     .peerLivenessDetection("bgp-keepalive")
                     .build())
                 .routeServerEndpointId(testRouteServerEndpoint.routeServerEndpointId())
                 .peerAddress("10.0.1.250")
                 .tags(Map.of("Name", "Test Appliance"))
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import VPC Route Server using the `routeServerPeerId`. For example: ```sh $ pulumi import aws:vpc/routeServerPeer:RouteServerPeer example rsp-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.String> arn()  
      com.pulumi.core.Output<RouteServerPeerBgpOptions> bgpOptions()  
      com.pulumi.core.Output<java.lang.String> endpointEniAddress()  
      com.pulumi.core.Output<java.lang.String> endpointEniId()  
      static RouteServerPeer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RouteServerPeerState 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> peerAddress()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> routeServerEndpointId()  
      com.pulumi.core.Output<java.lang.String> routeServerId()  
      com.pulumi.core.Output<java.lang.String> routeServerPeerId()  
      com.pulumi.core.Output<java.lang.String> subnetId()  
      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<RouteServerPeerTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> vpcId()  
      • 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

      • RouteServerPeer

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

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

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

      • arn

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

        public com.pulumi.core.Output<RouteServerPeerBgpOptions> bgpOptions()
        Returns:
        BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below
      • endpointEniAddress

        public com.pulumi.core.Output<java.lang.String> endpointEniAddress()
        Returns:
        IP address of the Elastic network interface for the route server endpoint.
      • endpointEniId

        public com.pulumi.core.Output<java.lang.String> endpointEniId()
        Returns:
        ID of the Elastic network interface for the route server endpoint.
      • peerAddress

        public com.pulumi.core.Output<java.lang.String> peerAddress()
        Returns:
        IPv4 address of the peer device.
      • 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.
      • routeServerEndpointId

        public com.pulumi.core.Output<java.lang.String> routeServerEndpointId()
        Returns:
        ID of the route server endpoint for which to create a peer. The following arguments are optional:
      • routeServerId

        public com.pulumi.core.Output<java.lang.String> routeServerId()
        Returns:
        ID of the route server associated with this peer.
      • routeServerPeerId

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

        public com.pulumi.core.Output<java.lang.String> subnetId()
        Returns:
        ID of the subnet containing the route server peer.
      • 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.
      • vpcId

        public com.pulumi.core.Output<java.lang.String> vpcId()
        Returns:
        ID of the VPC containing the route server peer.
      • get

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