Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  5. VpcLink

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigateway.VpcLink

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see vpclink:create in the Amazon API Gateway REST API Reference.

    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,
            target_arns: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = 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:apigateway:VpcLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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

    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:

    TargetArns List<string>
    The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
    Description string
    The description of the VPC link.
    Name string
    The name used to label and identify the VPC link.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    TargetArns []string
    The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
    Description string
    The description of the VPC link.
    Name string
    The name used to label and identify the VPC link.
    Tags TagArgs
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    targetArns List<String>
    The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
    description String
    The description of the VPC link.
    name String
    The name used to label and identify the VPC link.
    tags List<Tag>
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    targetArns string[]
    The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
    description string
    The description of the VPC link.
    name string
    The name used to label and identify the VPC link.
    tags Tag[]
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    target_arns Sequence[str]
    The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
    description str
    The description of the VPC link.
    name str
    The name used to label and identify the VPC link.
    tags Sequence[TagArgs]
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    targetArns List<String>
    The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
    description String
    The description of the VPC link.
    name String
    The name used to label and identify the VPC link.
    tags List<Property Map>
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcLink resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    VpcLinkId string
    The ID for the VPC link. For example: abc123 .
    Id string
    The provider-assigned unique ID for this managed resource.
    VpcLinkId string
    The ID for the VPC link. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.
    vpcLinkId String
    The ID for the VPC link. For example: abc123 .
    id string
    The provider-assigned unique ID for this managed resource.
    vpcLinkId string
    The ID for the VPC link. For example: abc123 .
    id str
    The provider-assigned unique ID for this managed resource.
    vpc_link_id str
    The ID for the VPC link. For example: abc123 .
    id String
    The provider-assigned unique ID for this managed resource.
    vpcLinkId String
    The ID for the VPC link. For example: abc123 .

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native