org.jclouds.ec2

Interface EC2Api

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

AWSEC2Api, NovaEC2Api

public interface EC2Api
extends Closeable

Provides access to EC2 features, broken up by feature group. Use of the Optional type allows you to check to see if the underlying implementation supports a particular feature before attempting to use it. This is useful in clones like OpenStack, CloudStack, or Eucalyptus, which track the api, but are always behind Amazon's service. In the case of Amazon (aws-ec2), you can expect all features to be present. Example

 Optional<? extends WindowsApi> windowsOption = ec2Api.getWindowsApi();
 checkState(windowsOption.isPresent(), "windows feature required, but not present");
 

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<? extends AMIApi>	getAMIApi() Provides synchronous access to AMI services.
com.google.common.base.Optional<? extends AMIApi>	getAMIApiForRegion(String region)
com.google.common.base.Optional<? extends AvailabilityZoneAndRegionApi>	getAvailabilityZoneAndRegionApi() Provides synchronous access to Availability Zones and Regions services.
com.google.common.base.Optional<? extends AvailabilityZoneAndRegionApi>	getAvailabilityZoneAndRegionApiForRegion(String region)
Set<String>	getConfiguredRegions()
com.google.common.base.Optional<? extends ElasticBlockStoreApi>	getElasticBlockStoreApi() Provides synchronous access to Elastic Block Store services.
com.google.common.base.Optional<? extends ElasticBlockStoreApi>	getElasticBlockStoreApiForRegion(String region)
com.google.common.base.Optional<? extends ElasticIPAddressApi>	getElasticIPAddressApi() Provides synchronous access to Elastic IP Address services.
com.google.common.base.Optional<? extends ElasticIPAddressApi>	getElasticIPAddressApiForRegion(String region)
com.google.common.base.Optional<? extends InstanceApi>	getInstanceApi() Provides synchronous access to Instance services.
com.google.common.base.Optional<? extends InstanceApi>	getInstanceApiForRegion(String region)
com.google.common.base.Optional<? extends KeyPairApi>	getKeyPairApi() Provides synchronous access to KeyPair services.
com.google.common.base.Optional<? extends KeyPairApi>	getKeyPairApiForRegion(String region)
com.google.common.base.Optional<? extends SecurityGroupApi>	getSecurityGroupApi() Provides synchronous access to SecurityGroup services.
com.google.common.base.Optional<? extends SecurityGroupApi>	getSecurityGroupApiForRegion(String region)
com.google.common.base.Optional<? extends SubnetApi>	getSubnetApi() Provides synchronous access to Subnet features.
com.google.common.base.Optional<? extends SubnetApi>	getSubnetApiForRegion(String region)
com.google.common.base.Optional<? extends TagApi>	getTagApi() Provides synchronous access to Tag features.
com.google.common.base.Optional<? extends TagApi>	getTagApiForRegion(String region)
com.google.common.base.Optional<? extends WindowsApi>	getWindowsApi() Provides synchronous access to Windows features.
com.google.common.base.Optional<? extends WindowsApi>	getWindowsApiForRegion(String region)

Methods inherited from interface java.io.Closeable

close

Method Detail

getConfiguredRegions

@Provides
Set<String> getConfiguredRegions()

Returns:

the Region codes configured

getWindowsApi

com.google.common.base.Optional<? extends WindowsApi> getWindowsApi()

Provides synchronous access to Windows features.

getWindowsApiForRegion

com.google.common.base.Optional<? extends WindowsApi> getWindowsApiForRegion(@Nullable
                                                                             String region)

getTagApi

com.google.common.base.Optional<? extends TagApi> getTagApi()

Provides synchronous access to Tag features.

getTagApiForRegion

com.google.common.base.Optional<? extends TagApi> getTagApiForRegion(@Nullable
                                                                     String region)

getSubnetApi

com.google.common.base.Optional<? extends SubnetApi> getSubnetApi()

Provides synchronous access to Subnet features.

getSubnetApiForRegion

com.google.common.base.Optional<? extends SubnetApi> getSubnetApiForRegion(@Nullable
                                                                           String region)

getAMIApi

com.google.common.base.Optional<? extends AMIApi> getAMIApi()

Provides synchronous access to AMI services.

getAMIApiForRegion

com.google.common.base.Optional<? extends AMIApi> getAMIApiForRegion(@Nullable
                                                                     String region)

getElasticIPAddressApi

com.google.common.base.Optional<? extends ElasticIPAddressApi> getElasticIPAddressApi()

Provides synchronous access to Elastic IP Address services.

getElasticIPAddressApiForRegion

com.google.common.base.Optional<? extends ElasticIPAddressApi> getElasticIPAddressApiForRegion(@Nullable
                                                                                               String region)

getInstanceApi

com.google.common.base.Optional<? extends InstanceApi> getInstanceApi()

Provides synchronous access to Instance services.

getInstanceApiForRegion

com.google.common.base.Optional<? extends InstanceApi> getInstanceApiForRegion(@Nullable
                                                                               String region)

getKeyPairApi

com.google.common.base.Optional<? extends KeyPairApi> getKeyPairApi()

Provides synchronous access to KeyPair services.

getKeyPairApiForRegion

com.google.common.base.Optional<? extends KeyPairApi> getKeyPairApiForRegion(@Nullable
                                                                             String region)

getSecurityGroupApi

com.google.common.base.Optional<? extends SecurityGroupApi> getSecurityGroupApi()

Provides synchronous access to SecurityGroup services.

getSecurityGroupApiForRegion

com.google.common.base.Optional<? extends SecurityGroupApi> getSecurityGroupApiForRegion(@Nullable
                                                                                         String region)

getAvailabilityZoneAndRegionApi

com.google.common.base.Optional<? extends AvailabilityZoneAndRegionApi> getAvailabilityZoneAndRegionApi()

Provides synchronous access to Availability Zones and Regions services.

getAvailabilityZoneAndRegionApiForRegion

com.google.common.base.Optional<? extends AvailabilityZoneAndRegionApi> getAvailabilityZoneAndRegionApiForRegion(@Nullable
                                                                                                                 String region)

getElasticBlockStoreApi

com.google.common.base.Optional<? extends ElasticBlockStoreApi> getElasticBlockStoreApi()

Provides synchronous access to Elastic Block Store services.

getElasticBlockStoreApiForRegion

com.google.common.base.Optional<? extends ElasticBlockStoreApi> getElasticBlockStoreApiForRegion(@Nullable
                                                                                                 String region)