com.amazonaws.services.ecs.model

Class CreateServiceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ecs.model.CreateServiceRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CreateServiceRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CreateService operation.

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount , Amazon ECS will spawn another instantiation of the task in the specified cluster.

See Also:

AmazonECS.createService(CreateServiceRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateServiceRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CreateServiceRequest	clone()
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
String	getCluster() The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on.
Integer	getDesiredCount() The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.
List<LoadBalancer>	getLoadBalancers() A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
String	getRole() The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf.
String	getServiceName() The name of your service.
String	getTaskDefinition() The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service.
int	hashCode()
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
void	setCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on.
void	setDesiredCount(Integer desiredCount) The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.
void	setLoadBalancers(Collection<LoadBalancer> loadBalancers) A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
void	setRole(String role) The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf.
void	setServiceName(String serviceName) The name of your service.
void	setTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateServiceRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
CreateServiceRequest	withCluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on.
CreateServiceRequest	withDesiredCount(Integer desiredCount) The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.
CreateServiceRequest	withLoadBalancers(Collection<LoadBalancer> loadBalancers) A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
CreateServiceRequest	withLoadBalancers(LoadBalancer... loadBalancers) A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
CreateServiceRequest	withRole(String role) The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf.
CreateServiceRequest	withServiceName(String serviceName) The name of your service.
CreateServiceRequest	withTaskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateServiceRequest

public CreateServiceRequest()

Method Detail

getCluster

public String getCluster()

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on. If you do not specify a cluster, the default cluster is assumed.

Returns:

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on. If you do not specify a cluster, the default cluster is assumed.

setCluster

public void setCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on. If you do not specify a cluster, the default cluster is assumed.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on. If you do not specify a cluster, the default cluster is assumed.

withCluster

public CreateServiceRequest withCluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on. If you do not specify a cluster, the default cluster is assumed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on. If you do not specify a cluster, the default cluster is assumed.

Returns:

A reference to this updated object so that method calls can be chained together.

getServiceName

public String getServiceName()

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

Returns:

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

setServiceName

public void setServiceName(String serviceName)

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

Parameters:

serviceName - The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

withServiceName

public CreateServiceRequest withServiceName(String serviceName)

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

Returns a reference to this object so that method calls can be chained together.

Parameters:

serviceName - The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

Returns:

A reference to this updated object so that method calls can be chained together.

getTaskDefinition

public String getTaskDefinition()

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

setTaskDefinition

public void setTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

withTaskDefinition

public CreateServiceRequest withTaskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

Returns a reference to this object so that method calls can be chained together.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

A reference to this updated object so that method calls can be chained together.

getLoadBalancers

public List<LoadBalancer> getLoadBalancers()

A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Returns:

A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

setLoadBalancers

public void setLoadBalancers(Collection<LoadBalancer> loadBalancers)

A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Parameters:

loadBalancers - A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

withLoadBalancers

public CreateServiceRequest withLoadBalancers(LoadBalancer... loadBalancers)

A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

NOTE: This method appends the values to the existing list (if any). Use setLoadBalancers(java.util.Collection) or withLoadBalancers(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

loadBalancers - A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Returns:

A reference to this updated object so that method calls can be chained together.

withLoadBalancers

public CreateServiceRequest withLoadBalancers(Collection<LoadBalancer> loadBalancers)

A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Returns a reference to this object so that method calls can be chained together.

Parameters:

loadBalancers - A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Returns:

A reference to this updated object so that method calls can be chained together.

getDesiredCount

public Integer getDesiredCount()

The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

Returns:

The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

setDesiredCount

public void setDesiredCount(Integer desiredCount)

The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

Parameters:

desiredCount - The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

withDesiredCount

public CreateServiceRequest withDesiredCount(Integer desiredCount)

The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

Returns a reference to this object so that method calls can be chained together.

Parameters:

desiredCount - The number of instantiations of the specified task definition that you would like to place and keep running on your cluster.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Returns:

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

withClientToken

public CreateServiceRequest withClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

Returns:

A reference to this updated object so that method calls can be chained together.

getRole

public String getRole()

The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

Returns:

The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

setRole

public void setRole(String role)

The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

Parameters:

role - The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

withRole

public CreateServiceRequest withRole(String role)

The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

Returns a reference to this object so that method calls can be chained together.

Parameters:

role - The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CreateServiceRequest clone()

Overrides:

clone in class AmazonWebServiceRequest