Try AWS Native preview for resources not in the classic version.
aws.apigateway.VpcLink
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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
Coming soon!
Coming soon!
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());
}
}
Coming soon!
Coming soon!
resources:
exampleLoadBalancer:
type: aws:lb:LoadBalancer
properties:
internal: true
loadBalancerType: network
subnetMappings:
- subnetId: '12345'
exampleVpcLink:
type: aws:apigateway:VpcLink
properties:
description: example description
targetArn:
- ${exampleLoadBalancer.arn}
Create VpcLink Resource
new VpcLink(name: string, args: VpcLinkArgs, opts?: CustomResourceOptions);
@overload
def VpcLink(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
target_arn: Optional[str] = None)
@overload
def VpcLink(resource_name: str,
args: VpcLinkArgs,
opts: Optional[ResourceOptions] = 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:apigateway:VpcLink
properties: # The arguments to resource properties.
options: # 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.
- 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.
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:
- Target
Arn string List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- Description string
Description of the VPC link.
- Name string
Name used to label and identify the VPC link.
- Dictionary<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.
- Target
Arn string List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- Description string
Description of the VPC link.
- Name string
Name used to label and identify the VPC link.
- 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.
- target
Arn String List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- description String
Description of the VPC link.
- name String
Name used to label and identify the VPC link.
- 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.
- target
Arn string List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- description string
Description of the VPC link.
- name string
Name used to label and identify the VPC link.
- {[key: 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.
- target_
arn str List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- description str
Description of the VPC link.
- name str
Name used to label and identify the VPC link.
- Mapping[str, str]
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.
- target
Arn String List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- description String
Description of the VPC link.
- name String
Name used to label and identify the VPC link.
- Map<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.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpcLink resource produces the following output properties:
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,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
target_arn: Optional[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.
- Arn string
- Description string
Description of the VPC link.
- Name string
Name used to label and identify the VPC link.
- Dictionary<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.- Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Target
Arn string List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- Arn string
- Description string
Description of the VPC link.
- Name string
Name used to label and identify the VPC link.
- 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.- map[string]string
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- Target
Arn string List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- arn String
- description String
Description of the VPC link.
- name String
Name used to label and identify the VPC link.
- 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.- Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- target
Arn String List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- arn string
- description string
Description of the VPC link.
- name string
Name used to label and identify the VPC link.
- {[key: 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.- {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- target
Arn string List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- arn str
- description str
Description of the VPC link.
- name str
Name used to label and identify the VPC link.
- Mapping[str, str]
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.- Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- target_
arn str List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
- arn String
- description String
Description of the VPC link.
- name String
Name used to label and identify the VPC link.
- Map<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.- Map<String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.- target
Arn String List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
Import
Using pulumi import
, import API Gateway VPC Link using the id
. For example:
$ pulumi import aws:apigateway/vpcLink:VpcLink example 12345abcde
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.