Package software.amazon.awssdk.services.ecs.model

Class CreateServiceRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ecs.model.CreateServiceRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateServiceRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateServiceRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CreateServiceRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
String	cluster()	The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.
DeploymentConfiguration	deploymentConfiguration()	Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Integer	desiredCount()	The number of instantiations of the specified task definition to place and keep running on your cluster.
boolean	equals(Object obj)
int	hashCode()
List<LoadBalancer>	loadBalancers()	A load balancer object representing the load balancer to use with your service.
List<PlacementConstraint>	placementConstraints()	An array of placement constraint objects to use for tasks in your service.
List<PlacementStrategy>	placementStrategy()	The placement strategy objects to use for tasks in your service.
String	role()	The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf.
static Class<? extends CreateServiceRequest.Builder>	serializableBuilderClass()
String	serviceName()	The name of your service.
String	taskDefinition()	The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to run in your service.
CreateServiceRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

cluster

public String cluster()

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. 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 on which to run your service. If you do not specify a cluster, the default cluster is assumed.

serviceName

public 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:

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.

taskDefinition

public String taskDefinition()

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition 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 to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

loadBalancers

public List<LoadBalancer> loadBalancers()

A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.

For Elastic Load Balancing Classic load balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

For Elastic Load Balancing Application load balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

Returns:

A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable.

For Elastic Load Balancing Classic load balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

For Elastic Load Balancing Application load balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

desiredCount

public Integer desiredCount()

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

Returns:

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

clientToken

public String clientToken()

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.

role

public String role()

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

Returns:

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

deploymentConfiguration

public DeploymentConfiguration deploymentConfiguration()

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Returns:

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

placementConstraints

public List<PlacementConstraint> placementConstraints()

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

Returns:

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time).

placementStrategy

public List<PlacementStrategy> placementStrategy()

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

Returns:

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules per service.

toBuilder

public CreateServiceRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateServiceRequest.Builder,CreateServiceRequest>

Returns:

a builder for type T

builder

public static CreateServiceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateServiceRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object