pulumi-aws-kotlin/com.pulumi.aws.ec2transitgateway.kotlin/Ec2transitgatewayFunctions/getVpnAttachment

getVpnAttachment

suspend fun getVpnAttachment(argument: GetVpnAttachmentPlainArgs): GetVpnAttachmentResult

Get information on an EC2 Transit Gateway VPN Attachment.

EC2 Transit Gateway VPN Attachments are implicitly created by VPN Connections referencing an EC2 Transit Gateway so there is no managed resource. For ease, the aws.ec2.VpnConnection resource includes a transit_gateway_attachment_id attribute which can replace some usage of this data source. For tagging the attachment, see the aws.ec2.Tag resource.

Example Usage

By Transit Gateway and VPN Connection Identifiers

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.ec2transitgateway.getVpnAttachment({
    transitGatewayId: exampleAwsEc2TransitGateway.id,
    vpnConnectionId: exampleAwsVpnConnection.id,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.ec2transitgateway.get_vpn_attachment(transit_gateway_id=example_aws_ec2_transit_gateway["id"],
    vpn_connection_id=example_aws_vpn_connection["id"])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.Ec2TransitGateway.GetVpnAttachment.Invoke(new()
    {
        TransitGatewayId = exampleAwsEc2TransitGateway.Id,
        VpnConnectionId = exampleAwsVpnConnection.Id,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2transitgateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2transitgateway.GetVpnAttachment(ctx, &ec2transitgateway.GetVpnAttachmentArgs{
			TransitGatewayId: pulumi.StringRef(exampleAwsEc2TransitGateway.Id),
			VpnConnectionId:  pulumi.StringRef(exampleAwsVpnConnection.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.Ec2transitgatewayFunctions;
import com.pulumi.aws.ec2transitgateway.inputs.GetVpnAttachmentArgs;
import java.util.List;
import java.util.ArrayList;
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 example = Ec2transitgatewayFunctions.getVpnAttachment(GetVpnAttachmentArgs.builder()
            .transitGatewayId(exampleAwsEc2TransitGateway.id())
            .vpnConnectionId(exampleAwsVpnConnection.id())
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:ec2transitgateway:getVpnAttachment
      arguments:
        transitGatewayId: ${exampleAwsEc2TransitGateway.id}
        vpnConnectionId: ${exampleAwsVpnConnection.id}
Content copied to clipboard

Filter

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = aws.ec2transitgateway.getVpnAttachment({
    filters: [{
        name: "resource-id",
        values: ["some-resource"],
    }],
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
test = aws.ec2transitgateway.get_vpn_attachment(filters=[{
    "name": "resource-id",
    "values": ["some-resource"],
}])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var test = Aws.Ec2TransitGateway.GetVpnAttachment.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Ec2TransitGateway.Inputs.GetVpnAttachmentFilterInputArgs
            {
                Name = "resource-id",
                Values = new[]
                {
                    "some-resource",
                },
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2transitgateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2transitgateway.GetVpnAttachment(ctx, &ec2transitgateway.GetVpnAttachmentArgs{
			Filters: []ec2transitgateway.GetVpnAttachmentFilter{
				{
					Name: "resource-id",
					Values: []string{
						"some-resource",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.Ec2transitgatewayFunctions;
import com.pulumi.aws.ec2transitgateway.inputs.GetVpnAttachmentArgs;
import java.util.List;
import java.util.ArrayList;
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 test = Ec2transitgatewayFunctions.getVpnAttachment(GetVpnAttachmentArgs.builder()
            .filters(GetVpnAttachmentFilterArgs.builder()
                .name("resource-id")
                .values("some-resource")
                .build())
            .build());
    }
}
Content copied to clipboard
variables:
  test:
    fn::invoke:
      function: aws:ec2transitgateway:getVpnAttachment
      arguments:
        filters:
          - name: resource-id
            values:
              - some-resource
Content copied to clipboard

Return

A collection of values returned by getVpnAttachment.

Parameters

argument

A collection of arguments for invoking getVpnAttachment.

suspend fun getVpnAttachment(filters: List<GetVpnAttachmentFilter>? = null, tags: Map<String, String>? = null, transitGatewayId: String? = null, vpnConnectionId: String? = null): GetVpnAttachmentResult

Return

A collection of values returned by getVpnAttachment.

Parameters

filters

Configuration block(s) for filtering. Detailed below.

tags

Map of tags, each pair of which must exactly match a pair on the desired Transit Gateway VPN Attachment.

transitGatewayId

Identifier of the EC2 Transit Gateway.

vpnConnectionId

Identifier of the EC2 VPN Connection.

See also

.

suspend fun getVpnAttachment(argument: suspend GetVpnAttachmentPlainArgsBuilder.() -> Unit): GetVpnAttachmentResult

Return

A collection of values returned by getVpnAttachment.

Parameters

argument

Builder for com.pulumi.aws.ec2transitgateway.kotlin.inputs.GetVpnAttachmentPlainArgs.

See also

.