Package software.amazon.awscdk.services.ecs.patterns

Class NetworkLoadBalancedEc2ServiceProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedEc2ServiceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkLoadBalancedEc2ServiceProps>

Enclosing interface:

NetworkLoadBalancedEc2ServiceProps

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

A builder for NetworkLoadBalancedEc2ServiceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NetworkLoadBalancedEc2ServiceProps	build()	Builds the configured instance.
NetworkLoadBalancedEc2ServiceProps.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCircuitBreaker()
NetworkLoadBalancedEc2ServiceProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCloudMapOptions()
NetworkLoadBalancedEc2ServiceProps.Builder	cluster(ICluster cluster)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCluster()
NetworkLoadBalancedEc2ServiceProps.Builder	cpu(Number cpu)	Sets the value of NetworkLoadBalancedEc2ServiceProps.getCpu()
NetworkLoadBalancedEc2ServiceProps.Builder	deploymentController(DeploymentController deploymentController)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDeploymentController()
NetworkLoadBalancedEc2ServiceProps.Builder	desiredCount(Number desiredCount)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDesiredCount()
NetworkLoadBalancedEc2ServiceProps.Builder	domainName(String domainName)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDomainName()
NetworkLoadBalancedEc2ServiceProps.Builder	domainZone(IHostedZone domainZone)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDomainZone()
NetworkLoadBalancedEc2ServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link NetworkLoadBalancedEc2ServiceProps#getEnableEcsManagedTags
NetworkLoadBalancedEc2ServiceProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of NetworkLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()
NetworkLoadBalancedEc2ServiceProps.Builder	listenerPort(Number listenerPort)	Sets the value of NetworkLoadBalancedServiceBaseProps.getListenerPort()
NetworkLoadBalancedEc2ServiceProps.Builder	loadBalancer(INetworkLoadBalancer loadBalancer)	Sets the value of NetworkLoadBalancedServiceBaseProps.getLoadBalancer()
NetworkLoadBalancedEc2ServiceProps.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of NetworkLoadBalancedServiceBaseProps.getMaxHealthyPercent()
NetworkLoadBalancedEc2ServiceProps.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of NetworkLoadBalancedEc2ServiceProps.getMemoryLimitMiB()
NetworkLoadBalancedEc2ServiceProps.Builder	memoryReservationMiB(Number memoryReservationMiB)	Sets the value of NetworkLoadBalancedEc2ServiceProps.getMemoryReservationMiB()
NetworkLoadBalancedEc2ServiceProps.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of NetworkLoadBalancedServiceBaseProps.getMinHealthyPercent()
NetworkLoadBalancedEc2ServiceProps.Builder	placementConstraints(List<? extends PlacementConstraint> placementConstraints)	Sets the value of NetworkLoadBalancedEc2ServiceProps.getPlacementConstraints()
NetworkLoadBalancedEc2ServiceProps.Builder	placementStrategies(List<? extends PlacementStrategy> placementStrategies)	Sets the value of NetworkLoadBalancedEc2ServiceProps.getPlacementStrategies()
NetworkLoadBalancedEc2ServiceProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of NetworkLoadBalancedServiceBaseProps.getPropagateTags()
NetworkLoadBalancedEc2ServiceProps.Builder	publicLoadBalancer(Boolean publicLoadBalancer)	Sets the value of NetworkLoadBalancedServiceBaseProps.getPublicLoadBalancer()
NetworkLoadBalancedEc2ServiceProps.Builder	recordType(NetworkLoadBalancedServiceRecordType recordType)	Sets the value of NetworkLoadBalancedServiceBaseProps.getRecordType()
NetworkLoadBalancedEc2ServiceProps.Builder	serviceName(String serviceName)	Sets the value of NetworkLoadBalancedServiceBaseProps.getServiceName()
NetworkLoadBalancedEc2ServiceProps.Builder	taskDefinition(Ec2TaskDefinition taskDefinition)	Sets the value of NetworkLoadBalancedEc2ServiceProps.getTaskDefinition()
NetworkLoadBalancedEc2ServiceProps.Builder	taskImageOptions(NetworkLoadBalancedTaskImageOptions taskImageOptions)	Sets the value of NetworkLoadBalancedServiceBaseProps.getTaskImageOptions()
NetworkLoadBalancedEc2ServiceProps.Builder	vpc(IVpc vpc)	Sets the value of NetworkLoadBalancedServiceBaseProps.getVpc()

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

cpu

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder cpu(Number cpu)

Sets the value of NetworkLoadBalancedEc2ServiceProps.getCpu()

Parameters:

cpu - The number of cpu units used by the task. Valid values, which determines your range of valid values for the memory parameter:

256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

memoryLimitMiB

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of NetworkLoadBalancedEc2ServiceProps.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Returns:

this

memoryReservationMiB

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder memoryReservationMiB(Number memoryReservationMiB)

Sets the value of NetworkLoadBalancedEc2ServiceProps.getMemoryReservationMiB()

Parameters:

