HostedPrivateVirtualInterface class

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

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foo = new aws.directconnect.HostedPrivateVirtualInterface("foo", {
    connectionId: "dxcon-zzzzzzzz",
    name: "vif-foo",
    vlan: 4094,
    addressFamily: "ipv4",
    bgpAsn: 65352,
});
import pulumi
import pulumi_aws as aws

foo = aws.directconnect.HostedPrivateVirtualInterface("foo",
    connection_id="dxcon-zzzzzzzz",
    name="vif-foo",
    vlan=4094,
    address_family="ipv4",
    bgp_asn=65352)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var foo = new Aws.DirectConnect.HostedPrivateVirtualInterface("foo", new()
    {
        ConnectionId = "dxcon-zzzzzzzz",
        Name = "vif-foo",
        Vlan = 4094,
        AddressFamily = "ipv4",
        BgpAsn = 65352,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/directconnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directconnect.NewHostedPrivateVirtualInterface(ctx, "foo", &directconnect.HostedPrivateVirtualInterfaceArgs{
			ConnectionId:  pulumi.String("dxcon-zzzzzzzz"),
			Name:          pulumi.String("vif-foo"),
			Vlan:          pulumi.Int(4094),
			AddressFamily: pulumi.String("ipv4"),
			BgpAsn:        pulumi.Int(65352),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_directconnect_hostedprivatevirtualinterface" "foo" {
  connection_id  = "dxcon-zzzzzzzz"
  name           = "vif-foo"
  vlan           = 4094
  address_family = "ipv4"
  bgp_asn        = 65352
}
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.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 foo = new HostedPrivateVirtualInterface("foo", HostedPrivateVirtualInterfaceArgs.builder()
            .connectionId("dxcon-zzzzzzzz")
            .name("vif-foo")
            .vlan(4094)
            .addressFamily("ipv4")
            .bgpAsn(65352)
            .build());

    }
}
resources:
  foo:
    type: aws:directconnect:HostedPrivateVirtualInterface
    properties:
      connectionId: dxcon-zzzzzzzz
      name: vif-foo
      vlan: 4094
      addressFamily: ipv4
      bgpAsn: 65352

Import

Using pulumi import, import Direct Connect hosted private virtual interfaces using the VIF id. For example:

$ pulumi import aws:directconnect/hostedPrivateVirtualInterface:HostedPrivateVirtualInterface test dxvif-33cc44dd

Constructors

HostedPrivateVirtualInterface(String name, {HostedPrivateVirtualInterfaceArgs? args, CustomResourceOptions? options})
Creates a new HostedPrivateVirtualInterface. name The Pulumi resource name. args Arguments used to configure this HostedPrivateVirtualInterface. The set of arguments for HostedPrivateVirtualInterface. options Resource options controlling this resource's behavior.
HostedPrivateVirtualInterface.reference(String urn)
Creates a typed reference to an existing HostedPrivateVirtualInterface resource.

Properties

addressFamily ↔ Output<String>
The address family for the BGP peer. ipv4 or ipv6.
latefinal
amazonAddress ↔ Output<String>
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
latefinal
amazonSideAsn ↔ Output<String>
latefinal
arn ↔ Output<String>
The ARN of the virtual interface.
latefinal
awsDevice ↔ Output<String>
The Direct Connect endpoint on which the virtual interface terminates.
latefinal
bgpAsn ↔ Output<int>
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
latefinal
bgpAuthKey ↔ Output<String>
The authentication key for BGP configuration.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
connectionId ↔ Output<String>
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
latefinal
customerAddress ↔ Output<String>
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
jumboFrameCapable ↔ Output<bool>
Indicates whether jumbo frames (9001 MTU) are supported.
latefinal
mtu ↔ Output<int?>
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.
latefinal
name ↔ Output<String>
The name for the virtual interface.
latefinal
ownerAccountId ↔ Output<String>
The AWS account that will own the new virtual interface.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vlan ↔ Output<int>
The VLAN ID.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {HostedPrivateVirtualInterfaceState? state, CustomResourceOptions? options}) → HostedPrivateVirtualInterface
Gets an existing HostedPrivateVirtualInterface resource's state with the given name and id.