| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
AWS::EC2::EIP
The AWS::EC2::EIP resource allocates an Elastic IP (EIP) address and can, optionally, associate it with an Amazon EC2 instance.
Syntax
{
"Type" : "AWS::EC2::EIP",
"Properties" : {
"InstanceId" : String,
"Domain" : String
}
}Properties
- InstanceId
The Instance ID of the Amazon EC2 instance that you want to associate with this Elastic IP address.
Required: No
Type: String
- Domain
Set to "vpc" to allocate the address to your Virtual Private Cloud (VPC). No other values are supported.
For more information, see AllocateAddress in the Amazon Elastic Compute Cloud API Reference. For more information about Elastic IP Addresses in VPC, go to IP Addressing in Your VPC in the Amazon VPC User Guide.
Required: Conditional. Required when allocating an address to a VPC
Type: String
Return Values
Ref
When you specify the logical ID of an AWS::EC2::EIP object as an argument to the Ref
function, AWS CloudFormation returns the value of the instance's PublicIp.
For more information about using the Ref function, see Ref.
Fn::GetAtt
Fn::GetAtt returns a value for a specified attribute of this type.
This section lists the available attributes and corresponding return values.
- AllocationId
The ID that AWS assigns to represent the allocation of the address for use with Amazon VPC. THis is returned only for VPC elastic IP addresses. Example return value:
eipalloc-5723d13e
For more information about using Fn:GetAtt, see Fn::GetAtt.
Examples
To view AWS::EC2::EIP snippets, see Assigning an Amazon EC2 Elastic IP Using AWS::EC2::EIP Snippet.
