software.amazon.awscdk.services.ecs.patterns

Class ApplicationMultipleTargetGroupsFargateService.Builder

java.lang.Object

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

Enclosing class:

ApplicationMultipleTargetGroupsFargateService

@Stability(value=Stable)
public static final class ApplicationMultipleTargetGroupsFargateService.Builder
extends Object

A fluent builder for ApplicationMultipleTargetGroupsFargateService.

Method Summary

Modifier and Type	Method and Description
ApplicationMultipleTargetGroupsFargateService.Builder	assignPublicIp(Boolean assignPublicIp) Determines whether the service will be assigned a public IP address.
ApplicationMultipleTargetGroupsFargateService	build()
ApplicationMultipleTargetGroupsFargateService.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions) The options for configuring an Amazon ECS service to use service discovery.
ApplicationMultipleTargetGroupsFargateService.Builder	cluster(ICluster cluster) The name of the cluster that hosts the service.
ApplicationMultipleTargetGroupsFargateService.Builder	cpu(Number cpu) The number of cpu units used by the task.
static ApplicationMultipleTargetGroupsFargateService.Builder	create(Construct scope, String id)
ApplicationMultipleTargetGroupsFargateService.Builder	desiredCount(Number desiredCount) The desired number of instantiations of the task definition to keep running on the service.
ApplicationMultipleTargetGroupsFargateService.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
ApplicationMultipleTargetGroupsFargateService.Builder	healthCheckGracePeriod(Duration 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.
ApplicationMultipleTargetGroupsFargateService.Builder	loadBalancers(List<ApplicationLoadBalancerProps> loadBalancers) The application load balancer that will serve traffic to the service.
ApplicationMultipleTargetGroupsFargateService.Builder	memoryLimitMiB(Number memoryLimitMiB) The amount (in MiB) of memory used by the task.
ApplicationMultipleTargetGroupsFargateService.Builder	propagateTags(PropagatedTagSource propagateTags) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
ApplicationMultipleTargetGroupsFargateService.Builder	serviceName(String serviceName) The name of the service.
ApplicationMultipleTargetGroupsFargateService.Builder	targetGroups(List<ApplicationTargetProps> targetGroups) Properties to specify ALB target groups.
ApplicationMultipleTargetGroupsFargateService.Builder	taskDefinition(FargateTaskDefinition taskDefinition) The task definition to use for tasks in the service.
ApplicationMultipleTargetGroupsFargateService.Builder	taskImageOptions(ApplicationLoadBalancedTaskImageProps taskImageOptions) The properties required to create a new task definition.
ApplicationMultipleTargetGroupsFargateService.Builder	vpc(IVpc vpc) The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static ApplicationMultipleTargetGroupsFargateService.Builder create(Construct scope,
                                                                                                    String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ApplicationMultipleTargetGroupsFargateService.Builder.

cloudMapOptions

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)

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

Default: - AWS Cloud Map service discovery is not enabled.

Parameters:

cloudMapOptions - The options for configuring an Amazon ECS service to use service discovery. This parameter is required.

Returns:

this

cluster

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder cluster(ICluster 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.

Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

Parameters:

cluster - The name of the cluster that hosts the service. This parameter is required.

Returns:

this

desiredCount

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder desiredCount(Number desiredCount)

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

Default: 1

Parameters:

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

Returns:

this

enableEcsManagedTags

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

Default: false

Parameters:

enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. This parameter is required.

Returns:

this

healthCheckGracePeriod

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder healthCheckGracePeriod(Duration 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.

Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set

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. This parameter is required.

Returns:

this

loadBalancers

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder loadBalancers(List<ApplicationLoadBalancerProps> loadBalancers)

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

Default: - a new load balancer with a listener will be created.

Parameters:

loadBalancers - The application load balancer that will serve traffic to the service. This parameter is required.

Returns:

this

propagateTags

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder propagateTags(PropagatedTagSource 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.

Default: - none

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. This parameter is required.

Returns:

this

serviceName

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder serviceName(String serviceName)

The name of the service.

Default: - CloudFormation-generated name.

Parameters:

serviceName - The name of the service. This parameter is required.

Returns:

this

targetGroups

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder targetGroups(List<ApplicationTargetProps> targetGroups)

Properties to specify ALB target groups.

Default: - default portMapping registered as target group and attached to the first defined listener

Parameters:

targetGroups - Properties to specify ALB target groups. This parameter is required.

Returns:

this

taskImageOptions

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder taskImageOptions(ApplicationLoadBalancedTaskImageProps taskImageOptions)

The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

Default: none

Parameters:

taskImageOptions - The properties required to create a new task definition. This parameter is required.

Returns:

this

vpc

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder vpc(IVpc 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.

Default: - uses the VPC defined in the cluster or creates a new VPC.

Parameters:

vpc - The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. This parameter is required.

Returns:

this

assignPublicIp

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder assignPublicIp(Boolean assignPublicIp)

Determines whether the service will be assigned a public IP address.

Default: false

Parameters:

assignPublicIp - Determines whether the service will be assigned a public IP address. This parameter is required.

Returns:

this

cpu

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder cpu(Number 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.

Default: 256

Parameters:

cpu - The number of cpu units used by the task. This parameter is required.

Returns:

this

memoryLimitMiB

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder memoryLimitMiB(Number memoryLimitMiB)

The amount (in MiB) of memory used by the task.

This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

Default: 512

Parameters:

memoryLimitMiB - The amount (in MiB) of memory used by the task. This parameter is required.

Returns:

this

taskDefinition

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService.Builder taskDefinition(FargateTaskDefinition 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]

Default: - none

Parameters:

taskDefinition - The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ApplicationMultipleTargetGroupsFargateService build()