AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource Types Reference » AWS::EC2::CustomerGateway
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

AWS::EC2::CustomerGateway

Provides information to AWS about your VPN customer gateway device.

Syntax

{
   "Type" : "AWS::EC2::CustomerGateway",
   "Properties" : {
      "BgpAsn" : Number,
      "IpAddress" : String,
      "Type" : String
   }
}

Properties

BgpAsn

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Required: Yes.

Type: Number. BgpAsn is always an integer value.

IpAddress

The internet-routable IP address for the customer gateway's outside interface. The address must be static.

Required: Yes.

Type: String.

Type

The type of VPN connection that this customer gateway supports.

Required: Yes.

Type: String.

Example: ipsec.1

Return Value

When the logical ID of this resource is provided to the Ref intrinsic function, it returns the resource name. For example:

{ "Ref": "MyResource" }

For the resource with the logical ID "MyResource", Ref will return the AWS resource name.

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

Example

{
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Resources" : {
      "myCustomerGateway" : {
         "Type" : "AWS::EC2::CustomerGateway",
         "Properties" : {
            "Type" : "ipsec.1",
            "BgpAsn" : "64000",
            "IpAddress" : "1.1.1.1"
         }
      }
   }
}

See Also

Document Conventions« PreviousNext »
Terms of UseDid this page help you?  Yes | No |  Tell us about it...