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

Class NetworkMultipleTargetGroupsServiceBaseProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<NetworkMultipleTargetGroupsServiceBaseProps>

Enclosing interface:

NetworkMultipleTargetGroupsServiceBaseProps

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

A builder for NetworkMultipleTargetGroupsServiceBaseProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NetworkMultipleTargetGroupsServiceBaseProps	build()	Builds the configured instance.
NetworkMultipleTargetGroupsServiceBaseProps.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getCloudMapOptions()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	cluster(ICluster cluster)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getCluster()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	desiredCount(Number desiredCount)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getDesiredCount()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of invalid @link NetworkMultipleTargetGroupsServiceBaseProps#getEnableEcsManagedTags
NetworkMultipleTargetGroupsServiceBaseProps.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getEnableExecuteCommand()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	healthCheckGracePeriod(Duration healthCheckGracePeriod)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getHealthCheckGracePeriod()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	loadBalancers(List<? extends NetworkLoadBalancerProps> loadBalancers)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getLoadBalancers()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getPropagateTags()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	serviceName(String serviceName)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getServiceName()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	targetGroups(List<? extends NetworkTargetProps> targetGroups)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getTargetGroups()
NetworkMultipleTargetGroupsServiceBaseProps.Builder	taskImageOptions(NetworkLoadBalancedTaskImageProps taskImageOptions)	Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getTaskImageOptions()
NetworkMultipleTargetGroupsServiceBaseProps.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

cloudMapOptions

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

Sets the value of

invalid @link

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

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

healthCheckGracePeriod

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

Sets the value of NetworkMultipleTargetGroupsServiceBaseProps.getServiceName()

Parameters:

serviceName - Name of the service.

Returns:

this

targetGroups

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of NetworkMultipleTargetGroupsServiceBaseProps

Throws:

NullPointerException - if any required attribute was not provided