Docs Home
We recommend new projects start with resources from the AWS provider.
aws-native.apigatewayv2.VpcLink
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
The AWS::ApiGatewayV2::VpcLink resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from PENDING to AVAILABLE to successfully create a VPC link, which can take up to 10 minutes. To learn more, see Working with VPC Links for HTTP APIs in the API Gateway Developer Guide.
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,
subnet_ids: Optional[Sequence[str]] = None,
name: Optional[str] = None,
security_group_ids: Optional[Sequence[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-native:apigatewayv2:VpcLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. VpcLinkArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. VpcLinkArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. VpcLinkArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The VpcLink resource accepts the following input properties:
- Subnet
Ids This property is required. List<string> - A list of subnet IDs to include in the VPC link.
- Name string
- The name of the VPC link.
- Security
Group List<string>Ids - A list of security group IDs for the VPC link.
- Dictionary<string, string>
- The collection of tags. Each tag element is associated with a given resource.
- Subnet
Ids This property is required. []string - A list of subnet IDs to include in the VPC link.
- Name string
- The name of the VPC link.
- Security
Group []stringIds - A list of security group IDs for the VPC link.
- map[string]string
- The collection of tags. Each tag element is associated with a given resource.
- subnet
Ids This property is required. List<String> - A list of subnet IDs to include in the VPC link.
- name String
- The name of the VPC link.
- security
Group List<String>Ids - A list of security group IDs for the VPC link.
- Map<String,String>
- The collection of tags. Each tag element is associated with a given resource.
- subnet
Ids This property is required. string[] - A list of subnet IDs to include in the VPC link.
- name string
- The name of the VPC link.
- security
Group string[]Ids - A list of security group IDs for the VPC link.
- {[key: string]: string}
- The collection of tags. Each tag element is associated with a given resource.
- subnet_
ids This property is required. Sequence[str] - A list of subnet IDs to include in the VPC link.
- name str
- The name of the VPC link.
- security_
group_ Sequence[str]ids - A list of security group IDs for the VPC link.
- Mapping[str, str]
- The collection of tags. Each tag element is associated with a given resource.
- subnet
Ids This property is required. List<String> - A list of subnet IDs to include in the VPC link.
- name String
- The name of the VPC link.
- security
Group List<String>Ids - A list of security group IDs for the VPC link.
- Map<String>
- The collection of tags. Each tag element is associated with a given resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the VpcLink resource produces the following output properties:
- id str
- The provider-assigned unique ID for this managed resource.
- vpc_
link_ strid - The VPC link ID.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.