memoryReservationMiB - The soft limit (in MiB) of memory to reserve for the container. When system memory is under contention, Docker attempts to keep the container memory within the limit. If the container requires more memory, it can consume up to the value specified by the Memory property or all of the available memory on the container instance—whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Returns:

this

placementConstraints

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

Sets the value of NetworkLoadBalancedEc2ServiceProps.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 NetworkLoadBalancedEc2ServiceProps.Builder placementStrategies(List<? extends PlacementStrategy> placementStrategies)

Sets the value of NetworkLoadBalancedEc2ServiceProps.getPlacementStrategies()

Parameters:

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

Returns:

this

taskDefinition

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder taskDefinition(Ec2TaskDefinition taskDefinition)

Sets the value of NetworkLoadBalancedEc2ServiceProps.getTaskDefinition()

Parameters:

taskDefinition - The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.. [disable-awslint:ref-via-interface]

Returns:

this

circuitBreaker

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

Sets the value of NetworkLoadBalancedServiceBaseProps.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 NetworkLoadBalancedEc2ServiceProps.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)

Sets the value of NetworkLoadBalancedServiceBaseProps.getCloudMapOptions()

Parameters:

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

Returns:

this

cluster

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

Sets the value of NetworkLoadBalancedServiceBaseProps.getCluster()

Parameters:

cluster - The name of the cluster that hosts the service. If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

Returns:

this

deploymentController

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

Sets the value of NetworkLoadBalancedServiceBaseProps.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 NetworkLoadBalancedEc2ServiceProps.Builder desiredCount(Number desiredCount)

Sets the value of NetworkLoadBalancedServiceBaseProps.getDesiredCount()

Parameters:

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

Returns:

this

domainName

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder domainName(String domainName)

Sets the value of NetworkLoadBalancedServiceBaseProps.getDomainName()

Parameters:

domainName - The domain name for the service, e.g. "api.example.com.".

Returns:

this

domainZone

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder domainZone(IHostedZone domainZone)

Sets the value of NetworkLoadBalancedServiceBaseProps.getDomainZone()

Parameters:

domainZone - The Route53 hosted zone for the domain, e.g. "example.com.".

Returns:

this

enableEcsManagedTags

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

Sets the value of

invalid @link

NetworkLoadBalancedEc2ServiceProps#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

healthCheckGracePeriod

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

Sets the value of NetworkLoadBalancedServiceBaseProps.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

listenerPort

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder listenerPort(Number listenerPort)

Sets the value of NetworkLoadBalancedServiceBaseProps.getListenerPort()

Parameters:

listenerPort - Listener port of the network load balancer that will serve traffic to the service.

Returns:

this

loadBalancer

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder loadBalancer(INetworkLoadBalancer loadBalancer)

Sets the value of NetworkLoadBalancedServiceBaseProps.getLoadBalancer()

Parameters:

loadBalancer - The network load balancer that will serve traffic to the service. If the load balancer has been imported, the vpc attribute must be specified in the call to fromNetworkLoadBalancerAttributes().

[disable-awslint:ref-via-interface]

Returns:

this

maxHealthyPercent

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

Sets the value of NetworkLoadBalancedServiceBaseProps.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 NetworkLoadBalancedEc2ServiceProps.Builder minHealthyPercent(Number minHealthyPercent)

Sets the value of NetworkLoadBalancedServiceBaseProps.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 NetworkLoadBalancedEc2ServiceProps.Builder propagateTags(PropagatedTagSource propagateTags)

Sets the value of NetworkLoadBalancedServiceBaseProps.getPropagateTags()

Parameters:

propagateTags - 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

publicLoadBalancer

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder publicLoadBalancer(Boolean publicLoadBalancer)

Sets the value of NetworkLoadBalancedServiceBaseProps.getPublicLoadBalancer()

Parameters:

publicLoadBalancer - Determines whether the Load Balancer will be internet-facing.

Returns:

this

recordType

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder recordType(NetworkLoadBalancedServiceRecordType recordType)

Sets the value of NetworkLoadBalancedServiceBaseProps.getRecordType()

Parameters:

recordType - Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. This is useful if you need to work with DNS systems that do not support alias records.

Returns:

this

serviceName

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

Sets the value of NetworkLoadBalancedServiceBaseProps.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

taskImageOptions

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder taskImageOptions(NetworkLoadBalancedTaskImageOptions taskImageOptions)

Sets the value of NetworkLoadBalancedServiceBaseProps.getTaskImageOptions()

Parameters:

taskImageOptions - The properties required to create a new task definition. One of taskImageOptions or taskDefinition must be specified.

Returns:

this

vpc

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps.Builder vpc(IVpc vpc)

Sets the value of NetworkLoadBalancedServiceBaseProps.getVpc()

Parameters:

vpc - The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

Returns:

this

build

@Stability(Stable)
public NetworkLoadBalancedEc2ServiceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NetworkLoadBalancedEc2ServiceProps

Throws:

NullPointerException - if any required attribute was not provided