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

Class ApplicationMultipleTargetGroupsServiceBaseProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ApplicationMultipleTargetGroupsServiceBaseProps>

Enclosing interface:

ApplicationMultipleTargetGroupsServiceBaseProps

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

A builder for ApplicationMultipleTargetGroupsServiceBaseProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.getCloudMapOptions()

Parameters:

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

Returns:

this

cluster

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

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.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 ApplicationMultipleTargetGroupsServiceBaseProps.Builder desiredCount(Number desiredCount)

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.getDesiredCount()

Parameters:

desiredCount - The desired number of instantiations of the task definition to keep running on the service.

Returns:

this

enableEcsManagedTags

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

Sets the value of

invalid @link

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

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.getEnableExecuteCommand()

Parameters:

enableExecuteCommand - Whether ECS Exec should be enabled.

Returns:

this

healthCheckGracePeriod

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

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.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 ApplicationMultipleTargetGroupsServiceBaseProps.Builder loadBalancers(List<? extends ApplicationLoadBalancerProps> loadBalancers)

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.getLoadBalancers()

Parameters:

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

Returns:

this

propagateTags

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

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.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 ApplicationMultipleTargetGroupsServiceBaseProps.Builder serviceName(String serviceName)

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.getServiceName()

Parameters:

serviceName - The name of the service.

Returns:

this

targetGroups

@Stability(Stable)
public ApplicationMultipleTargetGroupsServiceBaseProps.Builder targetGroups(List<? extends ApplicationTargetProps> targetGroups)

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.getTargetGroups()

Parameters:

targetGroups - Properties to specify ALB target groups.

Returns:

this

taskImageOptions

@Stability(Stable)
public ApplicationMultipleTargetGroupsServiceBaseProps.Builder taskImageOptions(ApplicationLoadBalancedTaskImageProps taskImageOptions)

Sets the value of ApplicationMultipleTargetGroupsServiceBaseProps.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 ApplicationMultipleTargetGroupsServiceBaseProps.Builder vpc(IVpc vpc)

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ApplicationMultipleTargetGroupsServiceBaseProps

Throws:

NullPointerException - if any required attribute was not provided