VpcLink class

Manages an Amazon API Gateway Version 2 VPC Link.

> Note: Amazon API Gateway Version 2 VPC Links enable private integrations that connect HTTP APIs to private resources in a VPC. To enable private integration for REST APIs, use the Amazon API Gateway Version 1 VPC Link resource.

Example Usage

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

const example = new aws.apigatewayv2.VpcLink("example", {
    name: "example",
    securityGroupIds: [exampleAwsSecurityGroup.id],
    subnetIds: exampleAwsSubnets.ids,
    tags: {
        Usage: "example",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.VpcLink("example",
    name="example",
    security_group_ids=[example_aws_security_group["id"]],
    subnet_ids=example_aws_subnets["ids"],
    tags={
        "Usage": "example",
    })
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.ApiGatewayV2.VpcLink("example", new()
    {
        Name = "example",
        SecurityGroupIds = new[]
        {
            exampleAwsSecurityGroup.Id,
        },
        SubnetIds = exampleAwsSubnets.Ids,
        Tags =
        {
            { "Usage", "example" },
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigatewayv2.NewVpcLink(ctx, "example", &apigatewayv2.VpcLinkArgs{
			Name: pulumi.String("example"),
			SecurityGroupIds: pulumi.StringArray{
				exampleAwsSecurityGroup.Id,
			},
			SubnetIds: pulumi.Any(exampleAwsSubnets.Ids),
			Tags: pulumi.StringMap{
				"Usage": pulumi.String("example"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_apigatewayv2_vpclink" "example" {
  name               = "example"
  security_group_ids = [exampleAwsSecurityGroup.id]
  subnet_ids         = exampleAwsSubnets.ids
  tags = {
    "Usage" = "example"
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.VpcLink;
import com.pulumi.aws.apigatewayv2.VpcLinkArgs;
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 VpcLink("example", VpcLinkArgs.builder()
            .name("example")
            .securityGroupIds(exampleAwsSecurityGroup.id())
            .subnetIds(exampleAwsSubnets.ids())
            .tags(Map.of("Usage", "example"))
            .build());

    }
}
resources:
  example:
    type: aws:apigatewayv2:VpcLink
    properties:
      name: example
      securityGroupIds:
        - ${exampleAwsSecurityGroup.id}
      subnetIds: ${exampleAwsSubnets.ids}
      tags:
        Usage: example

Import

Using pulumi import, import aws.apigatewayv2.VpcLink using the VPC Link identifier. For example:

$ pulumi import aws:apigatewayv2/vpcLink:VpcLink example aabbccddee

Constructors

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

Properties

arn ↔ Output<String>
VPC Link ARN.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
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
name ↔ Output<String>
Name of the VPC Link. Must be between 1 and 128 characters in length.
latefinal
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
securityGroupIds ↔ Output<List<String>>
Security group IDs for the VPC Link.
latefinal
subnetIds ↔ Output<List<String>>
Subnet IDs for the VPC Link.
latefinal
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the VPC Link. 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>>
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
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, {VpcLinkState? state, CustomResourceOptions? options}) → VpcLink
Gets an existing VpcLink resource's state with the given name and id.