software.amazon.awscdk.services.ecs

Class FargateService.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.FargateService.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<FargateService>

Enclosing class:

FargateService

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

A fluent builder for FargateService.

Method Summary

Modifier and Type	Method and Description
FargateService.Builder	assignPublicIp(Boolean assignPublicIp) Specifies whether the task's elastic network interface receives a public IP address.
FargateService	build()
FargateService.Builder	capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies) A list of Capacity Provider strategies used to place a service.
FargateService.Builder	circuitBreaker(DeploymentCircuitBreaker circuitBreaker) Whether to enable the deployment circuit breaker.
FargateService.Builder	cloudMapOptions(CloudMapOptions cloudMapOptions) The options for configuring an Amazon ECS service to use service discovery.
FargateService.Builder	cluster(ICluster cluster) The name of the cluster that hosts the service.
static FargateService.Builder	create(software.constructs.Construct scope, String id)
FargateService.Builder	deploymentController(DeploymentController deploymentController) Specifies which deployment controller to use for the service.
FargateService.Builder	desiredCount(Number desiredCount) The desired number of instantiations of the task definition to keep running on the service.
FargateService.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
FargateService.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.
FargateService.Builder	maxHealthyPercent(Number 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.
FargateService.Builder	minHealthyPercent(Number 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.
FargateService.Builder	platformVersion(FargatePlatformVersion platformVersion) The platform version on which to run your service.
FargateService.Builder	propagateTags(PropagatedTagSource propagateTags) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
FargateService.Builder	propagateTaskTagsFrom(PropagatedTagSource propagateTaskTagsFrom) Deprecated. Use `propagateTags` instead.
FargateService.Builder	securityGroup(ISecurityGroup securityGroup) Deprecated. use securityGroups instead.
FargateService.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups) The security groups to associate with the service.
FargateService.Builder	serviceName(String serviceName) The name of the service.
FargateService.Builder	taskDefinition(TaskDefinition taskDefinition) The task definition to use for tasks in the service.
FargateService.Builder	vpcSubnets(SubnetSelection vpcSubnets) The subnets to associate with the service.

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 FargateService.Builder create(software.constructs.Construct scope,
                                                                     String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of FargateService.Builder.

cluster

@Stability(value=Stable)
public FargateService.Builder cluster(ICluster cluster)

The name of the cluster that hosts the service.

Parameters:

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

Returns:

this

capacityProviderStrategies

@Stability(value=Stable)
public FargateService.Builder capacityProviderStrategies(List<? extends CapacityProviderStrategy> capacityProviderStrategies)

A list of Capacity Provider strategies used to place a service.

Default: - undefined

Parameters:

capacityProviderStrategies - A list of Capacity Provider strategies used to place a service. This parameter is required.

Returns:

this

circuitBreaker

@Stability(value=Stable)
public FargateService.Builder circuitBreaker(DeploymentCircuitBreaker circuitBreaker)

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

Default: - disabled

Parameters:

circuitBreaker - Whether to enable the deployment circuit breaker. This parameter is required.

Returns:

this

cloudMapOptions

@Stability(value=Stable)
public FargateService.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

deploymentController

@Stability(value=Stable)
public FargateService.Builder deploymentController(DeploymentController deploymentController)

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default: - Rolling update (ECS)

Parameters:

deploymentController - Specifies which deployment controller to use for the service. This parameter is required.

Returns:

this

desiredCount

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

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

Default: - When creating the service, default is 1; when updating the service, default uses the current task number.

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 FargateService.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 FargateService.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

maxHealthyPercent

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

Default: - 100 if daemon, otherwise 200

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

Returns:

this

minHealthyPercent

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

Default: - 0 if daemon, otherwise 50

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

Returns:

this

propagateTags

@Stability(value=Stable)
public FargateService.Builder propagateTags(PropagatedTagSource propagateTags)

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE

Default: PropagatedTagSource.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 FargateService.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

taskDefinition

@Stability(value=Stable)
public FargateService.Builder taskDefinition(TaskDefinition taskDefinition)

The task definition to use for tasks in the service.

[disable-awslint:ref-via-interface]

Parameters:

taskDefinition - The task definition to use for tasks in the service. This parameter is required.

Returns:

this

assignPublicIp

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

Specifies whether the task's elastic network interface receives a public IP address.

If true, each task will receive a public IP address.

Default: false

Parameters:

assignPublicIp - Specifies whether the task's elastic network interface receives a public IP address. This parameter is required.

Returns:

this

platformVersion

@Stability(value=Stable)
public FargateService.Builder platformVersion(FargatePlatformVersion platformVersion)

The platform version on which to run your service.

If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Default: Latest

Parameters:

platformVersion - The platform version on which to run your service. This parameter is required.

Returns:

this

propagateTaskTagsFrom

@Stability(value=Deprecated)
 @Deprecated
public FargateService.Builder propagateTaskTagsFrom(PropagatedTagSource propagateTaskTagsFrom)

Deprecated. Use `propagateTags` instead.

(deprecated) 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: PropagatedTagSource.NONE

Parameters:

propagateTaskTagsFrom - 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

securityGroup

@Stability(value=Deprecated)
 @Deprecated
public FargateService.Builder securityGroup(ISecurityGroup securityGroup)

Deprecated. use securityGroups instead.

(deprecated) The security groups to associate with the service.

If you do not specify a security group, the default security group for the VPC is used.

Default: - A new security group is created.

Parameters:

securityGroup - The security groups to associate with the service. This parameter is required.

Returns:

this

securityGroups

@Stability(value=Stable)
public FargateService.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

The security groups to associate with the service.

If you do not specify a security group, the default security group for the VPC is used.

Default: - A new security group is created.

Parameters:

securityGroups - The security groups to associate with the service. This parameter is required.

Returns:

this

vpcSubnets

@Stability(value=Stable)
public FargateService.Builder vpcSubnets(SubnetSelection vpcSubnets)

The subnets to associate with the service.

Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.

Parameters:

vpcSubnets - The subnets to associate with the service. This parameter is required.

Returns:

this

build

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

Specified by:

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