1. Packages
  2. AWS Classic
  3. API Docs
  4. ec2
  5. EgressOnlyInternetGateway

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.ec2.EgressOnlyInternetGateway

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    [IPv6 only] Creates an egress-only Internet gateway for your VPC. An egress-only Internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the Internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.ec2.Vpc("example", {
        cidrBlock: "10.1.0.0/16",
        assignGeneratedIpv6CidrBlock: true,
    });
    const exampleEgressOnlyInternetGateway = new aws.ec2.EgressOnlyInternetGateway("example", {
        vpcId: example.id,
        tags: {
            Name: "main",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ec2.Vpc("example",
        cidr_block="10.1.0.0/16",
        assign_generated_ipv6_cidr_block=True)
    example_egress_only_internet_gateway = aws.ec2.EgressOnlyInternetGateway("example",
        vpc_id=example.id,
        tags={
            "Name": "main",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := ec2.NewVpc(ctx, "example", &ec2.VpcArgs{
    			CidrBlock:                    pulumi.String("10.1.0.0/16"),
    			AssignGeneratedIpv6CidrBlock: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ec2.NewEgressOnlyInternetGateway(ctx, "example", &ec2.EgressOnlyInternetGatewayArgs{
    			VpcId: example.ID(),
    			Tags: pulumi.StringMap{
    				"Name": pulumi.String("main"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Ec2.Vpc("example", new()
        {
            CidrBlock = "10.1.0.0/16",
            AssignGeneratedIpv6CidrBlock = true,
        });
    
        var exampleEgressOnlyInternetGateway = new Aws.Ec2.EgressOnlyInternetGateway("example", new()
        {
            VpcId = example.Id,
            Tags = 
            {
                { "Name", "main" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ec2.Vpc;
    import com.pulumi.aws.ec2.VpcArgs;
    import com.pulumi.aws.ec2.EgressOnlyInternetGateway;
    import com.pulumi.aws.ec2.EgressOnlyInternetGatewayArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Vpc("example", VpcArgs.builder()
                .cidrBlock("10.1.0.0/16")
                .assignGeneratedIpv6CidrBlock(true)
                .build());
    
            var exampleEgressOnlyInternetGateway = new EgressOnlyInternetGateway("exampleEgressOnlyInternetGateway", EgressOnlyInternetGatewayArgs.builder()
                .vpcId(example.id())
                .tags(Map.of("Name", "main"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:ec2:Vpc
        properties:
          cidrBlock: 10.1.0.0/16
          assignGeneratedIpv6CidrBlock: true
      exampleEgressOnlyInternetGateway:
        type: aws:ec2:EgressOnlyInternetGateway
        name: example
        properties:
          vpcId: ${example.id}
          tags:
            Name: main
    

    Create EgressOnlyInternetGateway Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EgressOnlyInternetGateway(name: string, args: EgressOnlyInternetGatewayArgs, opts?: CustomResourceOptions);
    @overload
    def EgressOnlyInternetGateway(resource_name: str,
                                  args: EgressOnlyInternetGatewayArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def EgressOnlyInternetGateway(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  vpc_id: Optional[str] = None,
                                  tags: Optional[Mapping[str, str]] = None)
    func NewEgressOnlyInternetGateway(ctx *Context, name string, args EgressOnlyInternetGatewayArgs, opts ...ResourceOption) (*EgressOnlyInternetGateway, error)
    public EgressOnlyInternetGateway(string name, EgressOnlyInternetGatewayArgs args, CustomResourceOptions? opts = null)
    public EgressOnlyInternetGateway(String name, EgressOnlyInternetGatewayArgs args)
    public EgressOnlyInternetGateway(String name, EgressOnlyInternetGatewayArgs args, CustomResourceOptions options)
    
    type: aws:ec2:EgressOnlyInternetGateway
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EgressOnlyInternetGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EgressOnlyInternetGatewayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EgressOnlyInternetGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EgressOnlyInternetGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EgressOnlyInternetGatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var egressOnlyInternetGatewayResource = new Aws.Ec2.EgressOnlyInternetGateway("egressOnlyInternetGatewayResource", new()
    {
        VpcId = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := ec2.NewEgressOnlyInternetGateway(ctx, "egressOnlyInternetGatewayResource", &ec2.EgressOnlyInternetGatewayArgs{
    	VpcId: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var egressOnlyInternetGatewayResource = new EgressOnlyInternetGateway("egressOnlyInternetGatewayResource", EgressOnlyInternetGatewayArgs.builder()
        .vpcId("string")
        .tags(Map.of("string", "string"))
        .build());
    
    egress_only_internet_gateway_resource = aws.ec2.EgressOnlyInternetGateway("egressOnlyInternetGatewayResource",
        vpc_id="string",
        tags={
            "string": "string",
        })
    
    const egressOnlyInternetGatewayResource = new aws.ec2.EgressOnlyInternetGateway("egressOnlyInternetGatewayResource", {
        vpcId: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:ec2:EgressOnlyInternetGateway
    properties:
        tags:
            string: string
        vpcId: string
    

    EgressOnlyInternetGateway Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EgressOnlyInternetGateway resource accepts the following input properties:

    VpcId string
    The VPC ID to create in.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VpcId string
    The VPC ID to create in.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcId String
    The VPC ID to create in.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcId string
    The VPC ID to create in.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpc_id str
    The VPC ID to create in.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpcId String
    The VPC ID to create in.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EgressOnlyInternetGateway resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing EgressOnlyInternetGateway Resource

    Get an existing EgressOnlyInternetGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EgressOnlyInternetGatewayState, opts?: CustomResourceOptions): EgressOnlyInternetGateway
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            vpc_id: Optional[str] = None) -> EgressOnlyInternetGateway
    func GetEgressOnlyInternetGateway(ctx *Context, name string, id IDInput, state *EgressOnlyInternetGatewayState, opts ...ResourceOption) (*EgressOnlyInternetGateway, error)
    public static EgressOnlyInternetGateway Get(string name, Input<string> id, EgressOnlyInternetGatewayState? state, CustomResourceOptions? opts = null)
    public static EgressOnlyInternetGateway get(String name, Output<String> id, EgressOnlyInternetGatewayState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcId string
    The VPC ID to create in.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpcId string
    The VPC ID to create in.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcId String
    The VPC ID to create in.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcId string
    The VPC ID to create in.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpc_id str
    The VPC ID to create in.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpcId String
    The VPC ID to create in.

    Import

    Using pulumi import, import Egress-only Internet gateways using the id. For example:

    $ pulumi import aws:ec2/egressOnlyInternetGateway:EgressOnlyInternetGateway example eigw-015e0e244e24dfe8a
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi