AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.9.1 published on Tuesday, Jun 21, 2022 by Pulumi

HostedPrivateVirtualInterfaceAccepter

Provides a resource to manage the accepter’s side of a Direct Connect hosted private virtual interface. This resource accepts ownership of a private virtual interface created by another AWS account.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var accepter = new Aws.Provider("accepter", new Aws.ProviderArgs
        {
        });
        // Accepter's credentials.
        var accepterCallerIdentity = Output.Create(Aws.GetCallerIdentity.InvokeAsync());
        // Accepter's side of the VIF.
        var vpnGw = new Aws.Ec2.VpnGateway("vpnGw", new Aws.Ec2.VpnGatewayArgs
        {
        }, new CustomResourceOptions
        {
            Provider = aws.Accepter,
        });
        // Creator's side of the VIF
        var creator = new Aws.DirectConnect.HostedPrivateVirtualInterface("creator", new Aws.DirectConnect.HostedPrivateVirtualInterfaceArgs
        {
            ConnectionId = "dxcon-zzzzzzzz",
            OwnerAccountId = accepterCallerIdentity.Apply(accepterCallerIdentity => accepterCallerIdentity.AccountId),
            Vlan = 4094,
            AddressFamily = "ipv4",
            BgpAsn = 65352,
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                vpnGw,
            },
        });
        var accepterHostedPrivateVirtualInterfaceAccepter = new Aws.DirectConnect.HostedPrivateVirtualInterfaceAccepter("accepterHostedPrivateVirtualInterfaceAccepter", new Aws.DirectConnect.HostedPrivateVirtualInterfaceAccepterArgs
        {
            VirtualInterfaceId = creator.Id,
            VpnGatewayId = vpnGw.Id,
            Tags = 
            {
                { "Side", "Accepter" },
            },
        }, new CustomResourceOptions
        {
            Provider = aws.Accepter,
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/directconnect"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ec2"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/providers"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := providers.Newaws(ctx, "accepter", nil)
		if err != nil {
			return err
		}
		accepterCallerIdentity, err := aws.GetCallerIdentity(ctx, nil, nil)
		if err != nil {
			return err
		}
		vpnGw, err := ec2.NewVpnGateway(ctx, "vpnGw", nil, pulumi.Provider(aws.Accepter))
		if err != nil {
			return err
		}
		creator, err := directconnect.NewHostedPrivateVirtualInterface(ctx, "creator", &directconnect.HostedPrivateVirtualInterfaceArgs{
			ConnectionId:   pulumi.String("dxcon-zzzzzzzz"),
			OwnerAccountId: pulumi.String(accepterCallerIdentity.AccountId),
			Vlan:           pulumi.Int(4094),
			AddressFamily:  pulumi.String("ipv4"),
			BgpAsn:         pulumi.Int(65352),
		}, pulumi.DependsOn([]pulumi.Resource{
			vpnGw,
		}))
		if err != nil {
			return err
		}
		_, err = directconnect.NewHostedPrivateVirtualInterfaceAccepter(ctx, "accepterHostedPrivateVirtualInterfaceAccepter", &directconnect.HostedPrivateVirtualInterfaceAccepterArgs{
			VirtualInterfaceId: creator.ID(),
			VpnGatewayId:       vpnGw.ID(),
			Tags: pulumi.StringMap{
				"Side": pulumi.String("Accepter"),
			},
		}, pulumi.Provider(aws.Accepter))
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
import com.pulumi.resources.CustomResourceOptions;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var accepter = new Provider("accepter");

        final var accepterCallerIdentity = Output.of(AwsFunctions.getCallerIdentity());

        var vpnGw = new VpnGateway("vpnGw", VpnGatewayArgs.Empty, CustomResourceOptions.builder()
            .provider(aws.accepter())
            .build());

        var creator = new HostedPrivateVirtualInterface("creator", HostedPrivateVirtualInterfaceArgs.builder()        
            .connectionId("dxcon-zzzzzzzz")
            .ownerAccountId(accepterCallerIdentity.apply(getCallerIdentityResult -> getCallerIdentityResult.accountId()))
            .vlan(4094)
            .addressFamily("ipv4")
            .bgpAsn(65352)
            .build(), CustomResourceOptions.builder()
                .dependsOn(vpnGw)
                .build());

        var accepterHostedPrivateVirtualInterfaceAccepter = new HostedPrivateVirtualInterfaceAccepter("accepterHostedPrivateVirtualInterfaceAccepter", HostedPrivateVirtualInterfaceAccepterArgs.builder()        
            .virtualInterfaceId(creator.id())
            .vpnGatewayId(vpnGw.id())
            .tags(Map.of("Side", "Accepter"))
            .build(), CustomResourceOptions.builder()
                .provider(aws.accepter())
                .build());

    }
}

