ExternalService.Builder

java.lang.Object
- software.amazon.awscdk.services.ecs.ExternalService.Builder

Enclosing class:: ExternalService

public static final class ExternalService.Builder
extends java.lang.Object

A fluent builder for ExternalService.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ExternalService`	`build()`
`ExternalService.Builder`	`capacityProviderStrategies(java.util.List<? extends CapacityProviderStrategy> capacityProviderStrategies)` A list of Capacity Provider strategies used to place a service.
`ExternalService.Builder`	`circuitBreaker(DeploymentCircuitBreaker circuitBreaker)` Whether to enable the deployment circuit breaker.
`ExternalService.Builder`	`cloudMapOptions(CloudMapOptions cloudMapOptions)` The options for configuring an Amazon ECS service to use service discovery.
`ExternalService.Builder`	`cluster(ICluster cluster)` The name of the cluster that hosts the service.
`static ExternalService.Builder`	`create(software.constructs.Construct scope, java.lang.String id)`
`ExternalService.Builder`	`deploymentController(DeploymentController deploymentController)` Specifies which deployment controller to use for the service.
`ExternalService.Builder`	`desiredCount(java.lang.Number desiredCount)` The desired number of instantiations of the task definition to keep running on the service.
`ExternalService.Builder`	`enableEcsManagedTags(java.lang.Boolean enableEcsManagedTags)` Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
`ExternalService.Builder`	`enableExecuteCommand(java.lang.Boolean enableExecuteCommand)` Whether to enable the ability to execute into a container.
`ExternalService.Builder`	`healthCheckGracePeriod(Duration healthCheckGracePeriod)` 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.
`ExternalService.Builder`	`maxHealthyPercent(java.lang.Number maxHealthyPercent)` The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
`ExternalService.Builder`	`minHealthyPercent(java.lang.Number minHealthyPercent)` The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
`ExternalService.Builder`	`propagateTags(PropagatedTagSource propagateTags)` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`ExternalService.Builder`	`propagateTaskTagsFrom(PropagatedTagSource propagateTaskTagsFrom)` Deprecated. Use `propagateTags` instead.
`ExternalService.Builder`	`securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)` The security groups to associate with the service.
`ExternalService.Builder`	`serviceName(java.lang.String serviceName)` The name of the service.
`ExternalService.Builder`	`taskDefinition(TaskDefinition taskDefinition)` The task definition to use for tasks in the service.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static ExternalService.Builder create(software.constructs.Construct scope,
                                             java.lang.String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of ExternalService.Builder.
  - cluster
```
public ExternalService.Builder cluster(ICluster cluster)
```
    The name of the cluster that hosts the service.
    
    Parameters:
    
    cluster - The name of the cluster that hosts the service. This parameter is required.
    
    Returns:
    
    this
  - capacityProviderStrategies
```
public ExternalService.Builder capacityProviderStrategies(java.util.List<? extends CapacityProviderStrategy> capacityProviderStrategies)
```
    A list of Capacity Provider strategies used to place a service.
    Default: - undefined
    
    Parameters:
    
    capacityProviderStrategies - A list of Capacity Provider strategies used to place a service. This parameter is required.
    
    Returns:
    
    this
  - circuitBreaker
```
public ExternalService.Builder circuitBreaker(DeploymentCircuitBreaker circuitBreaker)
```
    Whether to enable the deployment circuit breaker.
    If this property is defined, circuit breaker will be implicitly enabled.
    Default: - disabled
    
    Parameters:
    
    circuitBreaker - Whether to enable the deployment circuit breaker. This parameter is required.
    
    Returns:
    
    this
  - cloudMapOptions
```
public ExternalService.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)
```
    The options for configuring an Amazon ECS service to use service discovery.
    Default: - AWS Cloud Map service discovery is not enabled.
    
    Parameters:
    
    cloudMapOptions - The options for configuring an Amazon ECS service to use service discovery. This parameter is required.
    
    Returns:
    
    this
  - deploymentController
```
public ExternalService.Builder deploymentController(DeploymentController deploymentController)
```
    Specifies which deployment controller to use for the service.
    For more information, see Amazon ECS Deployment Types
    Default: - Rolling update (ECS)
    
    Parameters:
    
    deploymentController - Specifies which deployment controller to use for the service. This parameter is required.
    
    Returns:
    
    this
  - desiredCount
```
public ExternalService.Builder desiredCount(java.lang.Number desiredCount)
```
    The desired number of instantiations of the task definition to keep running on the service.
    Default: - When creating the service, default is 1; when updating the service, default uses the current task number.
    
    Parameters:
    
    desiredCount - The desired number of instantiations of the task definition to keep running on the service. This parameter is required.
    
    Returns:
    
    this
  - enableEcsManagedTags
```
public ExternalService.Builder enableEcsManagedTags(java.lang.Boolean enableEcsManagedTags)
```
    Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
    For more information, see Tagging Your Amazon ECS Resources
    Default: false
    
    Parameters:
    
    enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. This parameter is required.
    
    Returns:
    
    this
  - enableExecuteCommand
```
public ExternalService.Builder enableExecuteCommand(java.lang.Boolean enableExecuteCommand)
```
    Whether to enable the ability to execute into a container.
    Default: - undefined
    
    Parameters:
    
    enableExecuteCommand - Whether to enable the ability to execute into a container. This parameter is required.
    
    Returns:
    
    this
  - healthCheckGracePeriod
```
public ExternalService.Builder healthCheckGracePeriod(Duration healthCheckGracePeriod)
```
    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.
    Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
    
    Parameters:
    
    healthCheckGracePeriod - 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. This parameter is required.
    
    Returns:
    
    this
  - maxHealthyPercent
```
public ExternalService.Builder maxHealthyPercent(java.lang.Number maxHealthyPercent)
```
    The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
    Default: - 100 if daemon, otherwise 200
    
    Parameters:
    
    maxHealthyPercent - The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment. This parameter is required.
    
    Returns:
    
    this
  - minHealthyPercent
```
public ExternalService.Builder minHealthyPercent(java.lang.Number minHealthyPercent)
```
    The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
    Default: - 0 if daemon, otherwise 50
    
    Parameters:
    
    minHealthyPercent - The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment. This parameter is required.
    
    Returns:
    
    this
  - propagateTags
```
public ExternalService.Builder propagateTags(PropagatedTagSource propagateTags)
```
    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
    Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE
    Default: PropagatedTagSource.NONE
    
    Parameters:
    
    propagateTags - Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. This parameter is required.
    
    Returns:
    
    this
  - propagateTaskTagsFrom
```
@Deprecated
public ExternalService.Builder propagateTaskTagsFrom(PropagatedTagSource propagateTaskTagsFrom)
```
    Deprecated. Use `propagateTags` instead.
    
    (deprecated) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
    Tags can only be propagated to the tasks within the service during service creation.
    Default: PropagatedTagSource.NONE
    
    Parameters:
    
    propagateTaskTagsFrom - Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. This parameter is required.
    
    Returns:
    
    this
  - serviceName
```
public ExternalService.Builder serviceName(java.lang.String serviceName)
```
    The name of the service.
    Default: - CloudFormation-generated name.
    
    Parameters:
    
    serviceName - The name of the service. This parameter is required.
    
    Returns:
    
    this
  - taskDefinition
```
public ExternalService.Builder taskDefinition(TaskDefinition taskDefinition)
```
    The task definition to use for tasks in the service.
    [disable-awslint:ref-via-interface]
    
    Parameters:
    
    taskDefinition - The task definition to use for tasks in the service. This parameter is required.
    
    Returns:
    
    this
  - securityGroups
```
public ExternalService.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)
```
    The security groups to associate with the service.
    If you do not specify a security group, a new security group is created.
    Default: - A new security group is created.
    
    Parameters:
    
    securityGroups - The security groups to associate with the service. This parameter is required.
    
    Returns:
    
    this
  - build
```
public ExternalService build()
```

Class ExternalService.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

cluster

capacityProviderStrategies

circuitBreaker

cloudMapOptions

deploymentController

desiredCount

enableEcsManagedTags

enableExecuteCommand

healthCheckGracePeriod

maxHealthyPercent

minHealthyPercent

propagateTags

propagateTaskTagsFrom

serviceName

taskDefinition

securityGroups

build