Class NetworkLoadBalancedEc2ServiceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<NetworkLoadBalancedEc2ServiceProps>
- Enclosing interface:
NetworkLoadBalancedEc2ServiceProps
NetworkLoadBalancedEc2ServiceProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.capacityProviderStrategies
(List<? extends CapacityProviderStrategy> capacityProviderStrategies) Sets the value ofNetworkLoadBalancedServiceBaseProps.getCapacityProviderStrategies()
circuitBreaker
(DeploymentCircuitBreaker circuitBreaker) Sets the value ofNetworkLoadBalancedServiceBaseProps.getCircuitBreaker()
cloudMapOptions
(CloudMapOptions cloudMapOptions) Sets the value ofNetworkLoadBalancedServiceBaseProps.getCloudMapOptions()
Sets the value ofNetworkLoadBalancedServiceBaseProps.getCluster()
Sets the value ofNetworkLoadBalancedEc2ServiceProps.getCpu()
deploymentController
(DeploymentController deploymentController) Sets the value ofNetworkLoadBalancedServiceBaseProps.getDeploymentController()
desiredCount
(Number desiredCount) Sets the value ofNetworkLoadBalancedServiceBaseProps.getDesiredCount()
domainName
(String domainName) Sets the value ofNetworkLoadBalancedServiceBaseProps.getDomainName()
domainZone
(IHostedZone domainZone) Sets the value ofNetworkLoadBalancedServiceBaseProps.getDomainZone()
enableEcsManagedTags
(Boolean enableEcsManagedTags) Sets the value ofinvalid @link
NetworkLoadBalancedEc2ServiceProps#getEnableEcsManagedTags
enableExecuteCommand
(Boolean enableExecuteCommand) Sets the value ofNetworkLoadBalancedServiceBaseProps.getEnableExecuteCommand()
healthCheckGracePeriod
(Duration healthCheckGracePeriod) Sets the value ofNetworkLoadBalancedServiceBaseProps.getHealthCheckGracePeriod()
ipAddressType
(IpAddressType ipAddressType) Sets the value ofNetworkLoadBalancedServiceBaseProps.getIpAddressType()
listenerCertificate
(IListenerCertificate listenerCertificate) Sets the value ofNetworkLoadBalancedServiceBaseProps.getListenerCertificate()
listenerPort
(Number listenerPort) Sets the value ofNetworkLoadBalancedServiceBaseProps.getListenerPort()
loadBalancer
(INetworkLoadBalancer loadBalancer) Sets the value ofNetworkLoadBalancedServiceBaseProps.getLoadBalancer()
maxHealthyPercent
(Number maxHealthyPercent) Sets the value ofNetworkLoadBalancedServiceBaseProps.getMaxHealthyPercent()
memoryLimitMiB
(Number memoryLimitMiB) Sets the value ofNetworkLoadBalancedEc2ServiceProps.getMemoryLimitMiB()
memoryReservationMiB
(Number memoryReservationMiB) Sets the value ofNetworkLoadBalancedEc2ServiceProps.getMemoryReservationMiB()
minHealthyPercent
(Number minHealthyPercent) Sets the value ofNetworkLoadBalancedServiceBaseProps.getMinHealthyPercent()
placementConstraints
(List<? extends PlacementConstraint> placementConstraints) Sets the value ofNetworkLoadBalancedEc2ServiceProps.getPlacementConstraints()
placementStrategies
(List<? extends PlacementStrategy> placementStrategies) Sets the value ofNetworkLoadBalancedEc2ServiceProps.getPlacementStrategies()
propagateTags
(PropagatedTagSource propagateTags) Sets the value ofNetworkLoadBalancedServiceBaseProps.getPropagateTags()
publicLoadBalancer
(Boolean publicLoadBalancer) Sets the value ofNetworkLoadBalancedServiceBaseProps.getPublicLoadBalancer()
recordType
(NetworkLoadBalancedServiceRecordType recordType) Sets the value ofNetworkLoadBalancedServiceBaseProps.getRecordType()
serviceName
(String serviceName) Sets the value ofNetworkLoadBalancedServiceBaseProps.getServiceName()
taskDefinition
(Ec2TaskDefinition taskDefinition) Sets the value ofNetworkLoadBalancedEc2ServiceProps.getTaskDefinition()
taskImageOptions
(NetworkLoadBalancedTaskImageOptions taskImageOptions) Sets the value ofNetworkLoadBalancedServiceBaseProps.getTaskImageOptions()
Sets the value ofNetworkLoadBalancedServiceBaseProps.getVpc()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
cpu
Sets the value ofNetworkLoadBalancedEc2ServiceProps.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 ofNetworkLoadBalancedEc2ServiceProps.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 ofNetworkLoadBalancedEc2ServiceProps.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 ofNetworkLoadBalancedEc2ServiceProps.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 ofNetworkLoadBalancedEc2ServiceProps.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 ofNetworkLoadBalancedEc2ServiceProps.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
-
capacityProviderStrategies
@Stability(Stable) public NetworkLoadBalancedEc2ServiceProps.Builder capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies) Sets the value ofNetworkLoadBalancedServiceBaseProps.getCapacityProviderStrategies()
- Parameters:
capacityProviderStrategies
- A list of Capacity Provider strategies used to place a service.- Returns:
this
-
circuitBreaker
@Stability(Stable) public NetworkLoadBalancedEc2ServiceProps.Builder circuitBreaker(DeploymentCircuitBreaker circuitBreaker) Sets the value ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.getCloudMapOptions()
- Parameters:
cloudMapOptions
- The options for configuring an Amazon ECS service to use service discovery.- Returns:
this
-
cluster
Sets the value ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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
Sets the value ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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 ofinvalid @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
-
enableExecuteCommand
@Stability(Stable) public NetworkLoadBalancedEc2ServiceProps.Builder enableExecuteCommand(Boolean enableExecuteCommand) Sets the value ofNetworkLoadBalancedServiceBaseProps.getEnableExecuteCommand()
- Parameters:
enableExecuteCommand
- Whether ECS Exec should be enabled.- Returns:
this
-
healthCheckGracePeriod
@Stability(Stable) public NetworkLoadBalancedEc2ServiceProps.Builder healthCheckGracePeriod(Duration healthCheckGracePeriod) Sets the value ofNetworkLoadBalancedServiceBaseProps.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 NetworkLoadBalancedEc2ServiceProps.Builder ipAddressType(IpAddressType ipAddressType) Sets the value ofNetworkLoadBalancedServiceBaseProps.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 NetworkLoadBalancedEc2ServiceProps.Builder listenerCertificate(IListenerCertificate listenerCertificate) Sets the value ofNetworkLoadBalancedServiceBaseProps.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 NetworkLoadBalancedEc2ServiceProps.Builder listenerPort(Number listenerPort) Sets the value ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.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 ofNetworkLoadBalancedServiceBaseProps.getServiceName()
- Parameters:
serviceName
- The name of the service.- Returns:
this
-
taskImageOptions
@Stability(Stable) public NetworkLoadBalancedEc2ServiceProps.Builder taskImageOptions(NetworkLoadBalancedTaskImageOptions taskImageOptions) Sets the value ofNetworkLoadBalancedServiceBaseProps.getTaskImageOptions()
- Parameters:
taskImageOptions
- The properties required to create a new task definition. One of taskImageOptions or taskDefinition must be specified.- Returns:
this
-
vpc
Sets the value ofNetworkLoadBalancedServiceBaseProps.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
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<NetworkLoadBalancedEc2ServiceProps>
- Returns:
- a new instance of
NetworkLoadBalancedEc2ServiceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-