@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
153 lines (152 loc) • 5.69 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages an Amazon API Gateway Version 2 VPC Link.
*
* > **Note:** Amazon API Gateway Version 2 VPC Links enable private integrations that connect HTTP APIs to private resources in a VPC.
* To enable private integration for REST APIs, use the Amazon API Gateway Version 1 VPC Link resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.apigatewayv2.VpcLink("example", {
* name: "example",
* securityGroupIds: [exampleAwsSecurityGroup.id],
* subnetIds: exampleAwsSubnets.ids,
* tags: {
* Usage: "example",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import `aws_apigatewayv2_vpc_link` using the VPC Link identifier. For example:
*
* ```sh
* $ pulumi import aws:apigatewayv2/vpcLink:VpcLink example aabbccddee
* ```
*/
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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VpcLinkState, 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;
/**
* VPC Link ARN.
*/
readonly arn: pulumi.Output<string>;
/**
* Name of the VPC Link. Must be between 1 and 128 characters in length.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Security group IDs for the VPC Link.
*/
readonly securityGroupIds: pulumi.Output<string[]>;
/**
* Subnet IDs for the VPC Link.
*/
readonly subnetIds: pulumi.Output<string[]>;
/**
* Map of tags to assign to the VPC Link. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: 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);
}
/**
* Input properties used for looking up and filtering VpcLink resources.
*/
export interface VpcLinkState {
/**
* VPC Link ARN.
*/
arn?: pulumi.Input<string>;
/**
* Name of the VPC Link. Must be between 1 and 128 characters in length.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Security group IDs for the VPC Link.
*/
securityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Subnet IDs for the VPC Link.
*/
subnetIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Map of tags to assign to the VPC Link. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a VpcLink resource.
*/
export interface VpcLinkArgs {
/**
* Name of the VPC Link. Must be between 1 and 128 characters in length.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Security group IDs for the VPC Link.
*/
securityGroupIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* Subnet IDs for the VPC Link.
*/
subnetIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* Map of tags to assign to the VPC Link. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}