software.amazon.awscdk.services.ecs

Class BaseServiceProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.BaseServiceProps.Builder

Enclosing interface:

BaseServiceProps

@Stability(value=Stable)
public static final class BaseServiceProps.Builder
extends Object

A builder for BaseServiceProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BaseServiceProps	build() Builds the configured instance.
BaseServiceProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions) Sets the value of CloudMapOptions
BaseServiceProps.Builder	cluster(ICluster cluster) Sets the value of Cluster
BaseServiceProps.Builder	desiredCount(Number desiredCount) Sets the value of DesiredCount
BaseServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags) Sets the value of EnableEcsManagedTags
BaseServiceProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod) Sets the value of HealthCheckGracePeriod
BaseServiceProps.Builder	launchType(LaunchType launchType) Sets the value of LaunchType
BaseServiceProps.Builder	maxHealthyPercent(Number maxHealthyPercent) Sets the value of MaxHealthyPercent
BaseServiceProps.Builder	minHealthyPercent(Number minHealthyPercent) Sets the value of MinHealthyPercent
BaseServiceProps.Builder	propagateTags(PropagatedTagSource propagateTags) Sets the value of PropagateTags
BaseServiceProps.Builder	serviceName(String serviceName) Sets the value of ServiceName

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

launchType

@Stability(value=Stable)
public BaseServiceProps.Builder launchType(LaunchType launchType)

Sets the value of LaunchType

Parameters:

launchType - The launch type on which to run your service. This parameter is required.

Returns:

this

cluster

@Stability(value=Stable)
public BaseServiceProps.Builder cluster(ICluster cluster)

Sets the value of Cluster

Parameters:

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

Returns:

this

cloudMapOptions

@Stability(value=Stable)
public BaseServiceProps.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)

Sets the value of CloudMapOptions

Parameters:

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

Returns:

this

desiredCount

@Stability(value=Stable)
public BaseServiceProps.Builder desiredCount(Number desiredCount)

Sets the value of DesiredCount

Parameters:

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

Returns:

this

enableEcsManagedTags

@Stability(value=Stable)
public BaseServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of EnableEcsManagedTags

Parameters:

enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

Returns:

this

healthCheckGracePeriod

@Stability(value=Stable)
public BaseServiceProps.Builder healthCheckGracePeriod(Duration healthCheckGracePeriod)

Sets the value of HealthCheckGracePeriod

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(value=Stable)
public BaseServiceProps.Builder maxHealthyPercent(Number maxHealthyPercent)

Sets the value of MaxHealthyPercent

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(value=Stable)
public BaseServiceProps.Builder minHealthyPercent(Number minHealthyPercent)

Sets the value of MinHealthyPercent

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(value=Stable)
public BaseServiceProps.Builder propagateTags(PropagatedTagSource propagateTags)

Sets the value of PropagateTags

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Returns:

this

serviceName

@Stability(value=Stable)
public BaseServiceProps.Builder serviceName(String serviceName)

Sets the value of ServiceName

Parameters:

serviceName - The name of the service.

Returns:

this

build

@Stability(value=Stable)
public BaseServiceProps build()

Builds the configured instance.

Returns:

a new instance of BaseServiceProps

Throws:

NullPointerException - if any required attribute was not provided