Interface AwsEcsServiceDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AwsEcsServiceDetails.Builder,AwsEcsServiceDetails>, SdkBuilder<AwsEcsServiceDetails.Builder,AwsEcsServiceDetails>, SdkPojo

Enclosing class:

AwsEcsServiceDetails

@Mutable
@NotThreadSafe
public static interface AwsEcsServiceDetails.Builder
extends SdkPojo, CopyableBuilder<AwsEcsServiceDetails.Builder,AwsEcsServiceDetails>

Method Summary

Modifier and Type	Method	Description
AwsEcsServiceDetails.Builder	capacityProviderStrategy(Collection<AwsEcsServiceCapacityProviderStrategyDetails> capacityProviderStrategy)	The capacity provider strategy that the service uses.
AwsEcsServiceDetails.Builder	capacityProviderStrategy(Consumer<AwsEcsServiceCapacityProviderStrategyDetails.Builder>... capacityProviderStrategy)	The capacity provider strategy that the service uses.
AwsEcsServiceDetails.Builder	capacityProviderStrategy(AwsEcsServiceCapacityProviderStrategyDetails... capacityProviderStrategy)	The capacity provider strategy that the service uses.
AwsEcsServiceDetails.Builder	cluster(String cluster)	The ARN of the cluster that hosts the service.
default AwsEcsServiceDetails.Builder	deploymentConfiguration(Consumer<AwsEcsServiceDeploymentConfigurationDetails.Builder> deploymentConfiguration)	Deployment parameters for the service.
AwsEcsServiceDetails.Builder	deploymentConfiguration(AwsEcsServiceDeploymentConfigurationDetails deploymentConfiguration)	Deployment parameters for the service.
default AwsEcsServiceDetails.Builder	deploymentController(Consumer<AwsEcsServiceDeploymentControllerDetails.Builder> deploymentController)	Contains the deployment controller type that the service uses.
AwsEcsServiceDetails.Builder	deploymentController(AwsEcsServiceDeploymentControllerDetails deploymentController)	Contains the deployment controller type that the service uses.
AwsEcsServiceDetails.Builder	desiredCount(Integer desiredCount)	The number of instantiations of the task definition to run on the service.
AwsEcsServiceDetails.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Whether to enable Amazon ECS managed tags for the tasks in the service.
AwsEcsServiceDetails.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Whether the execute command functionality is enabled for the service.
AwsEcsServiceDetails.Builder	healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)	After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.
AwsEcsServiceDetails.Builder	launchType(String launchType)	The launch type that the service uses.
AwsEcsServiceDetails.Builder	loadBalancers(Collection<AwsEcsServiceLoadBalancersDetails> loadBalancers)	Information about the load balancers that the service uses.
AwsEcsServiceDetails.Builder	loadBalancers(Consumer<AwsEcsServiceLoadBalancersDetails.Builder>... loadBalancers)	Information about the load balancers that the service uses.
AwsEcsServiceDetails.Builder	loadBalancers(AwsEcsServiceLoadBalancersDetails... loadBalancers)	Information about the load balancers that the service uses.
AwsEcsServiceDetails.Builder	name(String name)	The name of the service.
default AwsEcsServiceDetails.Builder	networkConfiguration(Consumer<AwsEcsServiceNetworkConfigurationDetails.Builder> networkConfiguration)	For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.
AwsEcsServiceDetails.Builder	networkConfiguration(AwsEcsServiceNetworkConfigurationDetails networkConfiguration)	For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.
AwsEcsServiceDetails.Builder	placementConstraints(Collection<AwsEcsServicePlacementConstraintsDetails> placementConstraints)	The placement constraints for the tasks in the service.
AwsEcsServiceDetails.Builder	placementConstraints(Consumer<AwsEcsServicePlacementConstraintsDetails.Builder>... placementConstraints)	The placement constraints for the tasks in the service.
AwsEcsServiceDetails.Builder	placementConstraints(AwsEcsServicePlacementConstraintsDetails... placementConstraints)	The placement constraints for the tasks in the service.
AwsEcsServiceDetails.Builder	placementStrategies(Collection<AwsEcsServicePlacementStrategiesDetails> placementStrategies)	Information about how tasks for the service are placed.
AwsEcsServiceDetails.Builder	placementStrategies(Consumer<AwsEcsServicePlacementStrategiesDetails.Builder>... placementStrategies)	Information about how tasks for the service are placed.
AwsEcsServiceDetails.Builder	placementStrategies(AwsEcsServicePlacementStrategiesDetails... placementStrategies)	Information about how tasks for the service are placed.
AwsEcsServiceDetails.Builder	platformVersion(String platformVersion)	The platform version on which to run the service.
AwsEcsServiceDetails.Builder	propagateTags(String propagateTags)	Indicates whether to propagate the tags from the task definition to the task or from the service to the task.
AwsEcsServiceDetails.Builder	role(String role)	The ARN of the IAM role that is associated with the service.
AwsEcsServiceDetails.Builder	schedulingStrategy(String schedulingStrategy)	The scheduling strategy to use for the service.
AwsEcsServiceDetails.Builder	serviceArn(String serviceArn)	The ARN of the service.
AwsEcsServiceDetails.Builder	serviceName(String serviceName)	The name of the service.
AwsEcsServiceDetails.Builder	serviceRegistries(Collection<AwsEcsServiceServiceRegistriesDetails> serviceRegistries)	Information about the service discovery registries to assign to the service.
AwsEcsServiceDetails.Builder	serviceRegistries(Consumer<AwsEcsServiceServiceRegistriesDetails.Builder>... serviceRegistries)	Information about the service discovery registries to assign to the service.
AwsEcsServiceDetails.Builder	serviceRegistries(AwsEcsServiceServiceRegistriesDetails... serviceRegistries)	Information about the service discovery registries to assign to the service.
AwsEcsServiceDetails.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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

