Package com.pulumi.aws.directconnect

Class HostedPrivateVirtualInterface

  • public class HostedPrivateVirtualInterface
extends com.pulumi.resources.CustomResource
    Provides a Direct Connect hosted private virtual interface resource. This resource represents the allocator's side of the hosted virtual interface. A hosted virtual interface is a virtual interface that is owned by another AWS account. ## Example Usage <!--Start PulumiCodeChooser --> ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.directconnect.HostedPrivateVirtualInterface; import com.pulumi.aws.directconnect.HostedPrivateVirtualInterfaceArgs; import java.util.List; import java.util.ArrayList; 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 foo = new HostedPrivateVirtualInterface("foo", HostedPrivateVirtualInterfaceArgs.builder() .connectionId("dxcon-zzzzzzzz") .name("vif-foo") .vlan(4094) .addressFamily("ipv4") .bgpAsn(65352) .build()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import Direct Connect hosted private virtual interfaces using the VIF `id`. For example: ```sh $ pulumi import aws:directconnect/hostedPrivateVirtualInterface:HostedPrivateVirtualInterface test dxvif-33cc44dd ```

    • 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> addressFamily()  
      com.pulumi.core.Output<java.lang.String> amazonAddress()  
      com.pulumi.core.Output<java.lang.String> amazonSideAsn()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> awsDevice()  
      com.pulumi.core.Output<java.lang.Integer> bgpAsn()  
      com.pulumi.core.Output<java.lang.String> bgpAuthKey()  
      com.pulumi.core.Output<java.lang.String> connectionId()  
      com.pulumi.core.Output<java.lang.String> customerAddress()  
      static HostedPrivateVirtualInterface get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, HostedPrivateVirtualInterfaceState 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.Boolean> jumboFrameCapable()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> mtu()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> ownerAccountId()  
      com.pulumi.core.Output<java.lang.Integer> vlan()  

      • 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

      • HostedPrivateVirtualInterface

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

      • HostedPrivateVirtualInterface

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

      • HostedPrivateVirtualInterface

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

      • amazonSideAsn

        public com.pulumi.core.Output<java.lang.String> amazonSideAsn()

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the virtual interface.

      • awsDevice

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

      • bgpAsn

        public com.pulumi.core.Output<java.lang.Integer> bgpAsn()
        Returns:
        The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

      • bgpAuthKey

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

      • connectionId

        public com.pulumi.core.Output<java.lang.String> connectionId()
        Returns:
        The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.

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

      • jumboFrameCapable

        public com.pulumi.core.Output<java.lang.Boolean> jumboFrameCapable()
        Returns:
        Indicates whether jumbo frames (9001 MTU) are supported.

      • mtu

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> mtu()
        Returns:
        The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection. The MTU of a virtual private interface can be either `1500` or `9001` (jumbo frames). Default is `1500`.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name for the virtual interface.

      • ownerAccountId

        public com.pulumi.core.Output<java.lang.String> ownerAccountId()
        Returns:
        The AWS account that will own the new virtual interface.

      • vlan

        public com.pulumi.core.Output<java.lang.Integer> vlan()
        Returns:
        The VLAN ID.

      • get

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