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

Interface Service.Builder

All Superinterfaces:

CopyableBuilder<Service.Builder,Service>, SdkBuilder<Service.Builder,Service>

Enclosing class:

Service

public static interface Service.Builder
extends CopyableBuilder<Service.Builder,Service>

Method Summary

Modifier and Type	Method	Description
Service.Builder	clusterArn(String clusterArn)	The Amazon Resource Name (ARN) of the cluster that hosts the service.
Service.Builder	createdAt(Date createdAt)	The Unix timestamp for when the service was created.
Service.Builder	deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)	Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Service.Builder	deployments(Collection<Deployment> deployments)	The current state of deployments for the service.
Service.Builder	deployments(Deployment... deployments)	The current state of deployments for the service.
Service.Builder	desiredCount(Integer desiredCount)	The desired number of instantiations of the task definition to keep running on the service.
Service.Builder	events(Collection<ServiceEvent> events)	The event stream for your service.
Service.Builder	events(ServiceEvent... events)	The event stream for your service.
Service.Builder	loadBalancers(Collection<LoadBalancer> loadBalancers)	A list of Elastic Load Balancing 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.
Service.Builder	loadBalancers(LoadBalancer... loadBalancers)	A list of Elastic Load Balancing 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.
Service.Builder	pendingCount(Integer pendingCount)	The number of tasks in the cluster that are in the PENDING state.
Service.Builder	placementConstraints(Collection<PlacementConstraint> placementConstraints)	The placement constraints for the tasks in the service.
Service.Builder	placementConstraints(PlacementConstraint... placementConstraints)	The placement constraints for the tasks in the service.
Service.Builder	placementStrategy(Collection<PlacementStrategy> placementStrategy)	The placement strategy that determines how tasks for the service are placed.
Service.Builder	placementStrategy(PlacementStrategy... placementStrategy)	The placement strategy that determines how tasks for the service are placed.
Service.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
Service.Builder	runningCount(Integer runningCount)	The number of tasks in the cluster that are in the RUNNING state.
Service.Builder	serviceArn(String serviceArn)	The Amazon Resource Name (ARN) that identifies the service.
Service.Builder	serviceName(String serviceName)	The name of your service.
Service.Builder	status(String status)	The status of the service.
Service.Builder	taskDefinition(String taskDefinition)	The task definition to use for tasks in the service.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

serviceArn

Service.Builder serviceArn(String serviceArn)

The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service .

Parameters:

serviceArn - The Amazon Resource Name (ARN) that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service .

Returns:

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

serviceName

Service.Builder serviceName(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.

Returns:

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

clusterArn

Service.Builder clusterArn(String clusterArn)

The Amazon Resource Name (ARN) of the cluster that hosts the service.

Parameters:

clusterArn - The Amazon Resource Name (ARN) of the cluster that hosts the service.

Returns:

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

loadBalancers

Service.Builder loadBalancers(Collection<LoadBalancer> loadBalancers)

A list of Elastic Load Balancing 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 Elastic Load Balancing 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:

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

loadBalancers

Service.Builder loadBalancers(LoadBalancer... loadBalancers)

A list of Elastic Load Balancing 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.

Parameters:

loadBalancers - A list of Elastic Load Balancing 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:

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

status

Service.Builder status(String status)

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Parameters:

status - The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

Returns:

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

desiredCount

Service.Builder desiredCount(Integer desiredCount)

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Parameters:

desiredCount - The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Returns:

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

runningCount

Service.Builder runningCount(Integer runningCount)

The number of tasks in the cluster that are in the RUNNING state.

Parameters:

runningCount - The number of tasks in the cluster that are in the RUNNING state.

Returns:

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

pendingCount

Service.Builder pendingCount(Integer pendingCount)

The number of tasks in the cluster that are in the PENDING state.

Parameters:

pendingCount - The number of tasks in the cluster that are in the PENDING state.

Returns:

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

taskDefinition

Service.Builder taskDefinition(String taskDefinition)

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Parameters:

taskDefinition - The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

Returns:

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

deploymentConfiguration

Service.Builder deploymentConfiguration(DeploymentConfiguration deploymentConfiguration)

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

Parameters:

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

Returns:

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

deployments

Service.Builder deployments(Collection<Deployment> deployments)

The current state of deployments for the service.

Parameters:

deployments - The current state of deployments for the service.

Returns:

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

deployments

Service.Builder deployments(Deployment... deployments)

The current state of deployments for the service.

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

Parameters:

deployments - The current state of deployments for the service.

Returns:

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

roleArn

Service.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

Returns:

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

events

Service.Builder events(Collection<ServiceEvent> events)

The event stream for your service. A maximum of 100 of the latest events are displayed.

Parameters:

events - The event stream for your service. A maximum of 100 of the latest events are displayed.

Returns:

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

events

Service.Builder events(ServiceEvent... events)

The event stream for your service. A maximum of 100 of the latest events are displayed.

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

Parameters:

events - The event stream for your service. A maximum of 100 of the latest events are displayed.

Returns:

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

createdAt

Service.Builder createdAt(Date createdAt)

The Unix timestamp for when the service was created.

Parameters:

createdAt - The Unix timestamp for when the service was created.

Returns:

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

placementConstraints

Service.Builder placementConstraints(Collection<PlacementConstraint> placementConstraints)

The placement constraints for the tasks in the service.

Parameters:

placementConstraints - The placement constraints for the tasks in the service.

Returns:

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

placementConstraints

Service.Builder placementConstraints(PlacementConstraint... placementConstraints)

The placement constraints for the tasks in the service.

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

Parameters:

placementConstraints - The placement constraints for the tasks in the service.

Returns:

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

placementStrategy

Service.Builder placementStrategy(Collection<PlacementStrategy> placementStrategy)

The placement strategy that determines how tasks for the service are placed.

Parameters:

placementStrategy - The placement strategy that determines how tasks for the service are placed.

Returns:

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

placementStrategy

Service.Builder placementStrategy(PlacementStrategy... placementStrategy)

The placement strategy that determines how tasks for the service are placed.

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

Parameters:

placementStrategy - The placement strategy that determines how tasks for the service are placed.

Returns:

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