CustomerGateway

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var main = new Aws.Ec2.CustomerGateway("main", new Aws.Ec2.CustomerGatewayArgs
        {
            BgpAsn = "65000",
            IpAddress = "172.83.124.10",
            Tags = 
            {
                { "Name", "main-customer-gateway" },
            },
            Type = "ipsec.1",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/ec2"
    "github.com/pulumi/pulumi/sdk/v2/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"),
            Tags: pulumi.StringMap{
                "Name": pulumi.String("main-customer-gateway"),
            },
            Type: pulumi.String("ipsec.1"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

main = aws.ec2.CustomerGateway("main",
    bgp_asn=65000,
    ip_address="172.83.124.10",
    tags={
        "Name": "main-customer-gateway",
    },
    type="ipsec.1")

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",
    tags: {
        Name: "main-customer-gateway",
    },
    type: "ipsec.1",
});

Create a CustomerGateway Resource

new CustomerGateway(name: string, args: CustomerGatewayArgs, opts?: CustomResourceOptions);

def CustomerGateway(resource_name, opts=None, bgp_asn=None, ip_address=None, tags=None, type=None, __props__=None);

func NewCustomerGateway(ctx *Context, name string, args CustomerGatewayArgs, opts ...ResourceOption) (*CustomerGateway, error)

public CustomerGateway(string name, CustomerGatewayArgs args, CustomResourceOptions? opts = null)

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

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

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

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

CustomerGateway Resource Properties

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

Inputs

The CustomerGateway resource accepts the following input properties:

BgpAsn string: The gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
IpAddress string: The IP address of the gateway’s Internet-routable external interface.
Type string: The type of customer gateway. The only type AWS supports at this time is “ipsec.1”.
Tags Dictionary<string, string>: Tags to apply to the gateway.

BgpAsn string: The gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
IpAddress string: The IP address of the gateway’s Internet-routable external interface.
Type string: The type of customer gateway. The only type AWS supports at this time is “ipsec.1”.
Tags map[string]string: Tags to apply to the gateway.

bgpAsn string: The gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
ipAddress string: The IP address of the gateway’s Internet-routable external interface.
type string: The type of customer gateway. The only type AWS supports at this time is “ipsec.1”.
tags {[key: string]: string}: Tags to apply to the gateway.

bgp_asn str: The gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
ip_address str: The IP address of the gateway’s Internet-routable external interface.
type str: The type of customer gateway. The only type AWS supports at this time is “ipsec.1”.
tags Dict[str, str]: Tags to apply to the gateway.

Outputs

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

Arn string: The ARN of the customer gateway.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The ARN of the customer gateway.
Id string: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the customer gateway.
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the customer gateway.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing CustomerGateway Resource

Get an existing CustomerGateway 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?: CustomerGatewayState, opts?: CustomResourceOptions): CustomerGateway

static get(resource_name, id, opts=None, arn=None, bgp_asn=None, ip_address=None, tags=None, type=None, __props__=None);

func GetCustomerGateway(ctx *Context, name string, id IDInput, state *CustomerGatewayState, opts ...ResourceOption) (*CustomerGateway, error)

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

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.

The following state arguments are supported:

Arn string: The ARN of the customer gateway.
BgpAsn string: The gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
IpAddress string: The IP address of the gateway’s Internet-routable external interface.
Tags Dictionary<string, string>: Tags to apply to the gateway.
Type string: The type of customer gateway. The only type AWS supports at this time is “ipsec.1”.

Arn string: The ARN of the customer gateway.
BgpAsn string: The gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
IpAddress string: The IP address of the gateway’s Internet-routable external interface.
Tags map[string]string: Tags to apply to the gateway.
Type string: The type of customer gateway. The only type AWS supports at this time is “ipsec.1”.

arn string: The ARN of the customer gateway.
bgpAsn string: The gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
ipAddress string: The IP address of the gateway’s Internet-routable external interface.
tags {[key: string]: string}: Tags to apply to the gateway.
type string: The type of customer gateway. The only type AWS supports at this time is “ipsec.1”.

arn str: The ARN of the customer gateway.
bgp_asn str: The gateway’s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
ip_address str: The IP address of the gateway’s Internet-routable external interface.
tags Dict[str, str]: Tags to apply to the gateway.
type str: The type of customer gateway. The only type AWS supports at this time is “ipsec.1”.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud