@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
112 lines (111 loc) • 3.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to get the id of a VPC Link in
* API Gateway. To fetch the VPC Link you must provide a name to match against.
* As there is no unique name constraint on API Gateway VPC Links this data source will
* error if there is more than one match.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const myApiGatewayVpcLink = aws.apigateway.getVpcLink({
* name: "my-vpc-link",
* });
* ```
*/
export declare function getVpcLink(args: GetVpcLinkArgs, opts?: pulumi.InvokeOptions): Promise<GetVpcLinkResult>;
/**
* A collection of arguments for invoking getVpcLink.
*/
export interface GetVpcLinkArgs {
/**
* Name of the API Gateway VPC Link to look up. If no API Gateway VPC Link is found with this name, an error will be returned.
* If multiple API Gateway VPC Links are found with this name, an error will be returned.
*/
name: 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?: string;
/**
* Key-value map of resource tags
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getVpcLink.
*/
export interface GetVpcLinkResult {
readonly arn: string;
/**
* Description of the VPC link.
*/
readonly description: string;
/**
* Set to the ID of the found API Gateway VPC Link.
*/
readonly id: string;
readonly name: string;
readonly region: string;
/**
* Status of the VPC link.
*/
readonly status: string;
/**
* Status message of the VPC link.
*/
readonly statusMessage: string;
/**
* Key-value map of resource tags
*/
readonly tags: {
[key: string]: string;
};
/**
* List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
*/
readonly targetArns: string[];
}
/**
* Use this data source to get the id of a VPC Link in
* API Gateway. To fetch the VPC Link you must provide a name to match against.
* As there is no unique name constraint on API Gateway VPC Links this data source will
* error if there is more than one match.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const myApiGatewayVpcLink = aws.apigateway.getVpcLink({
* name: "my-vpc-link",
* });
* ```
*/
export declare function getVpcLinkOutput(args: GetVpcLinkOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVpcLinkResult>;
/**
* A collection of arguments for invoking getVpcLink.
*/
export interface GetVpcLinkOutputArgs {
/**
* Name of the API Gateway VPC Link to look up. If no API Gateway VPC Link is found with this name, an error will be returned.
* If multiple API Gateway VPC Links are found with this name, an error will be returned.
*/
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>;
/**
* Key-value map of resource tags
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}