import pulumi
import pulumi_aws as aws
import pulumi_pulumi as pulumi

accepter = pulumi.providers.Aws("accepter")
# Accepter's credentials.
accepter_caller_identity = aws.get_caller_identity()
# Accepter's side of the VIF.
vpn_gw = aws.ec2.VpnGateway("vpnGw", opts=pulumi.ResourceOptions(provider=aws["accepter"]))
# Creator's side of the VIF
creator = aws.directconnect.HostedPrivateVirtualInterface("creator",
    connection_id="dxcon-zzzzzzzz",
    owner_account_id=accepter_caller_identity.account_id,
    vlan=4094,
    address_family="ipv4",
    bgp_asn=65352,
    opts=pulumi.ResourceOptions(depends_on=[vpn_gw]))
accepter_hosted_private_virtual_interface_accepter = aws.directconnect.HostedPrivateVirtualInterfaceAccepter("accepterHostedPrivateVirtualInterfaceAccepter",
    virtual_interface_id=creator.id,
    vpn_gateway_id=vpn_gw.id,
    tags={
        "Side": "Accepter",
    },
    opts=pulumi.ResourceOptions(provider=aws["accepter"]))

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

const accepter = new aws.Provider("accepter", {});
// Accepter's credentials.
const accepterCallerIdentity = aws.getCallerIdentity({});
// Accepter's side of the VIF.
const vpnGw = new aws.ec2.VpnGateway("vpnGw", {}, {
    provider: aws.accepter,
});
// Creator's side of the VIF
const creator = new aws.directconnect.HostedPrivateVirtualInterface("creator", {
    connectionId: "dxcon-zzzzzzzz",
    ownerAccountId: accepterCallerIdentity.then(accepterCallerIdentity => accepterCallerIdentity.accountId),
    vlan: 4094,
    addressFamily: "ipv4",
    bgpAsn: 65352,
}, {
    dependsOn: [vpnGw],
});
const accepterHostedPrivateVirtualInterfaceAccepter = new aws.directconnect.HostedPrivateVirtualInterfaceAccepter("accepterHostedPrivateVirtualInterfaceAccepter", {
    virtualInterfaceId: creator.id,
    vpnGatewayId: vpnGw.id,
    tags: {
        Side: "Accepter",
    },
}, {
    provider: aws.accepter,
});

resources:
  accepter:
    type: pulumi:providers:aws
  creator:
    type: aws:directconnect:HostedPrivateVirtualInterface
    properties:
      connectionId: dxcon-zzzzzzzz
      ownerAccountId: ${accepterCallerIdentity.accountId}
      vlan: 4094
      addressFamily: ipv4
      bgpAsn: 65352
    options:
      dependson:
        - ${vpnGw}
  vpnGw:
    type: aws:ec2:VpnGateway
    options:
      provider: ${aws.accepter}
  accepterHostedPrivateVirtualInterfaceAccepter:
    type: aws:directconnect:HostedPrivateVirtualInterfaceAccepter
    properties:
      virtualInterfaceId: ${creator.id}
      vpnGatewayId: ${vpnGw.id}
      tags:
        Side: Accepter
    options:
      provider: ${aws.accepter}
