Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. apigatewayv2
  5. VpcLink

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.apigatewayv2.VpcLink

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    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",
    })

    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
	})
}

    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 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

    Create VpcLink Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpcLink(name: string, args: VpcLinkArgs, opts?: CustomResourceOptions);
    @overload
def VpcLink(resource_name: str,
            args: VpcLinkArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def VpcLink(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            security_group_ids: Optional[Sequence[str]] = None,
            subnet_ids: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewVpcLink(ctx *Context, name string, args VpcLinkArgs, opts ...ResourceOption) (*VpcLink, error)
    public VpcLink(string name, VpcLinkArgs args, CustomResourceOptions? opts = null)
    public VpcLink(String name, VpcLinkArgs args)
public VpcLink(String name, VpcLinkArgs args, CustomResourceOptions options)

    type: aws:apigatewayv2:VpcLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsVpcLinkResource = new Aws.ApiGatewayV2.VpcLink("awsVpcLinkResource", new()
{
    SecurityGroupIds = new[]
    {
        "string",
    },
    SubnetIds = new[]
    {
        "string",
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := apigatewayv2.NewVpcLink(ctx, "awsVpcLinkResource", &apigatewayv2.VpcLinkArgs{
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var awsVpcLinkResource = new VpcLink("awsVpcLinkResource", VpcLinkArgs.builder()
    .securityGroupIds("string")
    .subnetIds("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    aws_vpc_link_resource = aws.apigatewayv2.VpcLink("awsVpcLinkResource",
    security_group_ids=["string"],
    subnet_ids=["string"],
    name="string",
    tags={
        "string": "string",
    })

    const awsVpcLinkResource = new aws.apigatewayv2.VpcLink("awsVpcLinkResource", {
    securityGroupIds: ["string"],
    subnetIds: ["string"],
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:apigatewayv2:VpcLink
properties:
    name: string
    securityGroupIds:
        - string
    subnetIds:
        - string
    tags:
        string: string

    VpcLink Resource Properties

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

    Inputs

    The VpcLink resource accepts the following input properties:

    SecurityGroupIds List<string>
    Security group IDs for the VPC Link.
    SubnetIds List<string>
    Subnet IDs for the VPC Link.
    Name string
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    Tags Dictionary<string, string>
    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.
    SecurityGroupIds []string
    Security group IDs for the VPC Link.
    SubnetIds []string
    Subnet IDs for the VPC Link.
    Name string
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    Tags map[string]string
    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.
    securityGroupIds List<String>
    Security group IDs for the VPC Link.
    subnetIds List<String>
    Subnet IDs for the VPC Link.
    name String
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    tags Map<String,String>
    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.
    securityGroupIds string[]
    Security group IDs for the VPC Link.
    subnetIds string[]
    Subnet IDs for the VPC Link.
    name string
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    tags {[key: string]: string}
    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.
    security_group_ids Sequence[str]
    Security group IDs for the VPC Link.
    subnet_ids Sequence[str]
    Subnet IDs for the VPC Link.
    name str
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    tags Mapping[str, str]
    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.
    securityGroupIds List<String>
    Security group IDs for the VPC Link.
    subnetIds List<String>
    Subnet IDs for the VPC Link.
    name String
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    tags Map<String>
    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.

    Outputs

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

    Arn string
    VPC Link ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    VPC Link ARN.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    VPC Link ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    VPC Link ARN.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    VPC Link ARN.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    VPC Link ARN.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing VpcLink Resource

    Get an existing VpcLink 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?: VpcLinkState, opts?: CustomResourceOptions): VpcLink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        name: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        subnet_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> VpcLink
    func GetVpcLink(ctx *Context, name string, id IDInput, state *VpcLinkState, opts ...ResourceOption) (*VpcLink, error)
    public static VpcLink Get(string name, Input<string> id, VpcLinkState? state, CustomResourceOptions? opts = null)
    public static VpcLink get(String name, Output<String> id, VpcLinkState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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
    VPC Link ARN.
    Name string
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    SecurityGroupIds List<string>
    Security group IDs for the VPC Link.
    SubnetIds List<string>
    Subnet IDs for the VPC Link.
    Tags Dictionary<string, string>
    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.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    VPC Link ARN.
    Name string
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    SecurityGroupIds []string
    Security group IDs for the VPC Link.
    SubnetIds []string
    Subnet IDs for the VPC Link.
    Tags map[string]string
    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.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    VPC Link ARN.
    name String
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    securityGroupIds List<String>
    Security group IDs for the VPC Link.
    subnetIds List<String>
    Subnet IDs for the VPC Link.
    tags Map<String,String>
    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.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    VPC Link ARN.
    name string
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    securityGroupIds string[]
    Security group IDs for the VPC Link.
    subnetIds string[]
    Subnet IDs for the VPC Link.
    tags {[key: string]: string}
    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.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    VPC Link ARN.
    name str
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    security_group_ids Sequence[str]
    Security group IDs for the VPC Link.
    subnet_ids Sequence[str]
    Subnet IDs for the VPC Link.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    VPC Link ARN.
    name String
    Name of the VPC Link. Must be between 1 and 128 characters in length.
    securityGroupIds List<String>
    Security group IDs for the VPC Link.
    subnetIds List<String>
    Subnet IDs for the VPC Link.
    tags Map<String>
    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.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import aws_apigatewayv2_vpc_link using the VPC Link identifier. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws