@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
72 lines (71 loc) • 3.09 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* 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](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in the ``Amazon API Gateway REST API Reference``.
*/
export declare class VpcLink extends pulumi.CustomResource {
/**
* Get an existing VpcLink resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): VpcLink;
/**
* Returns true if the given object is an instance of VpcLink. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is VpcLink;
/**
* The description of the VPC link.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name used to label and identify the VPC link.
*/
readonly name: pulumi.Output<string>;
/**
* An array of arbitrary tags (key-value pairs) to associate with the VPC link.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* 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.
*/
readonly targetArns: pulumi.Output<string[]>;
/**
* The ID for the VPC link. For example: `abc123` .
*/
readonly vpcLinkId: pulumi.Output<string>;
/**
* Create a VpcLink resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: VpcLinkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a VpcLink resource.
*/
export interface VpcLinkArgs {
/**
* The description of the VPC link.
*/
description?: pulumi.Input<string>;
/**
* The name used to label and identify the VPC link.
*/
name?: pulumi.Input<string>;
/**
* An array of arbitrary tags (key-value pairs) to associate with the VPC link.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* 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.
*/
targetArns: pulumi.Input<pulumi.Input<string>[]>;
}