variables:
  accepterCallerIdentity:
    Fn::Invoke:
      Function: aws:getCallerIdentity
      Arguments: {}

Create a HostedPrivateVirtualInterfaceAccepter Resource

new HostedPrivateVirtualInterfaceAccepter(name: string, args: HostedPrivateVirtualInterfaceAccepterArgs, opts?: CustomResourceOptions);

@overload
def HostedPrivateVirtualInterfaceAccepter(resource_name: str,
                                          opts: Optional[ResourceOptions] = None,
                                          dx_gateway_id: Optional[str] = None,
                                          tags: Optional[Mapping[str, str]] = None,
                                          virtual_interface_id: Optional[str] = None,
                                          vpn_gateway_id: Optional[str] = None)
@overload
def HostedPrivateVirtualInterfaceAccepter(resource_name: str,
                                          args: HostedPrivateVirtualInterfaceAccepterArgs,
                                          opts: Optional[ResourceOptions] = None)

func NewHostedPrivateVirtualInterfaceAccepter(ctx *Context, name string, args HostedPrivateVirtualInterfaceAccepterArgs, opts ...ResourceOption) (*HostedPrivateVirtualInterfaceAccepter, error)

public HostedPrivateVirtualInterfaceAccepter(string name, HostedPrivateVirtualInterfaceAccepterArgs args, CustomResourceOptions? opts = null)

public HostedPrivateVirtualInterfaceAccepter(String name, HostedPrivateVirtualInterfaceAccepterArgs args)
public HostedPrivateVirtualInterfaceAccepter(String name, HostedPrivateVirtualInterfaceAccepterArgs args, CustomResourceOptions options)

type: aws:directconnect:HostedPrivateVirtualInterfaceAccepter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HostedPrivateVirtualInterfaceAccepterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args HostedPrivateVirtualInterfaceAccepterArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args HostedPrivateVirtualInterfaceAccepterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HostedPrivateVirtualInterfaceAccepterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args HostedPrivateVirtualInterfaceAccepterArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

HostedPrivateVirtualInterfaceAccepter Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The HostedPrivateVirtualInterfaceAccepter resource accepts the following input properties:

VirtualInterfaceId string: The ID of the Direct Connect virtual interface to accept.
DxGatewayId string: The ID of the Direct Connect gateway to which to connect the virtual interface.
Tags Dictionary<string, string>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
VpnGatewayId string: The ID of the virtual private gateway to which to connect the virtual interface.

VirtualInterfaceId string: The ID of the Direct Connect virtual interface to accept.
DxGatewayId string: The ID of the Direct Connect gateway to which to connect the virtual interface.
Tags map[string]string: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
VpnGatewayId string: The ID of the virtual private gateway to which to connect the virtual interface.

virtualInterfaceId String: The ID of the Direct Connect virtual interface to accept.
dxGatewayId String: The ID of the Direct Connect gateway to which to connect the virtual interface.
tags Map<String,String>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpnGatewayId String: The ID of the virtual private gateway to which to connect the virtual interface.

virtualInterfaceId string: The ID of the Direct Connect virtual interface to accept.
dxGatewayId string: The ID of the Direct Connect gateway to which to connect the virtual interface.
tags {[key: string]: string}: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpnGatewayId string: The ID of the virtual private gateway to which to connect the virtual interface.

virtual_interface_id str: The ID of the Direct Connect virtual interface to accept.
dx_gateway_id str: The ID of the Direct Connect gateway to which to connect the virtual interface.
tags Mapping[str, str]: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpn_gateway_id str: The ID of the virtual private gateway to which to connect the virtual interface.

virtualInterfaceId String: The ID of the Direct Connect virtual interface to accept.
dxGatewayId String: The ID of the Direct Connect gateway to which to connect the virtual interface.
tags Map<String>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
vpnGatewayId String: The ID of the virtual private gateway to which to connect the virtual interface.

