org.jclouds.aws.elb.ELBClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jclouds-aws Show documentation

jclouds Core components to access Amazon AWS

The newest version!

/**
 *
 * Copyright (C) 2010 Cloud Conscious, LLC. 
 *
 * ====================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ====================================================================
 */

package org.jclouds.aws.elb;

import java.util.Set;
import java.util.concurrent.TimeUnit;

import javax.annotation.Nullable;

import org.jclouds.aws.elb.domain.LoadBalancer;
import org.jclouds.concurrent.Timeout;

/**
 * Provides access to EC2 Elastic Load Balancer via their REST API.
 * 
 * 
 * @author Lili Nader
 */
@Timeout(duration = 30, timeUnit = TimeUnit.SECONDS)
public interface ELBClient {

   /**
    * Creates a load balancer
    * 
    * @param name
    *           Name of the load balancer
    * @param loadBalancerPort
    *           Port for the load balancer to listen on
    * @param instancePort
    *           Port to forward the request to
    * @param availabilityZones
    *           load balancer availability zones
    * @return dns the DNS name for the load balancer
    * @see  registerInstancesWithLoadBalancerInRegion(@Nullable String region, String name,
            String... instanceIds);

   /**
    * Deregister instances with an existing load balancer
    * 
    * @param name
    *           Load Balancer name
    * @param instanceIds
    *           Set of instance Ids to deregister with load balancer
    * @return
    * 
    * @see  describeLoadBalancersInRegion(@Nullable String region);

}