Package org.jclouds.ec2.features

Interface ElasticIPAddressApi

public interface ElasticIPAddressApi

Provides access to EC2 Elastic IP Addresses via REST API.

Method Summary

Modifier and Type	Method	Description
String	allocateAddressInRegion(String region)	Acquires an elastic IP address for use with your identity.
void	associateAddressInRegion(String region, String publicIp, String instanceId)	Associates an elastic IP address with an instance.
Set<PublicIpInstanceIdPair>	describeAddressesInRegion(String region, String... publicIps)	Lists elastic IP addresses assigned to your identity or provides information about a specific address.
Set<PublicIpInstanceIdPair>	describeAddressesInRegionWithFilter(String region, com.google.common.collect.Multimap<String,String> filter)	Lists elastic IP addresses assigned to your identity or provides information on addresses matching a given filter.
void	disassociateAddressInRegion(String region, String publicIp)	Disassociates the specified elastic IP address from the instance to which it is assigned.
void	releaseAddressInRegion(String region, String publicIp)	Releases an elastic IP address associated with your identity.

Method Detail

allocateAddressInRegion

@Named("AllocateAddress")
@POST
@Path("/")
String allocateAddressInRegion(@Nullable
                               String region)

Acquires an elastic IP address for use with your identity.

Parameters:

region - Elastic IP addresses are tied to a Region and cannot be mapped across Regions.

See Also:

#describeAddresses, #releaseAddress, #associateAddress, #disassociateAddress,

associateAddressInRegion

@Named("AssociateAddress")
@POST
@Path("/")
void associateAddressInRegion(@Nullable
                              String region,
                              @FormParam("PublicIp")
                              String publicIp,
                              @FormParam("InstanceId")
                              String instanceId)

Associates an elastic IP address with an instance. If the IP address is currently assigned to another instance, the IP address is assigned to the new instance. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.

Parameters:

region - Elastic IP addresses are tied to a Region and cannot be mapped across Regions.

publicIp - IP address that you are assigning to the instance.

instanceId - The instance to associate with the IP address.

See Also:

#allocateAddress, #describeAddresses, #releaseAddress, #disassociateAddress,

disassociateAddressInRegion

@Named("DisassociateAddress")
@POST
@Path("/")
void disassociateAddressInRegion(@Nullable
                                 String region,
                                 @FormParam("PublicIp")
                                 String publicIp)

Disassociates the specified elastic IP address from the instance to which it is assigned. This is an idempotent operation. If you enter it more than once, Amazon EC2 does not return an error.

Parameters:

region - Elastic IP addresses are tied to a Region and cannot be mapped across Regions.

publicIp - IP address that you are assigning to the instance.

See Also:

#allocateAddress, #describeAddresses, #releaseAddress, #associateAddress,

releaseAddressInRegion

@Named("ReleaseAddress")
@POST
@Path("/")
void releaseAddressInRegion(@Nullable
                            String region,
                            @FormParam("PublicIp")
                            String publicIp)

Releases an elastic IP address associated with your identity.

Parameters:

region - Elastic IP addresses are tied to a Region and cannot be mapped across Regions.

publicIp - The IP address that you are releasing from your identity.

See Also:

#allocateAddress, #describeAddresses, #associateAddress, #disassociateAddress,

describeAddressesInRegion

@Named("DescribeAddresses")
@POST
@Path("/")
Set<PublicIpInstanceIdPair> describeAddressesInRegion(@Nullable
                                                      String region,
                                                      String... publicIps)

Lists elastic IP addresses assigned to your identity or provides information about a specific address.

Parameters:

region - Elastic IP addresses are tied to a Region and cannot be mapped across Regions.

publicIps - Elastic IP address to describe.

Throws:

AWSResponseException - if the requested publicIp is not found

See Also:

#allocateAddress, #releaseAddress,

describeAddressesInRegionWithFilter

@Named("DescribeAddresses")
@POST
@Path("/")
Set<PublicIpInstanceIdPair> describeAddressesInRegionWithFilter(@Nullable
                                                                String region,
                                                                com.google.common.collect.Multimap<String,String> filter)

Lists elastic IP addresses assigned to your identity or provides information on addresses matching a given filter.

Parameters:

region - Elastic IP addresses are tied to a Region and cannot be mapped across Regions.

filter -

Throws:

AWSResponseException - if the requested publicIp is not found

See Also:

#allocateAddress, #releaseAddress,