VpcLink class

Provides an API Gateway VPC Link.

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

Example Usage

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

const example = new aws.lb.LoadBalancer("example", {
    subnetMappings: [{
        subnetId: "12345",
    }],
    name: "example",
    internal: true,
    loadBalancerType: "network",
});
const exampleVpcLink = new aws.apigateway.VpcLink("example", {
    name: "example",
    description: "example description",
    targetArn: example.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.lb.LoadBalancer("example",
    subnet_mappings=[{
        "subnet_id": "12345",
    }],
    name="example",
    internal=True,
    load_balancer_type="network")
example_vpc_link = aws.apigateway.VpcLink("example",
    name="example",
    description="example description",
    target_arn=example.arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.LB.LoadBalancer("example", new()
    {
        SubnetMappings = new[]
        {
            new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
            {
                SubnetId = "12345",
            },
        },
        Name = "example",
        Internal = true,
        LoadBalancerType = "network",
    });

    var exampleVpcLink = new Aws.ApiGateway.VpcLink("example", new()
    {
        Name = "example",
        Description = "example description",
        TargetArn = example.Arn,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := lb.NewLoadBalancer(ctx, "example", &lb.LoadBalancerArgs{
			SubnetMappings: lb.LoadBalancerSubnetMappingArray{
				&lb.LoadBalancerSubnetMappingArgs{
					SubnetId: pulumi.String("12345"),
				},
			},
			Name:             pulumi.String("example"),
			Internal:         pulumi.Bool(true),
			LoadBalancerType: pulumi.String("network"),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewVpcLink(ctx, "example", &apigateway.VpcLinkArgs{
			Name:        pulumi.String("example"),
			Description: pulumi.String("example description"),
			TargetArn:   example.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_lb_loadbalancer" "example" {
  subnet_mappings {
    subnet_id = "12345"
  }
  name               = "example"
  internal           = true
  load_balancer_type = "network"
}
resource "aws_apigateway_vpclink" "example" {
  name        = "example"
  description = "example description"
  target_arn  = aws_lb_loadbalancer.example.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.LoadBalancer;
import com.pulumi.aws.lb.LoadBalancerArgs;
import com.pulumi.aws.lb.inputs.LoadBalancerSubnetMappingArgs;
import com.pulumi.aws.apigateway.VpcLink;
import com.pulumi.aws.apigateway.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 LoadBalancer("example", LoadBalancerArgs.builder()
            .subnetMappings(LoadBalancerSubnetMappingArgs.builder()
                .subnetId("12345")
                .build())
            .name("example")
            .internal(true)
            .loadBalancerType("network")
            .build());

        var exampleVpcLink = new VpcLink("exampleVpcLink", VpcLinkArgs.builder()
            .name("example")
            .description("example description")
            .targetArn(example.arn())
            .build());

    }
}
resources:
  example:
    type: aws:lb:LoadBalancer
    properties:
      subnetMappings:
        - subnetId: '12345'
      name: example
      internal: true
      loadBalancerType: network
  exampleVpcLink:
    type: aws:apigateway:VpcLink
    name: example
    properties:
      name: example
      description: example description
      targetArn: ${example.arn}

Import

Using pulumi import, import API Gateway VPC Link using the id. For example:

$ pulumi import aws:apigateway/vpcLink:VpcLink example 12345abcde

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>
ARN of the VPC link.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
Description of the VPC link.
latefinal
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 used to label and identify the VPC link.
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
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. 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
targetArn ↔ Output<String>
List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
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.