Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Associates an Elastic IP address with an instance or a network interface.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
- EC2-Classic, VPC in an EC2-VPC-only account
- If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.
- VPC in an EC2-Classic account
- If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
See: AWS API Reference for AssociateAddress.
- associateAddress :: AssociateAddress
- data AssociateAddress
- aasInstanceId :: Lens' AssociateAddress (Maybe Text)
- aasAllocationId :: Lens' AssociateAddress (Maybe Text)
- aasNetworkInterfaceId :: Lens' AssociateAddress (Maybe Text)
- aasAllowReassociation :: Lens' AssociateAddress (Maybe Bool)
- aasPrivateIPAddress :: Lens' AssociateAddress (Maybe Text)
- aasPublicIP :: Lens' AssociateAddress (Maybe Text)
- aasDryRun :: Lens' AssociateAddress (Maybe Bool)
- associateAddressResponse :: Int -> AssociateAddressResponse
- data AssociateAddressResponse
- arsAssociationId :: Lens' AssociateAddressResponse (Maybe Text)
- arsStatus :: Lens' AssociateAddressResponse Int
Creating a Request
associateAddress :: AssociateAddress Source
Creates a value of AssociateAddress
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AssociateAddress Source
See: associateAddress
smart constructor.
Request Lenses
aasInstanceId :: Lens' AssociateAddress (Maybe Text) Source
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
aasAllocationId :: Lens' AssociateAddress (Maybe Text) Source
- EC2-VPC
- The allocation ID. This is required for EC2-VPC.
aasNetworkInterfaceId :: Lens' AssociateAddress (Maybe Text) Source
- EC2-VPC
- The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
aasAllowReassociation :: Lens' AssociateAddress (Maybe Bool) Source
- EC2-VPC
- Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.
Default: false
aasPrivateIPAddress :: Lens' AssociateAddress (Maybe Text) Source
- EC2-VPC
- The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
aasPublicIP :: Lens' AssociateAddress (Maybe Text) Source
The Elastic IP address. This is required for EC2-Classic.
aasDryRun :: Lens' AssociateAddress (Maybe Bool) Source
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
Destructuring the Response
associateAddressResponse Source
Creates a value of AssociateAddressResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AssociateAddressResponse Source
See: associateAddressResponse
smart constructor.
Response Lenses
arsAssociationId :: Lens' AssociateAddressResponse (Maybe Text) Source
- EC2-VPC
- The ID that represents the association of the Elastic IP address with an instance.
arsStatus :: Lens' AssociateAddressResponse Int Source
The response status code.