CustomerGateway class

Provides a customer gateway inside a VPC. These objects can be connected to VPN gateways via VPN connections, and allow you to establish tunnels between your network and the VPC.

Example Usage

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

const main = new aws.ec2.CustomerGateway("main", {
    bgpAsn: "65000",
    ipAddress: "172.83.124.10",
    type: "ipsec.1",
    tags: {
        Name: "main-customer-gateway",
    },
});
import pulumi
import pulumi_aws as aws

main = aws.ec2.CustomerGateway("main",
    bgp_asn="65000",
    ip_address="172.83.124.10",
    type="ipsec.1",
    tags={
        "Name": "main-customer-gateway",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var main = new Aws.Ec2.CustomerGateway("main", new()
    {
        BgpAsn = "65000",
        IpAddress = "172.83.124.10",
        Type = "ipsec.1",
        Tags =
        {
            { "Name", "main-customer-gateway" },
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.NewCustomerGateway(ctx, "main", &ec2.CustomerGatewayArgs{
			BgpAsn:    pulumi.String("65000"),
			IpAddress: pulumi.String("172.83.124.10"),
			Type:      pulumi.String("ipsec.1"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("main-customer-gateway"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ec2_customergateway" "main" {
  bgp_asn    = 65000
  ip_address = "172.83.124.10"
  type       = "ipsec.1"
  tags = {
    "Name" = "main-customer-gateway"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.CustomerGateway;
import com.pulumi.aws.ec2.CustomerGatewayArgs;
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 main = new CustomerGateway("main", CustomerGatewayArgs.builder()
            .bgpAsn("65000")
            .ipAddress("172.83.124.10")
            .type("ipsec.1")
            .tags(Map.of("Name", "main-customer-gateway"))
            .build());

    }
}
resources:
  main:
    type: aws:ec2:CustomerGateway
    properties:
      bgpAsn: 65000
      ipAddress: 172.83.124.10
      type: ipsec.1
      tags:
        Name: main-customer-gateway

Import

Using pulumi import, import Customer Gateways using the id. For example:

$ pulumi import aws:ec2/customerGateway:CustomerGateway main cgw-b4dc3961

Constructors

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

Properties

arn ↔ Output<String>
The ARN of the customer gateway.
latefinal
bgpAsn ↔ Output<String?>
The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values are from 1 to 2147483647. Conflicts with bgpAsnExtended.
latefinal
bgpAsnExtended ↔ Output<String?>
The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values are from 2147483648 to 4294967295 Conflicts with bgpAsn.
latefinal
certificateArn ↔ Output<String?>
ARN for the customer gateway certificate.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
deviceName ↔ Output<String?>
A name for the customer gateway device.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
ipAddress ↔ Output<String?>
The IPv4 address for the customer gateway device's outside interface.
latefinal
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
tags ↔ Output<Map<String, String>?>
Tags to apply to the gateway. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String>
The type of customer gateway. The only type AWS supports at this time is "ipsec.1".
latefinal
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, {CustomerGatewayState? state, CustomResourceOptions? options}) → CustomerGateway
Gets an existing CustomerGateway resource's state with the given name and id.