HostedTransitVirtualInterfaceAcceptor class
Provides a resource to manage the accepter's side of a Direct Connect hosted transit virtual interface. This resource accepts ownership of a transit virtual interface created by another AWS account.
> NOTE: AWS allows a Direct Connect hosted transit virtual interface to be deleted from either the allocator's or accepter's side. However, this provider only allows the Direct Connect hosted transit virtual interface to be deleted from the allocator's side by removing the corresponding aws.directconnect.HostedTransitVirtualInterface resource from your configuration. Removing a aws.directconnect.HostedTransitVirtualInterfaceAcceptor resource from your configuration will remove it from your statefile and management, but will not delete the Direct Connect virtual interface.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const accepter = aws.getCallerIdentity({});
// Accepter's side of the VIF.
const example = new aws.directconnect.Gateway("example", {
name: "tf-dxg-example",
amazonSideAsn: "64512",
});
// Creator's side of the VIF
const creator = new aws.directconnect.HostedTransitVirtualInterface("creator", {
connectionId: "dxcon-zzzzzzzz",
ownerAccountId: accepter.then(accepter => accepter.accountId),
name: "tf-transit-vif-example",
vlan: 4094,
addressFamily: "ipv4",
bgpAsn: 65352,
}, {
dependsOn: [example],
});
const accepterHostedTransitVirtualInterfaceAcceptor = new aws.directconnect.HostedTransitVirtualInterfaceAcceptor("accepter", {
virtualInterfaceId: creator.id,
dxGatewayId: example.id,
tags: {
Side: "Accepter",
},
});
import pulumi
import pulumi_aws as aws
accepter = aws.get_caller_identity()
# Accepter's side of the VIF.
example = aws.directconnect.Gateway("example",
name="tf-dxg-example",
amazon_side_asn="64512")
# Creator's side of the VIF
creator = aws.directconnect.HostedTransitVirtualInterface("creator",
connection_id="dxcon-zzzzzzzz",
owner_account_id=accepter.account_id,
name="tf-transit-vif-example",
vlan=4094,
address_family="ipv4",
bgp_asn=65352,
opts = pulumi.ResourceOptions(depends_on=[example]))
accepter_hosted_transit_virtual_interface_acceptor = aws.directconnect.HostedTransitVirtualInterfaceAcceptor("accepter",
virtual_interface_id=creator.id,
dx_gateway_id=example.id,
tags={
"Side": "Accepter",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var accepter = Aws.GetCallerIdentity.Invoke();
// Accepter's side of the VIF.
var example = new Aws.DirectConnect.Gateway("example", new()
{
Name = "tf-dxg-example",
AmazonSideAsn = "64512",
});
// Creator's side of the VIF
var creator = new Aws.DirectConnect.HostedTransitVirtualInterface("creator", new()
{
ConnectionId = "dxcon-zzzzzzzz",
OwnerAccountId = accepter.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
Name = "tf-transit-vif-example",
Vlan = 4094,
AddressFamily = "ipv4",
BgpAsn = 65352,
}, new CustomResourceOptions
{
DependsOn =
{
example,
},
});
var accepterHostedTransitVirtualInterfaceAcceptor = new Aws.DirectConnect.HostedTransitVirtualInterfaceAcceptor("accepter", new()
{
VirtualInterfaceId = creator.Id,
DxGatewayId = example.Id,
Tags =
{
{ "Side", "Accepter" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"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 {
accepter, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{}, nil)
if err != nil {
return err
}
// Accepter's side of the VIF.
example, err := directconnect.NewGateway(ctx, "example", &directconnect.GatewayArgs{
Name: pulumi.String("tf-dxg-example"),
AmazonSideAsn: pulumi.String("64512"),
})
if err != nil {
return err
}
// Creator's side of the VIF
creator, err := directconnect.NewHostedTransitVirtualInterface(ctx, "creator", &directconnect.HostedTransitVirtualInterfaceArgs{
ConnectionId: pulumi.String("dxcon-zzzzzzzz"),
OwnerAccountId: pulumi.String(accepter.AccountId),
Name: pulumi.String("tf-transit-vif-example"),
Vlan: pulumi.Int(4094),
AddressFamily: pulumi.String("ipv4"),
BgpAsn: pulumi.Int(65352),
}, pulumi.DependsOn([]pulumi.Resource{
example,
}))
if err != nil {
return err
}
_, err = directconnect.NewHostedTransitVirtualInterfaceAcceptor(ctx, "accepter", &directconnect.HostedTransitVirtualInterfaceAcceptorArgs{
VirtualInterfaceId: creator.ID().ToIDOutput().ToStringOutput(),
DxGatewayId: example.ID().ToIDOutput().ToStringOutput(),
Tags: pulumi.StringMap{
"Side": pulumi.String("Accepter"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_getcalleridentity" "accepter" {
}
# Creator's side of the VIF
resource "aws_directconnect_hostedtransitvirtualinterface" "creator" {
depends_on = [aws_directconnect_gateway.example]
connection_id = "dxcon-zzzzzzzz"
owner_account_id = data.aws_getcalleridentity.accepter.account_id
name = "tf-transit-vif-example"
vlan = 4094
address_family = "ipv4"
bgp_asn = 65352
}
# Accepter's side of the VIF.
resource "aws_directconnect_gateway" "example" {
name = "tf-dxg-example"
amazon_side_asn = 64512
}
resource "aws_directconnect_hostedtransitvirtualinterfaceacceptor" "accepter" {
virtual_interface_id = aws_directconnect_hostedtransitvirtualinterface.creator.id
dx_gateway_id = aws_directconnect_gateway.example.id
tags = {
"Side" = "Accepter"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetCallerIdentityArgs;
import com.pulumi.aws.directconnect.Gateway;
import com.pulumi.aws.directconnect.GatewayArgs;
import com.pulumi.aws.directconnect.HostedTransitVirtualInterface;
import com.pulumi.aws.directconnect.HostedTransitVirtualInterfaceArgs;
import com.pulumi.aws.directconnect.HostedTransitVirtualInterfaceAcceptor;
import com.pulumi.aws.directconnect.HostedTransitVirtualInterfaceAcceptorArgs;
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) {
final var accepter = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
.build());
// Accepter's side of the VIF.
var example = new Gateway("example", GatewayArgs.builder()
.name("tf-dxg-example")
.amazonSideAsn("64512")
.build());
// Creator's side of the VIF
var creator = new HostedTransitVirtualInterface("creator", HostedTransitVirtualInterfaceArgs.builder()
.connectionId("dxcon-zzzzzzzz")
.ownerAccountId(accepter.accountId())
.name("tf-transit-vif-example")
.vlan(4094)
.addressFamily("ipv4")
.bgpAsn(65352)
.build(), CustomResourceOptions.builder()
.dependsOn(example)
.build());
var accepterHostedTransitVirtualInterfaceAcceptor = new HostedTransitVirtualInterfaceAcceptor("accepterHostedTransitVirtualInterfaceAcceptor", HostedTransitVirtualInterfaceAcceptorArgs.builder()
.virtualInterfaceId(creator.id())
.dxGatewayId(example.id())
.tags(Map.of("Side", "Accepter"))
.build());
}
}
resources:
# Creator's side of the VIF
creator:
type: aws:directconnect:HostedTransitVirtualInterface
properties:
connectionId: dxcon-zzzzzzzz
ownerAccountId: ${accepter.accountId}
name: tf-transit-vif-example
vlan: 4094
addressFamily: ipv4
bgpAsn: 65352 # The aws_dx_hosted_transit_virtual_interface
# # must be destroyed before the aws_dx_gateway.
options:
dependsOn:
- ${example}
# Accepter's side of the VIF.
example:
type: aws:directconnect:Gateway
properties:
name: tf-dxg-example
amazonSideAsn: 64512
accepterHostedTransitVirtualInterfaceAcceptor:
type: aws:directconnect:HostedTransitVirtualInterfaceAcceptor
name: accepter
properties:
virtualInterfaceId: ${creator.id}
dxGatewayId: ${example.id}
tags:
Side: Accepter
variables:
accepter:
fn::invoke:
function: aws:getCallerIdentity
arguments: {}
Import
Using pulumi import, import Direct Connect hosted transit virtual interfaces using the VIF id. For example:
$ pulumi import aws:directconnect/hostedTransitVirtualInterfaceAcceptor:HostedTransitVirtualInterfaceAcceptor test dxvif-33cc44dd
Constructors
- HostedTransitVirtualInterfaceAcceptor(String name, {HostedTransitVirtualInterfaceAcceptorArgs? args, CustomResourceOptions? options})
-
Creates a new HostedTransitVirtualInterfaceAcceptor.
nameThe Pulumi resource name.argsArguments used to configure this HostedTransitVirtualInterfaceAcceptor. The set of arguments for HostedTransitVirtualInterfaceAcceptor.optionsResource options controlling this resource's behavior. - HostedTransitVirtualInterfaceAcceptor.reference(String urn)
- Creates a typed reference to an existing HostedTransitVirtualInterfaceAcceptor resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the virtual interface.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dxGatewayId
↔ Output<
String> -
The ID of the Direct Connect gateway to which to connect the virtual interface.
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
-
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
-
A map of tags to assign to the resource. .If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
virtualInterfaceId
↔ Output<
String> -
The ID of the Direct Connect virtual interface to accept.
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, {HostedTransitVirtualInterfaceAcceptorState? state, CustomResourceOptions? options}) → HostedTransitVirtualInterfaceAcceptor -
Gets an existing HostedTransitVirtualInterfaceAcceptor resource's state with the given
nameandid.