@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
131 lines (130 loc) • 4.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides details about an EC2 Local Gateway.
*
* ## Example Usage
*
* The following example shows how one might accept a local gateway id as a variable.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const config = new pulumi.Config();
* const localGatewayId = config.requireObject<any>("localGatewayId");
* const selected = aws.ec2.getLocalGateway({
* id: localGatewayId,
* });
* ```
*/
export declare function getLocalGateway(args?: GetLocalGatewayArgs, opts?: pulumi.InvokeOptions): Promise<GetLocalGatewayResult>;
/**
* A collection of arguments for invoking getLocalGateway.
*/
export interface GetLocalGatewayArgs {
/**
* Custom filter block as described below.
*/
filters?: inputs.ec2.GetLocalGatewayFilter[];
/**
* Id of the specific Local Gateway to retrieve.
*/
id?: 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;
/**
* Current state of the desired Local Gateway.
* Can be either `"pending"` or `"available"`.
*/
state?: string;
/**
* Mapping of tags, each pair of which must exactly match
* a pair on the desired Local Gateway.
*
* The arguments of this data source act as filters for querying the available
* Local Gateways in the current region. The given filters must match exactly one
* Local Gateway whose data will be exported as attributes.
*/
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getLocalGateway.
*/
export interface GetLocalGatewayResult {
readonly filters?: outputs.ec2.GetLocalGatewayFilter[];
readonly id: string;
/**
* ARN of Outpost
*/
readonly outpostArn: string;
/**
* AWS account identifier that owns the Local Gateway.
*/
readonly ownerId: string;
readonly region: string;
/**
* State of the local gateway.
*/
readonly state: string;
readonly tags: {
[key: string]: string;
};
}
/**
* Provides details about an EC2 Local Gateway.
*
* ## Example Usage
*
* The following example shows how one might accept a local gateway id as a variable.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const config = new pulumi.Config();
* const localGatewayId = config.requireObject<any>("localGatewayId");
* const selected = aws.ec2.getLocalGateway({
* id: localGatewayId,
* });
* ```
*/
export declare function getLocalGatewayOutput(args?: GetLocalGatewayOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetLocalGatewayResult>;
/**
* A collection of arguments for invoking getLocalGateway.
*/
export interface GetLocalGatewayOutputArgs {
/**
* Custom filter block as described below.
*/
filters?: pulumi.Input<pulumi.Input<inputs.ec2.GetLocalGatewayFilterArgs>[]>;
/**
* Id of the specific Local Gateway to retrieve.
*/
id?: 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>;
/**
* Current state of the desired Local Gateway.
* Can be either `"pending"` or `"available"`.
*/
state?: pulumi.Input<string>;
/**
* Mapping of tags, each pair of which must exactly match
* a pair on the desired Local Gateway.
*
* The arguments of this data source act as filters for querying the available
* Local Gateways in the current region. The given filters must match exactly one
* Local Gateway whose data will be exported as attributes.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}