AWS::EC2::EgressOnlyInternetGateway - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EC2::EgressOnlyInternetGateway

[IPv6 only] Specifies 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.

For more information, see Egress-only internet gateway in the Amazon VPC User Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::EgressOnlyInternetGateway",
  "Properties" : {
      "Tags" : [ Tag, ... ],
      "VpcId" : String
    }
}

YAML

Type: AWS::EC2::EgressOnlyInternetGateway
Properties:
  Tags: 
    - Tag
  VpcId: String

Properties

Tags

The tags assigned to the egress-only internet gateway.

Required: No

Type: Array of Tag

Update requires: No interruption

VpcId

The ID of the VPC for which to create the egress-only internet gateway.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the egress-only internet gateway (the physical resource ID).

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Id

The ID of the egress-only internet gateway.

Examples

Create an egress-only internet gateway

The following example creates an egress-only internet gateway for the specified VPC.

YAML

myEgressOnlyInternetGateway: 
    Type: AWS::EC2::EgressOnlyInternetGateway
    Properties: 
        VpcId: vpc-1a2b3c4d

JSON

{
    "myEgressOnlyInternetGateway" : {
        "Type" : "AWS::EC2::EgressOnlyInternetGateway",
        "Properties" : {
            "VpcId" : "vpc-1a2b3c4d"
        }
    }
}

See also