Vpc Link Args
data class VpcLinkArgs(val description: Output<String>? = null, val name: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val targetArn: Output<String>? = null) : ConvertibleToJava<VpcLinkArgs>
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", {
name: "example",
internal: true,
loadBalancerType: "network",
subnetMappings: [{
subnetId: "12345",
}],
});
const exampleVpcLink = new aws.apigateway.VpcLink("example", {
name: "example",
description: "example description",
targetArn: example.arn,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.lb.LoadBalancer("example",
name="example",
internal=True,
load_balancer_type="network",
subnet_mappings=[{
"subnet_id": "12345",
}])
example_vpc_link = aws.apigateway.VpcLink("example",
name="example",
description="example description",
target_arn=example.arn)
Content copied to clipboard
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()
{
Name = "example",
Internal = true,
LoadBalancerType = "network",
SubnetMappings = new[]
{
new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
{
SubnetId = "12345",
},
},
});
var exampleVpcLink = new Aws.ApiGateway.VpcLink("example", new()
{
Name = "example",
Description = "example description",
TargetArn = example.Arn,
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
"github.com/pulumi/pulumi-aws/sdk/v6/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{
Name: pulumi.String("example"),
Internal: pulumi.Bool(true),
LoadBalancerType: pulumi.String("network"),
SubnetMappings: lb.LoadBalancerSubnetMappingArray{
&lb.LoadBalancerSubnetMappingArgs{
SubnetId: pulumi.String("12345"),
},
},
})
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
})
}
Content copied to clipboard
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.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 LoadBalancer("example", LoadBalancerArgs.builder()
.name("example")
.internal(true)
.loadBalancerType("network")
.subnetMappings(LoadBalancerSubnetMappingArgs.builder()
.subnetId("12345")
.build())
.build());
var exampleVpcLink = new VpcLink("exampleVpcLink", VpcLinkArgs.builder()
.name("example")
.description("example description")
.targetArn(example.arn())
.build());
}
}
Content copied to clipboard
resources:
example:
type: aws:lb:LoadBalancer
properties:
name: example
internal: true
loadBalancerType: network
subnetMappings:
- subnetId: '12345'
exampleVpcLink:
type: aws:apigateway:VpcLink
name: example
properties:
name: example
description: example description
targetArn: ${example.arn}
Content copied to clipboard
Import
Using pulumi import
, import API Gateway VPC Link using the id
. For example:
$ pulumi import aws:apigateway/vpcLink:VpcLink example 12345abcde
Content copied to clipboard