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

Class NetworkLoadBalancedFargateServiceProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkLoadBalancedFargateServiceProps>

Enclosing interface:

NetworkLoadBalancedFargateServiceProps

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

A builder for NetworkLoadBalancedFargateServiceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NetworkLoadBalancedFargateServiceProps.Builder	assignPublicIp(Boolean assignPublicIp)	Sets the value of NetworkLoadBalancedFargateServiceProps.getAssignPublicIp()
NetworkLoadBalancedFargateServiceProps	build()	Builds the configured instance.
NetworkLoadBalancedFargateServiceProps.Builder	capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCapacityProviderStrategies()
NetworkLoadBalancedFargateServiceProps.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCircuitBreaker()
NetworkLoadBalancedFargateServiceProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCloudMapOptions()
NetworkLoadBalancedFargateServiceProps.Builder	cluster(ICluster cluster)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCluster()
NetworkLoadBalancedFargateServiceProps.Builder	cpu(Number cpu)	Sets the value of FargateServiceBaseProps.getCpu()
NetworkLoadBalancedFargateServiceProps.Builder	deploymentController(DeploymentController deploymentController)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDeploymentController()
NetworkLoadBalancedFargateServiceProps.Builder	desiredCount(Number desiredCount)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDesiredCount()
NetworkLoadBalancedFargateServiceProps.Builder	domainName(String domainName)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDomainName()
NetworkLoadBalancedFargateServiceProps.Builder	domainZone(IHostedZone domainZone)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDomainZone()
NetworkLoadBalancedFargateServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link NetworkLoadBalancedFargateServiceProps#getEnableEcsManagedTags
NetworkLoadBalancedFargateServiceProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of NetworkLoadBalancedServiceBaseProps.getEnableExecuteCommand()
NetworkLoadBalancedFargateServiceProps.Builder	ephemeralStorageGiB(Number ephemeralStorageGiB)	Sets the value of FargateServiceBaseProps.getEphemeralStorageGiB()
NetworkLoadBalancedFargateServiceProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of NetworkLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()
NetworkLoadBalancedFargateServiceProps.Builder	ipAddressType(IpAddressType ipAddressType)	Sets the value of NetworkLoadBalancedServiceBaseProps.getIpAddressType()
NetworkLoadBalancedFargateServiceProps.Builder	listenerCertificate(IListenerCertificate listenerCertificate)	Sets the value of NetworkLoadBalancedServiceBaseProps.getListenerCertificate()
NetworkLoadBalancedFargateServiceProps.Builder	listenerPort(Number listenerPort)	Sets the value of NetworkLoadBalancedServiceBaseProps.getListenerPort()
NetworkLoadBalancedFargateServiceProps.Builder	loadBalancer(INetworkLoadBalancer loadBalancer)	Sets the value of NetworkLoadBalancedServiceBaseProps.getLoadBalancer()
NetworkLoadBalancedFargateServiceProps.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of NetworkLoadBalancedServiceBaseProps.getMaxHealthyPercent()
NetworkLoadBalancedFargateServiceProps.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of FargateServiceBaseProps.getMemoryLimitMiB()
NetworkLoadBalancedFargateServiceProps.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of NetworkLoadBalancedServiceBaseProps.getMinHealthyPercent()
NetworkLoadBalancedFargateServiceProps.Builder	platformVersion(FargatePlatformVersion platformVersion)	Sets the value of FargateServiceBaseProps.getPlatformVersion()
NetworkLoadBalancedFargateServiceProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of NetworkLoadBalancedServiceBaseProps.getPropagateTags()
NetworkLoadBalancedFargateServiceProps.Builder	publicLoadBalancer(Boolean publicLoadBalancer)	Sets the value of NetworkLoadBalancedServiceBaseProps.getPublicLoadBalancer()
NetworkLoadBalancedFargateServiceProps.Builder	recordType(NetworkLoadBalancedServiceRecordType recordType)	Sets the value of NetworkLoadBalancedServiceBaseProps.getRecordType()
NetworkLoadBalancedFargateServiceProps.Builder	runtimePlatform(RuntimePlatform runtimePlatform)	Sets the value of FargateServiceBaseProps.getRuntimePlatform()
NetworkLoadBalancedFargateServiceProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of NetworkLoadBalancedFargateServiceProps.getSecurityGroups()
NetworkLoadBalancedFargateServiceProps.Builder	serviceName(String serviceName)	Sets the value of NetworkLoadBalancedServiceBaseProps.getServiceName()
NetworkLoadBalancedFargateServiceProps.Builder	taskDefinition(FargateTaskDefinition taskDefinition)	Sets the value of FargateServiceBaseProps.getTaskDefinition()
NetworkLoadBalancedFargateServiceProps.Builder	taskImageOptions(NetworkLoadBalancedTaskImageOptions taskImageOptions)	Sets the value of NetworkLoadBalancedServiceBaseProps.getTaskImageOptions()
NetworkLoadBalancedFargateServiceProps.Builder	taskSubnets(SubnetSelection taskSubnets)	Sets the value of NetworkLoadBalancedFargateServiceProps.getTaskSubnets()
NetworkLoadBalancedFargateServiceProps.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

