com.elastisys.scale.cloudpool.aws.commons.client.Ec2ApiClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudpool.aws.commons Show documentation

Common utility classes for building Amazon AWS-based cloud pools.

The newest version!

package com.elastisys.scale.cloudpool.aws.commons.client;

import java.io.Closeable;

import com.amazonaws.ClientConfiguration;
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.auth.AWSStaticCredentialsProvider;
import com.amazonaws.services.ec2.AmazonEC2;
import com.amazonaws.services.ec2.AmazonEC2ClientBuilder;

/**
 * An Amazon EC2 client that connects to and operates against a specific AWS
 * region.
 * 
 * Regions are logically isolated from each other, so for example, a client
 * created to connect to region us-east-1 won't be able to see resources created
 * by a client for region us-west-1.
 * 

 * If you need to access multiple AWS regions, a separate client should be
 * instantiated for each region.
 *
 * See regions
 * and endpoints for an exhaustive list of available regions.
 * 
 * Instances of this class are thread-safe and can therefore be used
 * concurrently from multiple threads.
 *
 *
 */
public class Ec2ApiClient implements Closeable {

    /** The AWS region that this client operates against. */
    private final String region;
    /**
     * The {@link AmazonEC2} client through which API operations can be invoked.
     */
    private final AmazonEC2 api;

    /**
     * Constructs a new {@link Ec2ApiClient} that operates against a given AWS
     * region.
     *
     * @param awsCredentials
     *            The AWS credentials used to connect to the AWS account.
     * @param region
     *            The AWS region that this client operates against.
     * @param clientConfiguration
     *            Any HTTP client configuration to customize API invocations.
     */
    public Ec2ApiClient(AWSCredentials awsCredentials, String region, ClientConfiguration clientConfiguration) {
        // limit the time-to-live of the JVM's DNS cache (in seconds)
        java.security.Security.setProperty("networkaddress.cache.ttl", "60");

        this.region = region;

        this.api = AmazonEC2ClientBuilder.standard().withRegion(region)
                .withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    }

    /**
     * Returns the AWS region that this client operates against.
     *
     * @return
     */
    public String getRegion() {
        return this.region;
    }

    /**
     * Returns the {@link AmazonEC2} client through which API operations can be
     * invoked.
     *
     * @return
     */
    public AmazonEC2 getApi() {
        return this.api;
    }

    /**
     * Closes the client, releasing any held resources.
     */
    @Override
    public void close() {
        this.api.shutdown();
    }
}