software.amazon.awscdk.services.ecs.patterns

Class ScheduledFargateTask.Builder

java.lang.Object

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

Enclosing class:

ScheduledFargateTask

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

A fluent builder for ScheduledFargateTask.

Method Summary

Modifier and Type	Method and Description
ScheduledFargateTask	build()
ScheduledFargateTask.Builder	cluster(ICluster cluster) The name of the cluster that hosts the service.
static ScheduledFargateTask.Builder	create(Construct scope, String id)
ScheduledFargateTask.Builder	desiredTaskCount(Number desiredTaskCount) The desired number of instantiations of the task definition to keep running on the service.
ScheduledFargateTask.Builder	schedule(Schedule schedule) The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
ScheduledFargateTask.Builder	scheduledFargateTaskDefinitionOptions(ScheduledFargateTaskDefinitionOptions scheduledFargateTaskDefinitionOptions) The properties to define if using an existing TaskDefinition in this construct.
ScheduledFargateTask.Builder	scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions scheduledFargateTaskImageOptions) The properties to define if the construct is to create a TaskDefinition.
ScheduledFargateTask.Builder	subnetSelection(SubnetSelection subnetSelection) In what subnets to place the task's ENIs.
ScheduledFargateTask.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 ScheduledFargateTask.Builder create(Construct scope,
                                                                           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of ScheduledFargateTask.Builder.

schedule

@Stability(value=Stable)
public ScheduledFargateTask.Builder schedule(Schedule schedule)

The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.

For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.

Parameters:

schedule - The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. This parameter is required.

Returns:

this

cluster

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

desiredTaskCount

@Stability(value=Stable)
public ScheduledFargateTask.Builder desiredTaskCount(Number desiredTaskCount)

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

Default: 1

Parameters:

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

Returns:

this

subnetSelection

@Stability(value=Stable)
public ScheduledFargateTask.Builder subnetSelection(SubnetSelection subnetSelection)

In what subnets to place the task's ENIs.

(Only applicable in case the TaskDefinition is configured for AwsVpc networking)

Default: Private subnets

Parameters:

subnetSelection - In what subnets to place the task's ENIs. This parameter is required.

Returns:

this

vpc

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

scheduledFargateTaskDefinitionOptions

@Stability(value=Stable)
public ScheduledFargateTask.Builder scheduledFargateTaskDefinitionOptions(ScheduledFargateTaskDefinitionOptions scheduledFargateTaskDefinitionOptions)

The properties to define if using an existing TaskDefinition in this construct.

ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

Default: none

Parameters:

scheduledFargateTaskDefinitionOptions - The properties to define if using an existing TaskDefinition in this construct. This parameter is required.

Returns:

this

scheduledFargateTaskImageOptions

@Stability(value=Stable)
public ScheduledFargateTask.Builder scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions scheduledFargateTaskImageOptions)

The properties to define if the construct is to create a TaskDefinition.

ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

Default: none

Parameters:

scheduledFargateTaskImageOptions - The properties to define if the construct is to create a TaskDefinition. This parameter is required.

Returns:

this

build

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