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

Class NetworkMultipleTargetGroupsEc2ServiceProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkMultipleTargetGroupsEc2ServiceProps>

Enclosing interface:

NetworkMultipleTargetGroupsEc2ServiceProps

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

A builder for NetworkMultipleTargetGroupsEc2ServiceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NetworkMultipleTargetGroupsEc2ServiceProps	build()	Builds the configured instance.
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getCloudMapOptions()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	cluster(ICluster cluster)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getCluster()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	cpu(Number cpu)	Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getCpu()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	desiredCount(Number desiredCount)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getDesiredCount()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link NetworkMultipleTargetGroupsEc2ServiceProps#getEnableEcsManagedTags
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getEnableExecuteCommand()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getHealthCheckGracePeriod()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	loadBalancers(List<? extends NetworkLoadBalancerProps> loadBalancers)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getLoadBalancers()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getMemoryLimitMiB()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	memoryReservationMiB(Number memoryReservationMiB)	Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getMemoryReservationMiB()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	placementConstraints(List<? extends PlacementConstraint> placementConstraints)	Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getPlacementConstraints()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	placementStrategies(List<? extends PlacementStrategy> placementStrategies)	Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getPlacementStrategies()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getPropagateTags()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	serviceName(String serviceName)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getServiceName()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	targetGroups(List<? extends NetworkTargetProps> targetGroups)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getTargetGroups()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	taskDefinition(Ec2TaskDefinition taskDefinition)	Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getTaskDefinition()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	taskImageOptions(NetworkLoadBalancedTaskImageProps taskImageOptions)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getTaskImageOptions()
NetworkMultipleTargetGroupsEc2ServiceProps.Builder	vpc(IVpc vpc)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.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 NetworkMultipleTargetGroupsEc2ServiceProps.Builder cpu(Number cpu)

Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getCpu()

Parameters:

cpu - The minimum number of CPU units to reserve for the container. Valid values, which determines your range of valid values for the memory parameter:

Returns:

this

memoryLimitMiB

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

Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getMemoryLimitMiB()

Parameters:

memoryLimitMiB - The amount (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 NetworkMultipleTargetGroupsEc2ServiceProps.Builder memoryReservationMiB(Number memoryReservationMiB)

Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getMemoryReservationMiB()

Parameters:

memoryReservationMiB - The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Note that this setting will be ignored if TaskImagesOptions is specified.

Returns:

this

placementConstraints

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

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

Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.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 NetworkMultipleTargetGroupsEc2ServiceProps.Builder taskDefinition(Ec2TaskDefinition taskDefinition)

Sets the value of NetworkMultipleTargetGroupsEc2ServiceProps.getTaskDefinition()

Parameters:

taskDefinition - The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified. [disable-awslint:ref-via-interface]

Returns:

this

cloudMapOptions

@Stability(Stable)
public NetworkMultipleTargetGroupsEc2ServiceProps.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getCloudMapOptions()

Parameters:

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

Returns:

this

cluster

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

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

desiredCount

@Stability(Stable)
public NetworkMultipleTargetGroupsEc2ServiceProps.Builder desiredCount(Number desiredCount)

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

enableEcsManagedTags

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

Sets the value of

invalid @link

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

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

healthCheckGracePeriod

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

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

loadBalancers

@Stability(Stable)
public NetworkMultipleTargetGroupsEc2ServiceProps.Builder loadBalancers(List<? extends NetworkLoadBalancerProps> loadBalancers)

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getLoadBalancers()

Parameters:

loadBalancers - The network load balancer that will serve traffic to the service.

Returns:

this

propagateTags

@Stability(Stable)
public NetworkMultipleTargetGroupsEc2ServiceProps.Builder propagateTags(PropagatedTagSource propagateTags)

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

serviceName

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

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getServiceName()

Parameters:

serviceName - Name of the service.

Returns:

this

targetGroups

@Stability(Stable)
public NetworkMultipleTargetGroupsEc2ServiceProps.Builder targetGroups(List<? extends NetworkTargetProps> targetGroups)

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getTargetGroups()

Parameters:

targetGroups - Properties to specify NLB target groups.

Returns:

this

taskImageOptions

@Stability(Stable)
public NetworkMultipleTargetGroupsEc2ServiceProps.Builder taskImageOptions(NetworkLoadBalancedTaskImageProps taskImageOptions)

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getTaskImageOptions()

Parameters:

taskImageOptions - The properties required to create a new task definition. Only one of TaskDefinition or TaskImageOptions must be specified.

Returns:

this

vpc

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

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.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 NetworkMultipleTargetGroupsEc2ServiceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NetworkMultipleTargetGroupsEc2ServiceProps

Throws:

NullPointerException - if any required attribute was not provided