capacityProviderStrategy

AwsEcsServiceDetails.Builder capacityProviderStrategy(Collection<AwsEcsServiceCapacityProviderStrategyDetails> capacityProviderStrategy)

The capacity provider strategy that the service uses.

Parameters:

capacityProviderStrategy - The capacity provider strategy that the service uses.

Returns:

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

capacityProviderStrategy

AwsEcsServiceDetails.Builder capacityProviderStrategy(AwsEcsServiceCapacityProviderStrategyDetails... capacityProviderStrategy)

The capacity provider strategy that the service uses.

Parameters:

capacityProviderStrategy - The capacity provider strategy that the service uses.

Returns:

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

capacityProviderStrategy

AwsEcsServiceDetails.Builder capacityProviderStrategy(Consumer<AwsEcsServiceCapacityProviderStrategyDetails.Builder>... capacityProviderStrategy)

The capacity provider strategy that the service uses.

This is a convenience method that creates an instance of the AwsEcsServiceCapacityProviderStrategyDetails.Builder avoiding the need to create one manually via AwsEcsServiceCapacityProviderStrategyDetails.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityProviderStrategy(List<AwsEcsServiceCapacityProviderStrategyDetails>).

Parameters:

capacityProviderStrategy - a consumer that will call methods on AwsEcsServiceCapacityProviderStrategyDetails.Builder

Returns:

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

See Also:

• capacityProviderStrategy(java.util.Collection<AwsEcsServiceCapacityProviderStrategyDetails>)

cluster

AwsEcsServiceDetails.Builder cluster(String cluster)

The ARN of the cluster that hosts the service.

Parameters:

cluster - The ARN of the cluster that hosts the service.

Returns:

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

deploymentConfiguration

AwsEcsServiceDetails.Builder deploymentConfiguration(AwsEcsServiceDeploymentConfigurationDetails deploymentConfiguration)

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

Parameters:

deploymentConfiguration - Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

Returns:

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

deploymentConfiguration

default AwsEcsServiceDetails.Builder deploymentConfiguration(Consumer<AwsEcsServiceDeploymentConfigurationDetails.Builder> deploymentConfiguration)

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

This is a convenience method that creates an instance of the AwsEcsServiceDeploymentConfigurationDetails.Builder avoiding the need to create one manually via AwsEcsServiceDeploymentConfigurationDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentConfiguration(AwsEcsServiceDeploymentConfigurationDetails).

Parameters:

deploymentConfiguration - a consumer that will call methods on AwsEcsServiceDeploymentConfigurationDetails.Builder

Returns:

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

See Also:

• deploymentConfiguration(AwsEcsServiceDeploymentConfigurationDetails)

deploymentController

AwsEcsServiceDetails.Builder deploymentController(AwsEcsServiceDeploymentControllerDetails deploymentController)

Contains the deployment controller type that the service uses.

Parameters:

deploymentController - Contains the deployment controller type that the service uses.

Returns:

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

deploymentController

default AwsEcsServiceDetails.Builder deploymentController(Consumer<AwsEcsServiceDeploymentControllerDetails.Builder> deploymentController)

Contains the deployment controller type that the service uses.

