org.jclouds.ec2

Interface EC2Api

All Known Subinterfaces:

AWSEC2Client, EC2Client, NovaEC2Client

public interface EC2Api

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 = ec2Client.getWindowsApi();
 checkState(windowsOption.isPresent(), "windows feature required, but not present");
 

Author:

Adrian Cole

See Also:

EC2AsyncApi

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getConfiguredRegions()
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)

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)