Package com.pulumi.aws.directconnect

Class BgpPeer

  • public class BgpPeer
extends com.pulumi.resources.CustomResource
    Provides a Direct Connect BGP peer resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.directconnect.BgpPeer;
 import com.pulumi.aws.directconnect.BgpPeerArgs;
 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 peer = new BgpPeer("peer", BgpPeerArgs.builder()
             .virtualInterfaceId(foo.id())
             .addressFamily("ipv6")
             .bgpAsn(65351)
             .build());
 
     }
 }

    • 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
      BgpPeer​(java.lang.String name)  
      BgpPeer​(java.lang.String name, BgpPeerArgs args)  
      BgpPeer​(java.lang.String name, BgpPeerArgs 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.lang.String> addressFamily()  
      com.pulumi.core.Output<java.lang.String> amazonAddress()  
      com.pulumi.core.Output<java.lang.String> awsDevice()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> bgpAsn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> bgpAsnLong()  
      com.pulumi.core.Output<java.lang.String> bgpAuthKey()  
      com.pulumi.core.Output<java.lang.String> bgpPeerId()  
      com.pulumi.core.Output<java.lang.String> bgpStatus()  
      com.pulumi.core.Output<java.lang.String> customerAddress()  
      static BgpPeer get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, BgpPeerState 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.lang.String> virtualInterfaceId()  

      • 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

      • BgpPeer

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

      • BgpPeer

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

      • BgpPeer

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

      • addressFamily

        public com.pulumi.core.Output<java.lang.String> addressFamily()
        Returns:
        The address family for the BGP peer. ` ipv4 ` or `ipv6`.

      • amazonAddress

        public com.pulumi.core.Output<java.lang.String> amazonAddress()
        Returns:
        The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers on public virtual interfaces.

      • awsDevice

        public com.pulumi.core.Output<java.lang.String> awsDevice()
        Returns:
        The Direct Connect endpoint on which the BGP peer terminates.

      • bgpAsn

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> bgpAsn()
        Returns:
        BGP autonomous system number as an integer between `1` and `2147483646`. For larger values, use `bgpAsnLong`. Exactly one of `bgpAsn` or `bgpAsnLong` must be specified.

      • bgpAsnLong

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> bgpAsnLong()
        Returns:
        BGP autonomous system number as an asplain decimal string between `1` and `4294967294`. This argument also accepts values in the `bgpAsn` range. Exactly one of `bgpAsn` or `bgpAsnLong` must be specified.

      • bgpAuthKey

        public com.pulumi.core.Output<java.lang.String> bgpAuthKey()
        Returns:
        The authentication key for BGP configuration.

      • bgpPeerId

        public com.pulumi.core.Output<java.lang.String> bgpPeerId()
        Returns:
        The ID of the BGP peer.

      • bgpStatus

        public com.pulumi.core.Output<java.lang.String> bgpStatus()
        Returns:
        The Up/Down state of the BGP peer.

      • customerAddress

        public com.pulumi.core.Output<java.lang.String> customerAddress()
        Returns:
        The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers on public virtual interfaces.

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

      • virtualInterfaceId

        public com.pulumi.core.Output<java.lang.String> virtualInterfaceId()
        Returns:
        The ID of the Direct Connect virtual interface on which to create the BGP peer.

      • get

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