Service.Builder (AWS Java SDK :: Services :: Amazon EC2 Container Service 2.16.50 API)

All Superinterfaces:

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

Enclosing class:

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Service.Builder`	`capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)` The capacity provider strategy associated with the service.
`Service.Builder`	`capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)` The capacity provider strategy associated with the service.
`Service.Builder`	`capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)` The capacity provider strategy associated with the service.
`Service.Builder`	`clusterArn(String clusterArn)` The Amazon Resource Name (ARN) of the cluster that hosts the service.
`Service.Builder`	`createdAt(Instant createdAt)` The Unix timestamp for when the service was created.
`Service.Builder`	`createdBy(String createdBy)` The principal that created the service.
`default Service.Builder`	`deploymentConfiguration(Consumer<DeploymentConfiguration.Builder> deploymentConfiguration)` Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
`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.
`default Service.Builder`	`deploymentController(Consumer<DeploymentController.Builder> deploymentController)` The deployment controller type the service is using.
`Service.Builder`	`deploymentController(DeploymentController deploymentController)` The deployment controller type the service is using.
`Service.Builder`	`deployments(Collection<Deployment> deployments)` The current state of deployments for the service.
`Service.Builder`	`deployments(Consumer<Deployment.Builder>... 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`	`enableECSManagedTags(Boolean enableECSManagedTags)` Specifies whether to enable Amazon ECS managed tags for the tasks in the service.
`Service.Builder`	`enableExecuteCommand(Boolean enableExecuteCommand)` Whether or not the execute command functionality is enabled for the service.
`Service.Builder`	`events(Collection<ServiceEvent> events)` The event stream for your service.
`Service.Builder`	`events(Consumer<ServiceEvent.Builder>... events)` The event stream for your service.
`Service.Builder`	`events(ServiceEvent... events)` The event stream for your service.
`Service.Builder`	`healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)` The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
`Service.Builder`	`launchType(LaunchType launchType)` The launch type on which your service is running.
`Service.Builder`	`launchType(String launchType)` The launch type on which your service is running.
`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(Consumer<LoadBalancer.Builder>... 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.
`default Service.Builder`	`networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)` The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the `awsvpc` networking mode.
`Service.Builder`	`networkConfiguration(NetworkConfiguration networkConfiguration)` The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the `awsvpc` networking mode.
`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(Consumer<PlacementConstraint.Builder>... 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(Consumer<PlacementStrategy.Builder>... 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`	`platformVersion(String platformVersion)` The platform version on which to run your service.
`Service.Builder`	`propagateTags(PropagateTags propagateTags)` Specifies whether to propagate the tags from the task definition or the service to the task.
`Service.Builder`	`propagateTags(String propagateTags)` Specifies whether to propagate the tags from the task definition or the service to the task.
`Service.Builder`	`roleArn(String roleArn)` The 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`	`schedulingStrategy(SchedulingStrategy schedulingStrategy)` The scheduling strategy to use for the service.
`Service.Builder`	`schedulingStrategy(String schedulingStrategy)` The scheduling strategy to use for the service.
`Service.Builder`	`serviceArn(String serviceArn)` The ARN that identifies the service.
`Service.Builder`	`serviceName(String serviceName)` The name of your service.
`Service.Builder`	`serviceRegistries(Collection<ServiceRegistry> serviceRegistries)` The details of the service discovery registries to assign to this service.
`Service.Builder`	`serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)` The details of the service discovery registries to assign to this service.
`Service.Builder`	`serviceRegistries(ServiceRegistry... serviceRegistries)` The details of the service discovery registries to assign to this service.
`Service.Builder`	`status(String status)` The status of the service.
`Service.Builder`	`tags(Collection<Tag> tags)` The metadata that you apply to the service to help you categorize and organize them.
`Service.Builder`	`tags(Consumer<Tag.Builder>... tags)` The metadata that you apply to the service to help you categorize and organize them.
`Service.Builder`	`tags(Tag... tags)` The metadata that you apply to the service to help you categorize and organize them.
`Service.Builder`	`taskDefinition(String taskDefinition)` The task definition to use for tasks in the service.
`Service.Builder`	`taskSets(Collection<TaskSet> taskSets)` Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an `EXTERNAL` deployment.
`Service.Builder`	`taskSets(Consumer<TaskSet.Builder>... taskSets)` Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an `EXTERNAL` deployment.
`Service.Builder`	`taskSets(TaskSet... taskSets)` Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an `EXTERNAL` deployment.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - serviceArn
```
Service.Builder serviceArn(String serviceArn)
```
    The 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 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, and hyphens 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, and hyphens 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.
    
    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(Consumer<LoadBalancer.Builder>... 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.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #loadBalancers(List).
    
    Parameters:
    
    loadBalancers - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #loadBalancers(List)
  - serviceRegistries
```
Service.Builder serviceRegistries(Collection<ServiceRegistry> serviceRegistries)
```
    The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
    
    Parameters:
    
    serviceRegistries - The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serviceRegistries
```
Service.Builder serviceRegistries(ServiceRegistry... serviceRegistries)
```
    The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
    
    Parameters:
    
    serviceRegistries - The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serviceRegistries
```
Service.Builder serviceRegistries(Consumer<ServiceRegistry.Builder>... serviceRegistries)
```
    The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #serviceRegistries(List).
    
    Parameters:
    
    serviceRegistries - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #serviceRegistries(List)
  - 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.
  - launchType
```
Service.Builder launchType(String launchType)
```
    The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    launchType - The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LaunchType, LaunchType
  - launchType
```
Service.Builder launchType(LaunchType launchType)
```
    The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    launchType - The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    LaunchType, LaunchType
  - capacityProviderStrategy
```
Service.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
```
    The capacity provider strategy associated with the service.
    
    Parameters:
    
    capacityProviderStrategy - The capacity provider strategy associated with the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capacityProviderStrategy
```
Service.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
```
    The capacity provider strategy associated with the service.
    
    Parameters:
    
    capacityProviderStrategy - The capacity provider strategy associated with the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - capacityProviderStrategy
```
Service.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)
```
    The capacity provider strategy associated with the service.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #capacityProviderStrategy(List) .
    
    Parameters:
    
    capacityProviderStrategy - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #capacityProviderStrategy(List)
  - platformVersion
```
Service.Builder platformVersion(String platformVersion)
```
    The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    platformVersion - The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
    
    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.
  - deploymentConfiguration
```
default Service.Builder deploymentConfiguration(Consumer<DeploymentConfiguration.Builder> deploymentConfiguration)
```
    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
    This is a convenience that creates an instance of the DeploymentConfiguration.Builder avoiding the need to create one manually via DeploymentConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentConfiguration(DeploymentConfiguration).
    
    Parameters:
    
    deploymentConfiguration - a consumer that will call methods on DeploymentConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    deploymentConfiguration(DeploymentConfiguration)
  - taskSets
```
Service.Builder taskSets(Collection<TaskSet> taskSets)
```
    Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
    
    Parameters:
    
    taskSets - Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - taskSets
```
Service.Builder taskSets(TaskSet... taskSets)
```
    Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
    
    Parameters:
    
    taskSets - Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - taskSets
```
Service.Builder taskSets(Consumer<TaskSet.Builder>... taskSets)
```
    Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #taskSets(List).
    
    Parameters:
    
    taskSets - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #taskSets(List)
  - 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.
    
    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(Consumer<Deployment.Builder>... deployments)
```
    The current state of deployments for the service.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #deployments(List).
    
    Parameters:
    
    deployments - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #deployments(List)
  - roleArn
```
Service.Builder roleArn(String roleArn)
```
    The 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 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.
    
    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(Consumer<ServiceEvent.Builder>... events)
```
    The event stream for your service. A maximum of 100 of the latest events are displayed.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #events(List).
    
    Parameters:
    
    events - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #events(List)
  - createdAt
```
Service.Builder createdAt(Instant 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.
    
    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(Consumer<PlacementConstraint.Builder>... placementConstraints)
```
    The placement constraints for the tasks in the service.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #placementConstraints(List).
    
    Parameters:
    
    placementConstraints - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #placementConstraints(List)
  - 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.
    
    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(Consumer<PlacementStrategy.Builder>... placementStrategy)
```
    The placement strategy that determines how tasks for the service are placed.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #placementStrategy(List).
    
    Parameters:
    
    placementStrategy - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #placementStrategy(List)
  - networkConfiguration
```
Service.Builder networkConfiguration(NetworkConfiguration networkConfiguration)
```
    The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
    
    Parameters:
    
    networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - networkConfiguration
```
default Service.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)
```
    The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
    This is a convenience that creates an instance of the NetworkConfiguration.Builder avoiding the need to create one manually via NetworkConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).
    
    Parameters:
    
    networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    networkConfiguration(NetworkConfiguration)
  - healthCheckGracePeriodSeconds
```
Service.Builder healthCheckGracePeriodSeconds(Integer healthCheckGracePeriodSeconds)
```
    The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
    
    Parameters:
    
    healthCheckGracePeriodSeconds - The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - schedulingStrategy
```
Service.Builder schedulingStrategy(String schedulingStrategy)
```
    The scheduling strategy to use for the service. For more information, see Services.
    
    There are two service scheduler strategies available:
    - REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
    - DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.
      
      Fargate tasks do not support the DAEMON scheduling strategy.
    Parameters:
    schedulingStrategy - The scheduling strategy to use for the service. For more information, see Services.
    
    There are two service scheduler strategies available:
    
    REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
    
    DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.
    
    Fargate tasks do not support the DAEMON scheduling strategy.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SchedulingStrategy, SchedulingStrategy
  - schedulingStrategy
```
Service.Builder schedulingStrategy(SchedulingStrategy schedulingStrategy)
```
    The scheduling strategy to use for the service. For more information, see Services.
    
    There are two service scheduler strategies available:
    - REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
    - DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.
      
      Fargate tasks do not support the DAEMON scheduling strategy.
    Parameters:
    schedulingStrategy - The scheduling strategy to use for the service. For more information, see Services.
    
    There are two service scheduler strategies available:
    
    REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.
    
    DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not meet the placement constraints.
    
    Fargate tasks do not support the DAEMON scheduling strategy.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SchedulingStrategy, SchedulingStrategy
  - deploymentController
```
Service.Builder deploymentController(DeploymentController deploymentController)
```
    The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
    
    Parameters:
    
    deploymentController - The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - deploymentController
```
default Service.Builder deploymentController(Consumer<DeploymentController.Builder> deploymentController)
```
    The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
    This is a convenience that creates an instance of the DeploymentController.Builder avoiding the need to create one manually via DeploymentController.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deploymentController(DeploymentController).
    
    Parameters:
    
    deploymentController - a consumer that will call methods on DeploymentController.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    deploymentController(DeploymentController)
  - tags
```
Service.Builder tags(Collection<Tag> tags)
```
    The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Parameters:
    tags - The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
Service.Builder tags(Tag... tags)
```
    The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Parameters:
    tags - The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    
    Maximum number of tags per resource - 50
    
    For each resource, each tag key must be unique, and each tag key can have only one value.
    
    Maximum key length - 128 Unicode characters in UTF-8
    
    Maximum value length - 256 Unicode characters in UTF-8
    
    If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    
    Tag keys and values are case-sensitive.
    
    Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
Service.Builder tags(Consumer<Tag.Builder>... tags)
```
    The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
    
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).
    Parameters:
    
    tags - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(List)
  - createdBy
```
Service.Builder createdBy(String createdBy)
```
    The principal that created the service.
    
    Parameters:
    
    createdBy - The principal that created the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - enableECSManagedTags
```
Service.Builder enableECSManagedTags(Boolean enableECSManagedTags)
```
    Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
    
    Parameters:
    
    enableECSManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - propagateTags
```
Service.Builder propagateTags(String propagateTags)
```
    Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
    
    Parameters:
    
    propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropagateTags, PropagateTags
  - propagateTags
```
Service.Builder propagateTags(PropagateTags propagateTags)
```
    Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
    
    Parameters:
    
    propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PropagateTags, PropagateTags
  - enableExecuteCommand
```
Service.Builder enableExecuteCommand(Boolean enableExecuteCommand)
```
    Whether or not the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.
    
    Parameters:
    
    enableExecuteCommand - Whether or not the execute command functionality is enabled for the service. If true, the execute command functionality is enabled for all containers in tasks as part of the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.

Interface Service.Builder

Method Summary

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

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

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

Method Detail

serviceArn

serviceName

clusterArn

loadBalancers

loadBalancers

loadBalancers

serviceRegistries

serviceRegistries

serviceRegistries

status

desiredCount

runningCount

pendingCount

launchType

launchType

capacityProviderStrategy

capacityProviderStrategy

capacityProviderStrategy

platformVersion

taskDefinition

deploymentConfiguration

deploymentConfiguration

taskSets

taskSets

taskSets

deployments

deployments

deployments

roleArn

events

events

events

createdAt

placementConstraints

placementConstraints

placementConstraints

placementStrategy

placementStrategy

placementStrategy

networkConfiguration

networkConfiguration

healthCheckGracePeriodSeconds

schedulingStrategy

schedulingStrategy

deploymentController

deploymentController

tags

tags

tags

createdBy

enableECSManagedTags

propagateTags

propagateTags

enableExecuteCommand