Outputs

All input properties are implicitly available as output properties. Additionally, the HostedPrivateVirtualInterfaceAccepter resource produces the following output properties:

Arn string: The ARN of the virtual interface.
Id string: The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider .

Arn string: The ARN of the virtual interface.
Id string: The provider-assigned unique ID for this managed resource.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider .

arn String: The ARN of the virtual interface.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider .

arn string: The ARN of the virtual interface.
id string: The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider .

arn str: The ARN of the virtual interface.
id str: The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider .

arn String: The ARN of the virtual interface.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider .

Look up an Existing HostedPrivateVirtualInterfaceAccepter Resource

Get an existing HostedPrivateVirtualInterfaceAccepter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HostedPrivateVirtualInterfaceAccepterState, opts?: CustomResourceOptions): HostedPrivateVirtualInterfaceAccepter

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        dx_gateway_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        virtual_interface_id: Optional[str] = None,
        vpn_gateway_id: Optional[str] = None) -> HostedPrivateVirtualInterfaceAccepter

func GetHostedPrivateVirtualInterfaceAccepter(ctx *Context, name string, id IDInput, state *HostedPrivateVirtualInterfaceAccepterState, opts ...ResourceOption) (*HostedPrivateVirtualInterfaceAccepter, error)

public static HostedPrivateVirtualInterfaceAccepter Get(string name, Input<string> id, HostedPrivateVirtualInterfaceAccepterState? state, CustomResourceOptions? opts = null)

public static HostedPrivateVirtualInterfaceAccepter get(String name, Output<String> id, HostedPrivateVirtualInterfaceAccepterState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The ARN of the virtual interface.
DxGatewayId string: The ID of the Direct Connect gateway to which to connect the virtual interface.
Tags Dictionary<string, string>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider .
VirtualInterfaceId string: The ID of the Direct Connect virtual interface to accept.
VpnGatewayId string: The ID of the virtual private gateway to which to connect the virtual interface.

Arn string: The ARN of the virtual interface.
DxGatewayId string: The ID of the Direct Connect gateway to which to connect the virtual interface.
Tags map[string]string: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider .
VirtualInterfaceId string: The ID of the Direct Connect virtual interface to accept.
VpnGatewayId string: The ID of the virtual private gateway to which to connect the virtual interface.

arn String: The ARN of the virtual interface.
dxGatewayId String: The ID of the Direct Connect gateway to which to connect the virtual interface.
tags Map<String,String>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider .
virtualInterfaceId String: The ID of the Direct Connect virtual interface to accept.
vpnGatewayId String: The ID of the virtual private gateway to which to connect the virtual interface.

arn string: The ARN of the virtual interface.
dxGatewayId string: The ID of the Direct Connect gateway to which to connect the virtual interface.
tags {[key: string]: string}: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider .
virtualInterfaceId string: The ID of the Direct Connect virtual interface to accept.
vpnGatewayId string: The ID of the virtual private gateway to which to connect the virtual interface.

arn str: The ARN of the virtual interface.
dx_gateway_id str: The ID of the Direct Connect gateway to which to connect the virtual interface.
tags Mapping[str, str]: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider .
virtual_interface_id str: The ID of the Direct Connect virtual interface to accept.
vpn_gateway_id str: The ID of the virtual private gateway to which to connect the virtual interface.

arn String: The ARN of the virtual interface.
dxGatewayId String: The ID of the Direct Connect gateway to which to connect the virtual interface.
tags Map<String>: A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider .
virtualInterfaceId String: The ID of the Direct Connect virtual interface to accept.
vpnGatewayId String: The ID of the virtual private gateway to which to connect the virtual interface.

Import

Direct Connect hosted private virtual interfaces can be imported using the vif id, e.g.,

 $ pulumi import aws:directconnect/hostedPrivateVirtualInterfaceAccepter:HostedPrivateVirtualInterfaceAccepter test dxvif-33cc44dd

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.