VpcLink

class VpcLink : KotlinCustomResource

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

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 exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()
.internal(true)
.loadBalancerType("network")
.subnetMappings(LoadBalancerSubnetMappingArgs.builder()
.subnetId("12345")
.build())
.build());
var exampleVpcLink = new VpcLink("exampleVpcLink", VpcLinkArgs.builder()
.description("example description")
.targetArn(exampleLoadBalancer.arn())
.build());
}
}

Import

API Gateway VPC Link can be imported using the id, e.g.,

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

Properties

Link copied to clipboard
val arn: Output<String>
Link copied to clipboard
val description: Output<String>?

Description of the VPC link.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

Name used to label and identify the VPC link.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val tags: Output<Map<String, String>>?

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val targetArn: Output<String>

List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.

Link copied to clipboard
val urn: Output<String>