VpcLinkArgs

data class VpcLinkArgs(val name: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<VpcLinkArgs>

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&#46;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/v6/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
})
}
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.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) {
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_vpc_link using the VPC Link identifier. For example:

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

Constructors

Link copied to clipboard
constructor(name: Output<String>? = null, securityGroupIds: Output<List<String>>? = null, subnetIds: Output<List<String>>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val name: Output<String>? = null

Name of the VPC Link. Must be between 1 and 128 characters in length.

Link copied to clipboard
val securityGroupIds: Output<List<String>>? = null

Security group IDs for the VPC Link.

Link copied to clipboard
val subnetIds: Output<List<String>>? = null

Subnet IDs for the VPC Link.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Map of tags to assign to the VPC Link. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Functions

Link copied to clipboard
open override fun toJava(): VpcLinkArgs