This is a convenience method that creates an instance of the AwsEcsServiceDeploymentControllerDetails.Builder avoiding the need to create one manually via AwsEcsServiceDeploymentControllerDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentController(AwsEcsServiceDeploymentControllerDetails).

Parameters:

deploymentController - a consumer that will call methods on AwsEcsServiceDeploymentControllerDetails.Builder

Returns:

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

See Also:

• deploymentController(AwsEcsServiceDeploymentControllerDetails)

desiredCount

AwsEcsServiceDetails.Builder desiredCount(Integer desiredCount)

The number of instantiations of the task definition to run on the service.

Parameters:

desiredCount - The number of instantiations of the task definition to run on the service.

Returns:

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

enableEcsManagedTags

AwsEcsServiceDetails.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Whether to enable Amazon ECS managed tags for the tasks in the service.

Parameters:

enableEcsManagedTags - Whether to enable Amazon ECS managed tags for the tasks in the service.

Returns:

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

enableExecuteCommand

AwsEcsServiceDetails.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Whether the execute command functionality is enabled for the service.

Parameters:

enableExecuteCommand - Whether the execute command functionality is enabled for the service.

Returns:

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

healthCheckGracePeriodSeconds

AwsEcsServiceDetails.Builder healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)

After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.

Parameters:

healthCheckGracePeriodSeconds - After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.

Returns:

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

launchType

AwsEcsServiceDetails.Builder launchType(String launchType)

The launch type that the service uses.

Valid values: EC2 | FARGATE | EXTERNAL

Parameters:

launchType - The launch type that the service uses.

Valid values: EC2 | FARGATE | EXTERNAL

Returns:

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

loadBalancers

AwsEcsServiceDetails.Builder loadBalancers(Collection<AwsEcsServiceLoadBalancersDetails> loadBalancers)

Information about the load balancers that the service uses.

Parameters:

loadBalancers - Information about the load balancers that the service uses.

Returns:

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

loadBalancers

AwsEcsServiceDetails.Builder loadBalancers(AwsEcsServiceLoadBalancersDetails... loadBalancers)

Information about the load balancers that the service uses.

Parameters:

loadBalancers - Information about the load balancers that the service uses.

Returns:

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

loadBalancers

AwsEcsServiceDetails.Builder loadBalancers(Consumer<AwsEcsServiceLoadBalancersDetails.Builder>... loadBalancers)

Information about the load balancers that the service uses.

This is a convenience method that creates an instance of the AwsEcsServiceLoadBalancersDetails.Builder avoiding the need to create one manually via AwsEcsServiceLoadBalancersDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loadBalancers(List<AwsEcsServiceLoadBalancersDetails>).

Parameters:

loadBalancers - a consumer that will call methods on AwsEcsServiceLoadBalancersDetails.Builder

Returns:

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

See Also:

• loadBalancers(java.util.Collection<AwsEcsServiceLoadBalancersDetails>)

name

AwsEcsServiceDetails.Builder name(String name)

The name of the service.

Parameters:

name - The name of the service.

Returns:

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

networkConfiguration

AwsEcsServiceDetails.Builder networkConfiguration(AwsEcsServiceNetworkConfigurationDetails networkConfiguration)

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

Parameters:

networkConfiguration - For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

Returns:

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

networkConfiguration

default AwsEcsServiceDetails.Builder networkConfiguration(Consumer<AwsEcsServiceNetworkConfigurationDetails.Builder> networkConfiguration)

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

This is a convenience method that creates an instance of the AwsEcsServiceNetworkConfigurationDetails.Builder avoiding the need to create one manually via AwsEcsServiceNetworkConfigurationDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(AwsEcsServiceNetworkConfigurationDetails).

Parameters:

networkConfiguration - a consumer that will call methods on AwsEcsServiceNetworkConfigurationDetails.Builder

Returns:

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

See Also:

• networkConfiguration(AwsEcsServiceNetworkConfigurationDetails)

placementConstraints

