CustomerGatewayAssociation class
Manages a Network Manager Customer Gateway Association.
Use this resource to associate a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.networkmanager.GlobalNetwork("example", {description: "example"});
const exampleSite = new aws.networkmanager.Site("example", {globalNetworkId: example.id});
const exampleDevice = new aws.networkmanager.Device("example", {
globalNetworkId: example.id,
siteId: exampleSite.id,
});
const exampleCustomerGateway = new aws.ec2.CustomerGateway("example", {
bgpAsn: "65000",
ipAddress: "172.83.124.10",
type: "ipsec.1",
});
const exampleTransitGateway = new aws.ec2transitgateway.TransitGateway("example", {});
const exampleVpnConnection = new aws.ec2.VpnConnection("example", {
customerGatewayId: exampleCustomerGateway.id,
transitGatewayId: exampleTransitGateway.id,
type: exampleCustomerGateway.type,
staticRoutesOnly: true,
});
const exampleTransitGatewayRegistration = new aws.networkmanager.TransitGatewayRegistration("example", {
globalNetworkId: example.id,
transitGatewayArn: exampleTransitGateway.arn,
}, {
dependsOn: [exampleVpnConnection],
});
const exampleCustomerGatewayAssociation = new aws.networkmanager.CustomerGatewayAssociation("example", {
globalNetworkId: example.id,
customerGatewayArn: exampleCustomerGateway.arn,
deviceId: exampleDevice.id,
}, {
dependsOn: [exampleTransitGatewayRegistration],
});
import pulumi
import pulumi_aws as aws
example = aws.networkmanager.GlobalNetwork("example", description="example")
example_site = aws.networkmanager.Site("example", global_network_id=example.id)
example_device = aws.networkmanager.Device("example",
global_network_id=example.id,
site_id=example_site.id)
example_customer_gateway = aws.ec2.CustomerGateway("example",
bgp_asn="65000",
ip_address="172.83.124.10",
type="ipsec.1")
example_transit_gateway = aws.ec2transitgateway.TransitGateway("example")
example_vpn_connection = aws.ec2.VpnConnection("example",
customer_gateway_id=example_customer_gateway.id,
transit_gateway_id=example_transit_gateway.id,
type=example_customer_gateway.type,
static_routes_only=True)
example_transit_gateway_registration = aws.networkmanager.TransitGatewayRegistration("example",
global_network_id=example.id,
transit_gateway_arn=example_transit_gateway.arn,
opts = pulumi.ResourceOptions(depends_on=[example_vpn_connection]))
example_customer_gateway_association = aws.networkmanager.CustomerGatewayAssociation("example",
global_network_id=example.id,
customer_gateway_arn=example_customer_gateway.arn,
device_id=example_device.id,
opts = pulumi.ResourceOptions(depends_on=[example_transit_gateway_registration]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.NetworkManager.GlobalNetwork("example", new()
{
Description = "example",
});
var exampleSite = new Aws.NetworkManager.Site("example", new()
{
GlobalNetworkId = example.Id,
});
var exampleDevice = new Aws.NetworkManager.Device("example", new()
{
GlobalNetworkId = example.Id,
SiteId = exampleSite.Id,
});
var exampleCustomerGateway = new Aws.Ec2.CustomerGateway("example", new()
{
BgpAsn = "65000",
IpAddress = "172.83.124.10",
Type = "ipsec.1",
});
var exampleTransitGateway = new Aws.Ec2TransitGateway.TransitGateway("example");
var exampleVpnConnection = new Aws.Ec2.VpnConnection("example", new()
{
CustomerGatewayId = exampleCustomerGateway.Id,
TransitGatewayId = exampleTransitGateway.Id,
Type = exampleCustomerGateway.Type,
StaticRoutesOnly = true,
});
var exampleTransitGatewayRegistration = new Aws.NetworkManager.TransitGatewayRegistration("example", new()
{
GlobalNetworkId = example.Id,
TransitGatewayArn = exampleTransitGateway.Arn,
}, new CustomResourceOptions
{
DependsOn =
{
exampleVpnConnection,
},
});
var exampleCustomerGatewayAssociation = new Aws.NetworkManager.CustomerGatewayAssociation("example", new()
{
GlobalNetworkId = example.Id,
CustomerGatewayArn = exampleCustomerGateway.Arn,
DeviceId = exampleDevice.Id,
}, new CustomResourceOptions
{
DependsOn =
{
exampleTransitGatewayRegistration,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ec2transitgateway"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/networkmanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := networkmanager.NewGlobalNetwork(ctx, "example", &networkmanager.GlobalNetworkArgs{
Description: pulumi.String("example"),
})
if err != nil {
return err
}
exampleSite, err := networkmanager.NewSite(ctx, "example", &networkmanager.SiteArgs{
GlobalNetworkId: example.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
exampleDevice, err := networkmanager.NewDevice(ctx, "example", &networkmanager.DeviceArgs{
GlobalNetworkId: example.ID().ToIDOutput().ToStringOutput(),
SiteId: exampleSite.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
exampleCustomerGateway, err := ec2.NewCustomerGateway(ctx, "example", &ec2.CustomerGatewayArgs{
BgpAsn: pulumi.String("65000"),
IpAddress: pulumi.String("172.83.124.10"),
Type: pulumi.String("ipsec.1"),
})
if err != nil {
return err
}
exampleTransitGateway, err := ec2transitgateway.NewTransitGateway(ctx, "example", nil)
if err != nil {
return err
}
exampleVpnConnection, err := ec2.NewVpnConnection(ctx, "example", &ec2.VpnConnectionArgs{
CustomerGatewayId: exampleCustomerGateway.ID().ToIDOutput().ToStringOutput(),
TransitGatewayId: exampleTransitGateway.ID().ToIDOutput().ToStringOutput(),
Type: exampleCustomerGateway.Type,
StaticRoutesOnly: pulumi.Bool(true),
})
if err != nil {
return err
}
exampleTransitGatewayRegistration, err := networkmanager.NewTransitGatewayRegistration(ctx, "example", &networkmanager.TransitGatewayRegistrationArgs{
GlobalNetworkId: example.ID().ToIDOutput().ToStringOutput(),
TransitGatewayArn: exampleTransitGateway.Arn,
}, pulumi.DependsOn([]pulumi.Resource{
exampleVpnConnection,
}))
if err != nil {
return err
}
_, err = networkmanager.NewCustomerGatewayAssociation(ctx, "example", &networkmanager.CustomerGatewayAssociationArgs{
GlobalNetworkId: example.ID().ToIDOutput().ToStringOutput(),
CustomerGatewayArn: exampleCustomerGateway.Arn,
DeviceId: exampleDevice.ID().ToIDOutput().ToStringOutput(),
}, pulumi.DependsOn([]pulumi.Resource{
exampleTransitGatewayRegistration,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_networkmanager_globalnetwork" "example" {
description = "example"
}
resource "aws_networkmanager_site" "example" {
global_network_id = aws_networkmanager_globalnetwork.example.id
}
resource "aws_networkmanager_device" "example" {
global_network_id = aws_networkmanager_globalnetwork.example.id
site_id = aws_networkmanager_site.example.id
}
resource "aws_ec2_customergateway" "example" {
bgp_asn = 65000
ip_address = "172.83.124.10"
type = "ipsec.1"
}
resource "aws_ec2transitgateway_transitgateway" "example" {
}
resource "aws_ec2_vpnconnection" "example" {
customer_gateway_id = aws_ec2_customergateway.example.id
transit_gateway_id = aws_ec2transitgateway_transitgateway.example.id
type = aws_ec2_customergateway.example.type
static_routes_only = true
}
resource "aws_networkmanager_transitgatewayregistration" "example" {
depends_on = [aws_ec2_vpnconnection.example]
global_network_id = aws_networkmanager_globalnetwork.example.id
transit_gateway_arn = aws_ec2transitgateway_transitgateway.example.arn
}
resource "aws_networkmanager_customergatewayassociation" "example" {
depends_on = [aws_networkmanager_transitgatewayregistration.example]
global_network_id = aws_networkmanager_globalnetwork.example.id
customer_gateway_arn = aws_ec2_customergateway.example.arn
device_id = aws_networkmanager_device.example.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.GlobalNetwork;
import com.pulumi.aws.networkmanager.GlobalNetworkArgs;
import com.pulumi.aws.networkmanager.Site;
import com.pulumi.aws.networkmanager.SiteArgs;
import com.pulumi.aws.networkmanager.Device;
import com.pulumi.aws.networkmanager.DeviceArgs;
import com.pulumi.aws.ec2.CustomerGateway;
import com.pulumi.aws.ec2.CustomerGatewayArgs;
import com.pulumi.aws.ec2transitgateway.TransitGateway;
import com.pulumi.aws.ec2.VpnConnection;
import com.pulumi.aws.ec2.VpnConnectionArgs;
import com.pulumi.aws.networkmanager.TransitGatewayRegistration;
import com.pulumi.aws.networkmanager.TransitGatewayRegistrationArgs;
import com.pulumi.aws.networkmanager.CustomerGatewayAssociation;
import com.pulumi.aws.networkmanager.CustomerGatewayAssociationArgs;
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) {
var example = new GlobalNetwork("example", GlobalNetworkArgs.builder()
.description("example")
.build());
var exampleSite = new Site("exampleSite", SiteArgs.builder()
.globalNetworkId(example.id())
.build());
var exampleDevice = new Device("exampleDevice", DeviceArgs.builder()
.globalNetworkId(example.id())
.siteId(exampleSite.id())
.build());
var exampleCustomerGateway = new CustomerGateway("exampleCustomerGateway", CustomerGatewayArgs.builder()
.bgpAsn("65000")
.ipAddress("172.83.124.10")
.type("ipsec.1")
.build());
var exampleTransitGateway = new TransitGateway("exampleTransitGateway");
var exampleVpnConnection = new VpnConnection("exampleVpnConnection", VpnConnectionArgs.builder()
.customerGatewayId(exampleCustomerGateway.id())
.transitGatewayId(exampleTransitGateway.id())
.type(exampleCustomerGateway.type())
.staticRoutesOnly(true)
.build());
var exampleTransitGatewayRegistration = new TransitGatewayRegistration("exampleTransitGatewayRegistration", TransitGatewayRegistrationArgs.builder()
.globalNetworkId(example.id())
.transitGatewayArn(exampleTransitGateway.arn())
.build(), CustomResourceOptions.builder()
.dependsOn(exampleVpnConnection)
.build());
var exampleCustomerGatewayAssociation = new CustomerGatewayAssociation("exampleCustomerGatewayAssociation", CustomerGatewayAssociationArgs.builder()
.globalNetworkId(example.id())
.customerGatewayArn(exampleCustomerGateway.arn())
.deviceId(exampleDevice.id())
.build(), CustomResourceOptions.builder()
.dependsOn(exampleTransitGatewayRegistration)
.build());
}
}
resources:
example:
type: aws:networkmanager:GlobalNetwork
properties:
description: example
exampleSite:
type: aws:networkmanager:Site
name: example
properties:
globalNetworkId: ${example.id}
exampleDevice:
type: aws:networkmanager:Device
name: example
properties:
globalNetworkId: ${example.id}
siteId: ${exampleSite.id}
exampleCustomerGateway:
type: aws:ec2:CustomerGateway
name: example
properties:
bgpAsn: 65000
ipAddress: 172.83.124.10
type: ipsec.1
exampleTransitGateway:
type: aws:ec2transitgateway:TransitGateway
name: example
exampleVpnConnection:
type: aws:ec2:VpnConnection
name: example
properties:
customerGatewayId: ${exampleCustomerGateway.id}
transitGatewayId: ${exampleTransitGateway.id}
type: ${exampleCustomerGateway.type}
staticRoutesOnly: true
exampleTransitGatewayRegistration:
type: aws:networkmanager:TransitGatewayRegistration
name: example
properties:
globalNetworkId: ${example.id}
transitGatewayArn: ${exampleTransitGateway.arn}
options:
dependsOn:
- ${exampleVpnConnection}
exampleCustomerGatewayAssociation:
type: aws:networkmanager:CustomerGatewayAssociation
name: example
properties:
globalNetworkId: ${example.id}
customerGatewayArn: ${exampleCustomerGateway.arn}
deviceId: ${exampleDevice.id}
options:
dependsOn:
- ${exampleTransitGatewayRegistration}
Import
Using pulumi import, import aws.networkmanager.CustomerGatewayAssociation using the global network ID and customer gateway ARN. For example:
$ pulumi import aws:networkmanager/customerGatewayAssociation:CustomerGatewayAssociation example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-123abc05e04123abc
Constructors
- CustomerGatewayAssociation(String name, {CustomerGatewayAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new CustomerGatewayAssociation.
nameThe Pulumi resource name.argsArguments used to configure this CustomerGatewayAssociation. The set of arguments for CustomerGatewayAssociation.optionsResource options controlling this resource's behavior. - CustomerGatewayAssociation.reference(String urn)
- Creates a typed reference to an existing CustomerGatewayAssociation resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
customerGatewayArn
↔ Output<
String> -
ARN of the customer gateway.
latefinal
-
deviceId
↔ Output<
String> -
ID of the device.
latefinal
-
globalNetworkId
↔ Output<
String> -
ID of the global network.
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
-
linkId
↔ Output<
String?> -
ID of the link.
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
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, {CustomerGatewayAssociationState? state, CustomResourceOptions? options}) → CustomerGatewayAssociation -
Gets an existing CustomerGatewayAssociation resource's state with the given
nameandid.