@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
168 lines (167 loc) • 6.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a resource to create a VPC Internet Gateway.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const gw = new aws.ec2.InternetGateway("gw", {
* vpcId: main.id,
* tags: {
* Name: "main",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Internet Gateways using the `id`. For example:
*
* ```sh
* $ pulumi import aws:ec2/internetGateway:InternetGateway gw igw-c0a643a9
* ```
*/
export declare class InternetGateway extends pulumi.CustomResource {
/**
* Get an existing InternetGateway 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?: InternetGatewayState, opts?: pulumi.CustomResourceOptions): InternetGateway;
/**
* Returns true if the given object is an instance of InternetGateway. 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 InternetGateway;
/**
* The ARN of the Internet Gateway.
*/
readonly arn: pulumi.Output<string>;
/**
* The ID of the AWS account that owns the internet gateway.
*/
readonly ownerId: 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>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* > **Note:** It's recommended to denote that the AWS Instance or Elastic IP depends on the Internet Gateway. For example:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const gw = new aws.ec2.InternetGateway("gw", {vpcId: main.id});
* const foo = new aws.ec2.Instance("foo", {}, {
* dependsOn: [gw],
* });
* ```
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The VPC ID to create in. See the aws.ec2.InternetGatewayAttachment resource for an alternate way to attach an Internet Gateway to a VPC.
*/
readonly vpcId: pulumi.Output<string>;
/**
* Create a InternetGateway 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?: InternetGatewayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InternetGateway resources.
*/
export interface InternetGatewayState {
/**
* The ARN of the Internet Gateway.
*/
arn?: pulumi.Input<string>;
/**
* The ID of the AWS account that owns the internet gateway.
*/
ownerId?: 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>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* > **Note:** It's recommended to denote that the AWS Instance or Elastic IP depends on the Internet Gateway. For example:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const gw = new aws.ec2.InternetGateway("gw", {vpcId: main.id});
* const foo = new aws.ec2.Instance("foo", {}, {
* dependsOn: [gw],
* });
* ```
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A 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 VPC ID to create in. See the aws.ec2.InternetGatewayAttachment resource for an alternate way to attach an Internet Gateway to a VPC.
*/
vpcId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a InternetGateway resource.
*/
export interface InternetGatewayArgs {
/**
* 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>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*
* > **Note:** It's recommended to denote that the AWS Instance or Elastic IP depends on the Internet Gateway. For example:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const gw = new aws.ec2.InternetGateway("gw", {vpcId: main.id});
* const foo = new aws.ec2.Instance("foo", {}, {
* dependsOn: [gw],
* });
* ```
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The VPC ID to create in. See the aws.ec2.InternetGatewayAttachment resource for an alternate way to attach an Internet Gateway to a VPC.
*/
vpcId?: pulumi.Input<string>;
}