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

Class NetworkLoadBalancedServiceBaseProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkLoadBalancedServiceBaseProps>

Enclosing interface:

NetworkLoadBalancedServiceBaseProps

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

A builder for NetworkLoadBalancedServiceBaseProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NetworkLoadBalancedServiceBaseProps	build()	Builds the configured instance.
NetworkLoadBalancedServiceBaseProps.Builder	capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCapacityProviderStrategies()
NetworkLoadBalancedServiceBaseProps.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCircuitBreaker()
NetworkLoadBalancedServiceBaseProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCloudMapOptions()
NetworkLoadBalancedServiceBaseProps.Builder	cluster(ICluster cluster)	Sets the value of NetworkLoadBalancedServiceBaseProps.getCluster()
NetworkLoadBalancedServiceBaseProps.Builder	deploymentController(DeploymentController deploymentController)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDeploymentController()
NetworkLoadBalancedServiceBaseProps.Builder	desiredCount(Number desiredCount)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDesiredCount()
NetworkLoadBalancedServiceBaseProps.Builder	domainName(String domainName)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDomainName()
NetworkLoadBalancedServiceBaseProps.Builder	domainZone(IHostedZone domainZone)	Sets the value of NetworkLoadBalancedServiceBaseProps.getDomainZone()
NetworkLoadBalancedServiceBaseProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link NetworkLoadBalancedServiceBaseProps#getEnableEcsManagedTags
NetworkLoadBalancedServiceBaseProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of NetworkLoadBalancedServiceBaseProps.getEnableExecuteCommand()
NetworkLoadBalancedServiceBaseProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of NetworkLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()
NetworkLoadBalancedServiceBaseProps.Builder	ipAddressType(IpAddressType ipAddressType)	Sets the value of NetworkLoadBalancedServiceBaseProps.getIpAddressType()
NetworkLoadBalancedServiceBaseProps.Builder	listenerCertificate(IListenerCertificate listenerCertificate)	Sets the value of NetworkLoadBalancedServiceBaseProps.getListenerCertificate()
NetworkLoadBalancedServiceBaseProps.Builder	listenerPort(Number listenerPort)	Sets the value of NetworkLoadBalancedServiceBaseProps.getListenerPort()
NetworkLoadBalancedServiceBaseProps.Builder	loadBalancer(INetworkLoadBalancer loadBalancer)	Sets the value of NetworkLoadBalancedServiceBaseProps.getLoadBalancer()
NetworkLoadBalancedServiceBaseProps.Builder	maxHealthyPercent(Number maxHealthyPercent)	Sets the value of NetworkLoadBalancedServiceBaseProps.getMaxHealthyPercent()
NetworkLoadBalancedServiceBaseProps.Builder	minHealthyPercent(Number minHealthyPercent)	Sets the value of NetworkLoadBalancedServiceBaseProps.getMinHealthyPercent()
NetworkLoadBalancedServiceBaseProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of NetworkLoadBalancedServiceBaseProps.getPropagateTags()
NetworkLoadBalancedServiceBaseProps.Builder	publicLoadBalancer(Boolean publicLoadBalancer)	Sets the value of NetworkLoadBalancedServiceBaseProps.getPublicLoadBalancer()
NetworkLoadBalancedServiceBaseProps.Builder	recordType(NetworkLoadBalancedServiceRecordType recordType)	Sets the value of NetworkLoadBalancedServiceBaseProps.getRecordType()
NetworkLoadBalancedServiceBaseProps.Builder	serviceName(String serviceName)	Sets the value of NetworkLoadBalancedServiceBaseProps.getServiceName()
NetworkLoadBalancedServiceBaseProps.Builder	taskImageOptions(NetworkLoadBalancedTaskImageOptions taskImageOptions)	Sets the value of NetworkLoadBalancedServiceBaseProps.getTaskImageOptions()
NetworkLoadBalancedServiceBaseProps.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

capacityProviderStrategies

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

Sets the value of

invalid @link

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

Sets the value of NetworkLoadBalancedServiceBaseProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

healthCheckGracePeriod

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

Sets the value of NetworkLoadBalancedServiceBaseProps.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

taskImageOptions

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NetworkLoadBalancedServiceBaseProps

Throws:

NullPointerException - if any required attribute was not provided