Package software.amazon.awscdk.services.ecs

Class BaseServiceOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.BaseServiceOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BaseServiceOptions>

Enclosing interface:

BaseServiceOptions

@Stability(Stable)
public static final class BaseServiceOptions.Builder
extends Object
implements software.amazon.jsii.Builder<BaseServiceOptions>

A builder for BaseServiceOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BaseServiceOptions	build()	Builds the configured instance.
BaseServiceOptions.Builder	capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)	Sets the value of BaseServiceOptions.getCapacityProviderStrategies()
BaseServiceOptions.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker)	Sets the value of BaseServiceOptions.getCircuitBreaker()
BaseServiceOptions.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of BaseServiceOptions.getCloudMapOptions()
BaseServiceOptions.Builder	cluster(ICluster cluster)	Sets the value of BaseServiceOptions.getCluster()
BaseServiceOptions.Builder	deploymentController(DeploymentController deploymentController)	Sets the value of BaseServiceOptions.getDeploymentController()
BaseServiceOptions.Builder	desiredCount(Number desiredCount)	Sets the value of BaseServiceOptions.getDesiredCount()
BaseServiceOptions.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link BaseServiceOptions#getEnableEcsManagedTags
BaseServiceOptions.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of BaseServiceOptions.getEnableExecuteCommand()
BaseServiceOptions.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of BaseServiceOptions.getHealthCheckGracePeriod()
BaseServiceOptions.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of BaseServiceOptions.getMaxHealthyPercent()
BaseServiceOptions.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of BaseServiceOptions.getMinHealthyPercent()
BaseServiceOptions.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of BaseServiceOptions.getPropagateTags()
BaseServiceOptions.Builder	propagateTaskTagsFrom(PropagatedTagSource propagateTaskTagsFrom)	Deprecated. Use `propagateTags` instead.
BaseServiceOptions.Builder	serviceName(String serviceName)	Sets the value of BaseServiceOptions.getServiceName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

cluster

@Stability(Stable)
public BaseServiceOptions.Builder cluster(ICluster cluster)

Sets the value of BaseServiceOptions.getCluster()

Parameters:

cluster - The name of the cluster that hosts the service. This parameter is required.

Returns:

this

capacityProviderStrategies

@Stability(Stable)
public BaseServiceOptions.Builder capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)

Sets the value of BaseServiceOptions.getCapacityProviderStrategies()

Parameters:

capacityProviderStrategies - A list of Capacity Provider strategies used to place a service.

Returns:

this

circuitBreaker

@Stability(Stable)
public BaseServiceOptions.Builder circuitBreaker(DeploymentCircuitBreaker circuitBreaker)

Sets the value of BaseServiceOptions.getCircuitBreaker()

Parameters:

circuitBreaker - Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled.

Returns:

this

cloudMapOptions

@Stability(Stable)
public BaseServiceOptions.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)

Sets the value of BaseServiceOptions.getCloudMapOptions()

Parameters:

cloudMapOptions - The options for configuring an Amazon ECS service to use service discovery.

Returns:

this

deploymentController

@Stability(Stable)
public BaseServiceOptions.Builder deploymentController(DeploymentController deploymentController)

Sets the value of BaseServiceOptions.getDeploymentController()

Parameters:

deploymentController - Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types

Returns:

this

desiredCount

@Stability(Stable)
public BaseServiceOptions.Builder desiredCount(Number desiredCount)

Sets the value of BaseServiceOptions.getDesiredCount()

Parameters:

desiredCount - The desired number of instantiations of the task definition to keep running on the service.

Returns:

this

enableEcsManagedTags

@Stability(Stable)
public BaseServiceOptions.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of

invalid @link

BaseServiceOptions#getEnableEcsManagedTags

Parameters:

enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources

Returns:

this

enableExecuteCommand

@Stability(Stable)
public BaseServiceOptions.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of BaseServiceOptions.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether to enable the ability to execute into a container.

Returns:

this

healthCheckGracePeriod

@Stability(Stable)
public BaseServiceOptions.Builder healthCheckGracePeriod(Duration healthCheckGracePeriod)

Sets the value of BaseServiceOptions.getHealthCheckGracePeriod()

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.

Returns:

this

maxHealthyPercent

@Stability(Stable)
public BaseServiceOptions.Builder maxHealthyPercent(Number maxHealthyPercent)

Sets the value of BaseServiceOptions.getMaxHealthyPercent()

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.

Returns:

this

minHealthyPercent

@Stability(Stable)
public BaseServiceOptions.Builder minHealthyPercent(Number minHealthyPercent)

Sets the value of BaseServiceOptions.getMinHealthyPercent()

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.

Returns:

this

propagateTags

@Stability(Stable)
public BaseServiceOptions.Builder propagateTags(PropagatedTagSource propagateTags)

Sets the value of BaseServiceOptions.getPropagateTags()

Parameters:

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

Returns:

this

propagateTaskTagsFrom

@Stability(Deprecated)
@Deprecated
public BaseServiceOptions.Builder propagateTaskTagsFrom(PropagatedTagSource propagateTaskTagsFrom)

Deprecated.

Use `propagateTags` instead.

Sets the value of BaseServiceOptions.getPropagateTaskTagsFrom()

Parameters:

propagateTaskTagsFrom - 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.

Returns:

this

serviceName

@Stability(Stable)
public BaseServiceOptions.Builder serviceName(String serviceName)

Sets the value of BaseServiceOptions.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

build

@Stability(Stable)
public BaseServiceOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BaseServiceOptions>

Returns:

a new instance of BaseServiceOptions

Throws:

NullPointerException - if any required attribute was not provided