Package software.amazon.awscdk.services.ecs

Class Ec2ServiceProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.Ec2ServiceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Ec2ServiceProps>

Enclosing interface:

Ec2ServiceProps

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

A builder for Ec2ServiceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Ec2ServiceProps.Builder	assignPublicIp(Boolean assignPublicIp)	Sets the value of Ec2ServiceProps.getAssignPublicIp()
Ec2ServiceProps	build()	Builds the configured instance.
Ec2ServiceProps.Builder	capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)	Sets the value of BaseServiceOptions.getCapacityProviderStrategies()
Ec2ServiceProps.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker)	Sets the value of BaseServiceOptions.getCircuitBreaker()
Ec2ServiceProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of BaseServiceOptions.getCloudMapOptions()
Ec2ServiceProps.Builder	cluster(ICluster cluster)	Sets the value of BaseServiceOptions.getCluster()
Ec2ServiceProps.Builder	daemon(Boolean daemon)	Sets the value of Ec2ServiceProps.getDaemon()
Ec2ServiceProps.Builder	deploymentController(DeploymentController deploymentController)	Sets the value of BaseServiceOptions.getDeploymentController()
Ec2ServiceProps.Builder	desiredCount(Number desiredCount)	Sets the value of BaseServiceOptions.getDesiredCount()
Ec2ServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link Ec2ServiceProps#getEnableEcsManagedTags
Ec2ServiceProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of BaseServiceOptions.getEnableExecuteCommand()
Ec2ServiceProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of BaseServiceOptions.getHealthCheckGracePeriod()
Ec2ServiceProps.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of BaseServiceOptions.getMaxHealthyPercent()
Ec2ServiceProps.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of BaseServiceOptions.getMinHealthyPercent()
Ec2ServiceProps.Builder	placementConstraints(List<? extends PlacementConstraint> placementConstraints)	Sets the value of Ec2ServiceProps.getPlacementConstraints()
Ec2ServiceProps.Builder	placementStrategies(List<? extends PlacementStrategy> placementStrategies)	Sets the value of Ec2ServiceProps.getPlacementStrategies()
Ec2ServiceProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of BaseServiceOptions.getPropagateTags()
Ec2ServiceProps.Builder	propagateTaskTagsFrom(PropagatedTagSource propagateTaskTagsFrom)	Deprecated. Use `propagateTags` instead.
Ec2ServiceProps.Builder	securityGroup(ISecurityGroup securityGroup)	Deprecated. use securityGroups instead.
Ec2ServiceProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of Ec2ServiceProps.getSecurityGroups()
Ec2ServiceProps.Builder	serviceName(String serviceName)	Sets the value of BaseServiceOptions.getServiceName()
Ec2ServiceProps.Builder	taskDefinition(TaskDefinition taskDefinition)	Sets the value of Ec2ServiceProps.getTaskDefinition()
Ec2ServiceProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of Ec2ServiceProps.getVpcSubnets()

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

taskDefinition

@Stability(Stable)
public Ec2ServiceProps.Builder taskDefinition(TaskDefinition taskDefinition)

Sets the value of Ec2ServiceProps.getTaskDefinition()

Parameters:

taskDefinition - The task definition to use for tasks in the service. This parameter is required. [disable-awslint:ref-via-interface]

Returns:

this

assignPublicIp

@Stability(Stable)
public Ec2ServiceProps.Builder assignPublicIp(Boolean assignPublicIp)

Sets the value of Ec2ServiceProps.getAssignPublicIp()

Parameters:

assignPublicIp - Specifies whether the task's elastic network interface receives a public IP address. If true, each task will receive a public IP address.

This property is only used for tasks that use the awsvpc network mode.

Returns:

this

daemon

@Stability(Stable)
public Ec2ServiceProps.Builder daemon(Boolean daemon)

Sets the value of Ec2ServiceProps.getDaemon()

Parameters:

daemon - Specifies whether the service will use the daemon scheduling strategy. If true, the service scheduler deploys exactly one task on each container instance in your cluster.

When you are using this strategy, do not specify a desired number of tasks orany task placement strategies.

Returns:

this

placementConstraints

@Stability(Stable)
public Ec2ServiceProps.Builder placementConstraints(List<? extends PlacementConstraint> placementConstraints)

Sets the value of Ec2ServiceProps.getPlacementConstraints()

Parameters:

placementConstraints - The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints.

Returns:

this

placementStrategies

@Stability(Stable)
public Ec2ServiceProps.Builder placementStrategies(List<? extends PlacementStrategy> placementStrategies)

Sets the value of Ec2ServiceProps.getPlacementStrategies()

Parameters:

placementStrategies - The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies.

Returns:

this

securityGroup

@Stability(Deprecated)
@Deprecated
public Ec2ServiceProps.Builder securityGroup(ISecurityGroup securityGroup)

Deprecated.

use securityGroups instead.

Sets the value of Ec2ServiceProps.getSecurityGroup()

Parameters:

securityGroup - The security groups to associate with the service. If you do not specify a security group, a new security group is created.

This property is only used for tasks that use the awsvpc network mode.

Returns:

this

securityGroups

@Stability(Stable)
public Ec2ServiceProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of Ec2ServiceProps.getSecurityGroups()

Parameters:

securityGroups - The security groups to associate with the service. If you do not specify a security group, a new security group is created.

This property is only used for tasks that use the awsvpc network mode.

Returns:

this

vpcSubnets

@Stability(Stable)
public Ec2ServiceProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of Ec2ServiceProps.getVpcSubnets()

Parameters:

vpcSubnets - The subnets to associate with the service. This property is only used for tasks that use the awsvpc network mode.

Returns:

this

cluster

@Stability(Stable)
public Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of

invalid @link

Ec2ServiceProps#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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.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 Ec2ServiceProps.Builder serviceName(String serviceName)

Sets the value of BaseServiceOptions.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

build

@Stability(Stable)
public Ec2ServiceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of Ec2ServiceProps

Throws:

NullPointerException - if any required attribute was not provided