assignPublicIp

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

Sets the value of NetworkLoadBalancedFargateServiceProps.getAssignPublicIp()

Parameters:

assignPublicIp - Determines whether the service will be assigned a public IP address.

Returns:

this

securityGroups

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

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

Returns:

this

taskSubnets

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.Builder taskSubnets(SubnetSelection taskSubnets)

Sets the value of NetworkLoadBalancedFargateServiceProps.getTaskSubnets()

Parameters:

taskSubnets - The subnets to associate with the service.

Returns:

this

capacityProviderStrategies

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

Sets the value of NetworkLoadBalancedServiceBaseProps.getCapacityProviderStrategies()

Parameters:

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

Returns:

this

circuitBreaker

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

Sets the value of

invalid @link

NetworkLoadBalancedFargateServiceProps#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 NetworkLoadBalancedFargateServiceProps.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of NetworkLoadBalancedServiceBaseProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

healthCheckGracePeriod

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.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

ipAddressType

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.Builder ipAddressType(IpAddressType ipAddressType)

Sets the value of NetworkLoadBalancedServiceBaseProps.getIpAddressType()

Parameters:

ipAddressType - The type of IP addresses to use. If you want to add a UDP or TCP_UDP listener to the load balancer, you must choose IPv4.

Returns:

this

listenerCertificate

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.Builder listenerCertificate(IListenerCertificate listenerCertificate)

Sets the value of NetworkLoadBalancedServiceBaseProps.getListenerCertificate()

Parameters:

listenerCertificate - Listener certificate list of ACM cert ARNs. If you provide a certificate, the listener's protocol will be TLS. If not, the listener's protocol will be TCP.

Returns:

this

listenerPort

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.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 NetworkLoadBalancedFargateServiceProps.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 NetworkLoadBalancedFargateServiceProps.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 NetworkLoadBalancedFargateServiceProps.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 NetworkLoadBalancedFargateServiceProps.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 NetworkLoadBalancedFargateServiceProps.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 NetworkLoadBalancedFargateServiceProps.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 NetworkLoadBalancedFargateServiceProps.Builder serviceName(String serviceName)

Sets the value of NetworkLoadBalancedServiceBaseProps.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

taskImageOptions

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.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 NetworkLoadBalancedFargateServiceProps.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

cpu

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

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

8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments

16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

ephemeralStorageGiB

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.Builder ephemeralStorageGiB(Number ephemeralStorageGiB)

Sets the value of FargateServiceBaseProps.getEphemeralStorageGiB()

Parameters:

ephemeralStorageGiB - The amount (in GiB) of ephemeral storage to be allocated to the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

Only supported in Fargate platform version 1.4.0 or later.

Returns:

this

memoryLimitMiB

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

Sets the value of FargateServiceBaseProps.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The amount (in MiB) of memory used by the task. This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)

Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

platformVersion

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.Builder platformVersion(FargatePlatformVersion platformVersion)

Sets the value of FargateServiceBaseProps.getPlatformVersion()

Parameters:

platformVersion - The platform version on which to run your service. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Returns:

this

runtimePlatform

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.Builder runtimePlatform(RuntimePlatform runtimePlatform)

Sets the value of FargateServiceBaseProps.getRuntimePlatform()

Parameters:

runtimePlatform - The runtime platform of the task definition.

Returns:

this

taskDefinition

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps.Builder taskDefinition(FargateTaskDefinition taskDefinition)

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

build

@Stability(Stable)
public NetworkLoadBalancedFargateServiceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NetworkLoadBalancedFargateServiceProps

Throws:

NullPointerException - if any required attribute was not provided