getCustomerGateway function

Future<GetCustomerGatewayResult> getCustomerGateway(
  1. GetCustomerGatewayArgs args, {
  2. InvokeOptions? options,
})

Get an existing AWS Customer Gateway.

Example Usage

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

const foo = aws.ec2.getCustomerGateway({
    filters: [{
        name: "tag:Name",
        values: ["foo-prod"],
    }],
});
const main = new aws.ec2.VpnGateway("main", {
    vpcId: mainAwsVpc.id,
    amazonSideAsn: "7224",
});
const transit = new aws.ec2.VpnConnection("transit", {
    vpnGatewayId: main.id,
    customerGatewayId: foo.then(foo => foo.id),
    type: foo.then(foo => foo.type),
    staticRoutesOnly: false,
});
import pulumi
import pulumi_aws as aws

foo = aws.ec2.get_customer_gateway(filters=[{
    "name": "tag:Name",
    "values": ["foo-prod"],
}])
main = aws.ec2.VpnGateway("main",
    vpc_id=main_aws_vpc["id"],
    amazon_side_asn="7224")
transit = aws.ec2.VpnConnection("transit",
    vpn_gateway_id=main.id,
    customer_gateway_id=foo.id,
    type=foo.type,
    static_routes_only=False)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var foo = Aws.Ec2.GetCustomerGateway.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2.Inputs.GetCustomerGatewayFilterInputArgs
            {
                Name = "tag:Name",
                Values = new[]
                {
                    "foo-prod",
                },
            },
        },
    });

    var main = new Aws.Ec2.VpnGateway("main", new()
    {
        VpcId = mainAwsVpc.Id,
        AmazonSideAsn = "7224",
    });

    var transit = new Aws.Ec2.VpnConnection("transit", new()
    {
        VpnGatewayId = main.Id,
        CustomerGatewayId = foo.Apply(getCustomerGatewayResult => getCustomerGatewayResult.Id),
        Type = foo.Apply(getCustomerGatewayResult => getCustomerGatewayResult.Type),
        StaticRoutesOnly = false,
    });

});
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 {
		foo, err := ec2.LookupCustomerGateway(ctx, &ec2.LookupCustomerGatewayArgs{
			Filters: []ec2.GetCustomerGatewayFilter{
				{
					Name: "tag:Name",
					Values: []string{
						"foo-prod",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		main, err := ec2.NewVpnGateway(ctx, "main", &ec2.VpnGatewayArgs{
			VpcId:         pulumi.Any(mainAwsVpc.Id),
			AmazonSideAsn: pulumi.String("7224"),
		})
		if err != nil {
			return err
		}
		_, err = ec2.NewVpnConnection(ctx, "transit", &ec2.VpnConnectionArgs{
			VpnGatewayId:      main.ID().ToIDOutput().ToStringOutput(),
			CustomerGatewayId: pulumi.String(foo.Id),
			Type:              pulumi.String(foo.Type),
			StaticRoutesOnly:  pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_ec2_getcustomergateway" "foo" {
  filters {
    name   = "tag:Name"
    values = ["foo-prod"]
  }
}

resource "aws_ec2_vpngateway" "main" {
  vpc_id          = mainAwsVpc.id
  amazon_side_asn = 7224
}
resource "aws_ec2_vpnconnection" "transit" {
  vpn_gateway_id      = aws_ec2_vpngateway.main.id
  customer_gateway_id = data.aws_ec2_getcustomergateway.foo.id
  type                = data.aws_ec2_getcustomergateway.foo.type
  static_routes_only  = false
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetCustomerGatewayArgs;
import com.pulumi.aws.ec2.inputs.GetCustomerGatewayFilterArgs;
import com.pulumi.aws.ec2.VpnGateway;
import com.pulumi.aws.ec2.VpnGatewayArgs;
import com.pulumi.aws.ec2.VpnConnection;
import com.pulumi.aws.ec2.VpnConnectionArgs;
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 foo = Ec2Functions.getCustomerGateway(GetCustomerGatewayArgs.builder()
            .filters(GetCustomerGatewayFilterArgs.builder()
                .name("tag:Name")
                .values("foo-prod")
                .build())
            .build());

        var main = new VpnGateway("main", VpnGatewayArgs.builder()
            .vpcId(mainAwsVpc.id())
            .amazonSideAsn("7224")
            .build());

        var transit = new VpnConnection("transit", VpnConnectionArgs.builder()
            .vpnGatewayId(main.id())
            .customerGatewayId(foo.id())
            .type(foo.type())
            .staticRoutesOnly(false)
            .build());

    }
}
resources:
  main:
    type: aws:ec2:VpnGateway
    properties:
      vpcId: ${mainAwsVpc.id}
      amazonSideAsn: 7224
  transit:
    type: aws:ec2:VpnConnection
    properties:
      vpnGatewayId: ${main.id}
      customerGatewayId: ${foo.id}
      type: ${foo.type}
      staticRoutesOnly: false
variables:
  foo:
    fn::invoke:
      function: aws:ec2:getCustomerGateway
      arguments:
        filters:
          - name: tag:Name
            values:
              - foo-prod

args Arguments passed to this invoke. Arguments for getCustomerGateway. options Invoke options controlling this call.

Implementation

Future<GetCustomerGatewayResult> getCustomerGateway(
  GetCustomerGatewayArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:ec2/getCustomerGateway:getCustomerGateway',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetCustomerGatewayResult.fromMap(result);
}