Package com.pulumi.aws.networkmanager

Class ConnectPeer

  • public class ConnectPeer
extends com.pulumi.resources.CustomResource
    Manages an AWS Network Manager Connect Peer. Use this resource to create a Connect peer in AWS Network Manager. Connect peers establish BGP sessions with your on-premises networks through Connect attachments, enabling dynamic routing between your core network and external networks. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.networkmanager.VpcAttachment;
 import com.pulumi.aws.networkmanager.VpcAttachmentArgs;
 import com.pulumi.aws.networkmanager.ConnectAttachment;
 import com.pulumi.aws.networkmanager.ConnectAttachmentArgs;
 import com.pulumi.aws.networkmanager.inputs.ConnectAttachmentOptionsArgs;
 import com.pulumi.aws.networkmanager.ConnectPeer;
 import com.pulumi.aws.networkmanager.ConnectPeerArgs;
 import com.pulumi.aws.networkmanager.inputs.ConnectPeerBgpOptionsArgs;
 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 VpcAttachment("example", VpcAttachmentArgs.builder()
             .subnetArns(exampleAwsSubnet.stream().map(element -> element.arn()).collect(toList()))
             .coreNetworkId(exampleAwsccNetworkmanagerCoreNetwork.id())
             .vpcArn(exampleAwsVpc.arn())
             .build());
 
         var exampleConnectAttachment = new ConnectAttachment("exampleConnectAttachment", ConnectAttachmentArgs.builder()
             .options(ConnectAttachmentOptionsArgs.builder()
                 .protocol("GRE")
                 .build())
             .coreNetworkId(exampleAwsccNetworkmanagerCoreNetwork.id())
             .transportAttachmentId(example.id())
             .edgeLocation(example.edgeLocation())
             .build());
 
         var exampleConnectPeer = new ConnectPeer("exampleConnectPeer", ConnectPeerArgs.builder()
             .bgpOptions(ConnectPeerBgpOptionsArgs.builder()
                 .peerAsn("65000")
                 .build())
             .connectAttachmentId(exampleConnectAttachment.id())
             .peerAddress("127.0.0.1")
             .insideCidrBlocks("172.16.0.0/16")
             .build());
 
     }
 }
    ### Usage with attachment accepter 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.networkmanager.VpcAttachment;
 import com.pulumi.aws.networkmanager.VpcAttachmentArgs;
 import com.pulumi.aws.networkmanager.AttachmentAccepter;
 import com.pulumi.aws.networkmanager.AttachmentAccepterArgs;
 import com.pulumi.aws.networkmanager.ConnectAttachment;
 import com.pulumi.aws.networkmanager.ConnectAttachmentArgs;
 import com.pulumi.aws.networkmanager.inputs.ConnectAttachmentOptionsArgs;
 import com.pulumi.aws.networkmanager.ConnectPeer;
 import com.pulumi.aws.networkmanager.ConnectPeerArgs;
 import com.pulumi.aws.networkmanager.inputs.ConnectPeerBgpOptionsArgs;
 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 example = new VpcAttachment("example", VpcAttachmentArgs.builder()
             .subnetArns(exampleAwsSubnet.stream().map(element -> element.arn()).collect(toList()))
             .coreNetworkId(exampleAwsccNetworkmanagerCoreNetwork.id())
             .vpcArn(exampleAwsVpc.arn())
             .build());
 
         var exampleAttachmentAccepter = new AttachmentAccepter("exampleAttachmentAccepter", AttachmentAccepterArgs.builder()
             .attachmentId(example.id())
             .attachmentType(example.attachmentType())
             .build());
 
         var exampleConnectAttachment = new ConnectAttachment("exampleConnectAttachment", ConnectAttachmentArgs.builder()
             .options(ConnectAttachmentOptionsArgs.builder()
                 .protocol("GRE")
                 .build())
             .coreNetworkId(exampleAwsccNetworkmanagerCoreNetwork.id())
             .transportAttachmentId(example.id())
             .edgeLocation(example.edgeLocation())
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleAttachmentAccepter)
                 .build());
 
         var example2 = new AttachmentAccepter("example2", AttachmentAccepterArgs.builder()
             .attachmentId(exampleConnectAttachment.id())
             .attachmentType(exampleConnectAttachment.attachmentType())
             .build());
 
         var exampleConnectPeer = new ConnectPeer("exampleConnectPeer", ConnectPeerArgs.builder()
             .bgpOptions(ConnectPeerBgpOptionsArgs.builder()
                 .peerAsn("65500")
                 .build())
             .connectAttachmentId(exampleConnectAttachment.id())
             .peerAddress("127.0.0.1")
             .insideCidrBlocks("172.16.0.0/16")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(example2)
                 .build());
 
     }
 }
    ### Usage with a Tunnel-less Connect attachment 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.networkmanager.VpcAttachment;
 import com.pulumi.aws.networkmanager.VpcAttachmentArgs;
 import com.pulumi.aws.networkmanager.ConnectAttachment;
 import com.pulumi.aws.networkmanager.ConnectAttachmentArgs;
 import com.pulumi.aws.networkmanager.inputs.ConnectAttachmentOptionsArgs;
 import com.pulumi.aws.networkmanager.ConnectPeer;
 import com.pulumi.aws.networkmanager.ConnectPeerArgs;
 import com.pulumi.aws.networkmanager.inputs.ConnectPeerBgpOptionsArgs;
 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 VpcAttachment("example", VpcAttachmentArgs.builder()
             .subnetArns(exampleAwsSubnet.stream().map(element -> element.arn()).collect(toList()))
             .coreNetworkId(exampleAwsccNetworkmanagerCoreNetwork.id())
             .vpcArn(exampleAwsVpc.arn())
             .build());
 
         var exampleConnectAttachment = new ConnectAttachment("exampleConnectAttachment", ConnectAttachmentArgs.builder()
             .options(ConnectAttachmentOptionsArgs.builder()
                 .protocol("NO_ENCAP")
                 .build())
             .coreNetworkId(exampleAwsccNetworkmanagerCoreNetwork.id())
             .transportAttachmentId(example.id())
             .edgeLocation(example.edgeLocation())
             .build());
 
         var exampleConnectPeer = new ConnectPeer("exampleConnectPeer", ConnectPeerArgs.builder()
             .bgpOptions(ConnectPeerBgpOptionsArgs.builder()
                 .peerAsn("65000")
                 .build())
             .connectAttachmentId(exampleConnectAttachment.id())
             .peerAddress("127.0.0.1")
             .subnetArn(example2.arn())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import `aws.networkmanager.ConnectPeer` using the connect peer ID. For example: ```sh $ pulumi import aws:networkmanager/connectPeer:ConnectPeer example connect-peer-061f3e96275db1acc ```

    • 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<ConnectPeerBgpOptions> bgpOptions()  
      com.pulumi.core.Output<java.util.List<ConnectPeerConfiguration>> configurations()  
      com.pulumi.core.Output<java.lang.String> connectAttachmentId()  
      com.pulumi.core.Output<java.lang.String> connectPeerId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> coreNetworkAddress()  
      com.pulumi.core.Output<java.lang.String> coreNetworkId()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.lang.String> edgeLocation()  
      static ConnectPeer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ConnectPeerState 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.util.Optional<java.util.List<java.lang.String>>> insideCidrBlocks()  
      com.pulumi.core.Output<java.lang.String> peerAddress()  
      com.pulumi.core.Output<java.lang.String> state()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> subnetArn()  
      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()  

      • 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

      • ConnectPeer

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

      • ConnectPeer

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

      • ConnectPeer

        public ConnectPeer​(java.lang.String name,
                   ConnectPeerArgs 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 Connect peer.

      • bgpOptions

        public com.pulumi.core.Output<ConnectPeerBgpOptions> bgpOptions()
        Returns:
        Connect peer BGP options. See bgpOptions for more information.

      • configurations

        public com.pulumi.core.Output<java.util.List<ConnectPeerConfiguration>> configurations()
        Returns:
        Configuration of the Connect peer.

      • connectAttachmentId

        public com.pulumi.core.Output<java.lang.String> connectAttachmentId()
        Returns:
        ID of the connection attachment.

      • connectPeerId

        public com.pulumi.core.Output<java.lang.String> connectPeerId()
        Returns:
        ID of the Connect peer.

      • coreNetworkAddress

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> coreNetworkAddress()
        Returns:
        Connect peer core network address.

      • coreNetworkId

        public com.pulumi.core.Output<java.lang.String> coreNetworkId()
        Returns:
        ID of a core network.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Timestamp when the Connect peer was created.

      • edgeLocation

        public com.pulumi.core.Output<java.lang.String> edgeLocation()
        Returns:
        Region where the peer is located.

      • insideCidrBlocks

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> insideCidrBlocks()
        Returns:
        Inside IP addresses used for BGP peering. Required when the Connect attachment protocol is `GRE`. See `aws.networkmanager.ConnectAttachment` for details.

      • peerAddress

        public com.pulumi.core.Output<java.lang.String> peerAddress()
        Returns:
        Connect peer address. The following arguments are optional:

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        State of the Connect peer.

      • subnetArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> subnetArn()
        Returns:
        Subnet ARN for the Connect peer. Required when the Connect attachment protocol is `NO_ENCAP`. See `aws.networkmanager.ConnectAttachment` for details.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value tags for the attachment. 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 ConnectPeer get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              ConnectPeerState 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.