AwsEcsServiceDetails.Builder placementConstraints(Collection<AwsEcsServicePlacementConstraintsDetails> 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

AwsEcsServiceDetails.Builder placementConstraints(AwsEcsServicePlacementConstraintsDetails... 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

AwsEcsServiceDetails.Builder placementConstraints(Consumer<AwsEcsServicePlacementConstraintsDetails.Builder>... placementConstraints)

The placement constraints for the tasks in the service.

This is a convenience method that creates an instance of the AwsEcsServicePlacementConstraintsDetails.Builder avoiding the need to create one manually via AwsEcsServicePlacementConstraintsDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placementConstraints(List<AwsEcsServicePlacementConstraintsDetails>).

Parameters:

placementConstraints - a consumer that will call methods on AwsEcsServicePlacementConstraintsDetails.Builder

Returns:

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

See Also:

• placementConstraints(java.util.Collection<AwsEcsServicePlacementConstraintsDetails>)

placementStrategies

AwsEcsServiceDetails.Builder placementStrategies(Collection<AwsEcsServicePlacementStrategiesDetails> placementStrategies)

Information about how tasks for the service are placed.

Parameters:

placementStrategies - Information about how tasks for the service are placed.

Returns:

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

placementStrategies

AwsEcsServiceDetails.Builder placementStrategies(AwsEcsServicePlacementStrategiesDetails... placementStrategies)

Information about how tasks for the service are placed.

Parameters:

placementStrategies - Information about how tasks for the service are placed.

Returns:

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

placementStrategies

AwsEcsServiceDetails.Builder placementStrategies(Consumer<AwsEcsServicePlacementStrategiesDetails.Builder>... placementStrategies)

Information about how tasks for the service are placed.

This is a convenience method that creates an instance of the AwsEcsServicePlacementStrategiesDetails.Builder avoiding the need to create one manually via AwsEcsServicePlacementStrategiesDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placementStrategies(List<AwsEcsServicePlacementStrategiesDetails>).

Parameters:

placementStrategies - a consumer that will call methods on AwsEcsServicePlacementStrategiesDetails.Builder

Returns:

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

See Also:

• placementStrategies(java.util.Collection<AwsEcsServicePlacementStrategiesDetails>)

platformVersion

AwsEcsServiceDetails.Builder platformVersion(String platformVersion)

The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.

Parameters:

platformVersion - The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.

Returns:

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

propagateTags

AwsEcsServiceDetails.Builder propagateTags(String propagateTags)

Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.

Valid values: TASK_DEFINITION | SERVICE

Parameters:

propagateTags - Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.

Valid values: TASK_DEFINITION | SERVICE

Returns:

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

role

AwsEcsServiceDetails.Builder role(String role)

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

Parameters:

role - The ARN of the IAM role that is associated with the service. The role 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.

schedulingStrategy

AwsEcsServiceDetails.Builder schedulingStrategy(String schedulingStrategy)

The scheduling strategy to use for the service.

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that don't meet the placement constraints.

Valid values: REPLICA | DAEMON

Parameters:

schedulingStrategy - The scheduling strategy to use for the service.

The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.

The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that don't meet the placement constraints.

Valid values: REPLICA | DAEMON

Returns:

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

serviceArn

AwsEcsServiceDetails.Builder serviceArn(String serviceArn)

The ARN of the service.

Parameters:

serviceArn - The ARN of the service.

Returns:

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

serviceName

AwsEcsServiceDetails.Builder serviceName(String serviceName)

The name of the service.

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

Parameters:

serviceName - The name of the service.

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

Returns:

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

serviceRegistries

AwsEcsServiceDetails.Builder serviceRegistries(Collection<AwsEcsServiceServiceRegistriesDetails> serviceRegistries)

Information about the service discovery registries to assign to the service.

Parameters:

serviceRegistries - Information about the service discovery registries to assign to the service.

Returns:

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

serviceRegistries

AwsEcsServiceDetails.Builder serviceRegistries(AwsEcsServiceServiceRegistriesDetails... serviceRegistries)

Information about the service discovery registries to assign to the service.

Parameters:

serviceRegistries - Information about the service discovery registries to assign to the service.

Returns:

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

serviceRegistries

AwsEcsServiceDetails.Builder serviceRegistries(Consumer<AwsEcsServiceServiceRegistriesDetails.Builder>... serviceRegistries)

Information about the service discovery registries to assign to the service.

This is a convenience method that creates an instance of the AwsEcsServiceServiceRegistriesDetails.Builder avoiding the need to create one manually via AwsEcsServiceServiceRegistriesDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceRegistries(List<AwsEcsServiceServiceRegistriesDetails>).

Parameters:

serviceRegistries - a consumer that will call methods on AwsEcsServiceServiceRegistriesDetails.Builder

Returns:

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

See Also:

• serviceRegistries(java.util.Collection<AwsEcsServiceServiceRegistriesDetails>)

taskDefinition

AwsEcsServiceDetails.Builder taskDefinition(String taskDefinition)

The task definition to use for tasks in the service.

Parameters:

taskDefinition - The task definition to use for tasks in the service.

Returns:

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