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

Class ScheduledFargateTaskProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ScheduledFargateTaskProps>

Enclosing interface:

ScheduledFargateTaskProps

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

A builder for ScheduledFargateTaskProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ScheduledFargateTaskProps	build()	Builds the configured instance.
ScheduledFargateTaskProps.Builder	cluster(ICluster cluster)	Sets the value of ScheduledTaskBaseProps.getCluster()
ScheduledFargateTaskProps.Builder	cpu(Number cpu)	Sets the value of FargateServiceBaseProps.getCpu()
ScheduledFargateTaskProps.Builder	desiredTaskCount(Number desiredTaskCount)	Sets the value of ScheduledTaskBaseProps.getDesiredTaskCount()
ScheduledFargateTaskProps.Builder	enabled(Boolean enabled)	Sets the value of ScheduledTaskBaseProps.getEnabled()
ScheduledFargateTaskProps.Builder	ephemeralStorageGiB(Number ephemeralStorageGiB)	Sets the value of FargateServiceBaseProps.getEphemeralStorageGiB()
ScheduledFargateTaskProps.Builder	memoryLimitMiB(Number memoryLimitMiB)	Sets the value of FargateServiceBaseProps.getMemoryLimitMiB()
ScheduledFargateTaskProps.Builder	platformVersion(FargatePlatformVersion platformVersion)	Sets the value of FargateServiceBaseProps.getPlatformVersion()
ScheduledFargateTaskProps.Builder	propagateTags(PropagatedTagSource propagateTags)	Sets the value of ScheduledTaskBaseProps.getPropagateTags()
ScheduledFargateTaskProps.Builder	ruleName(String ruleName)	Sets the value of ScheduledTaskBaseProps.getRuleName()
ScheduledFargateTaskProps.Builder	runtimePlatform(RuntimePlatform runtimePlatform)	Sets the value of FargateServiceBaseProps.getRuntimePlatform()
ScheduledFargateTaskProps.Builder	schedule(Schedule schedule)	Sets the value of ScheduledTaskBaseProps.getSchedule()
ScheduledFargateTaskProps.Builder	scheduledFargateTaskDefinitionOptions(ScheduledFargateTaskDefinitionOptions scheduledFargateTaskDefinitionOptions)	Sets the value of ScheduledFargateTaskProps.getScheduledFargateTaskDefinitionOptions()
ScheduledFargateTaskProps.Builder	scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions scheduledFargateTaskImageOptions)	Sets the value of ScheduledFargateTaskProps.getScheduledFargateTaskImageOptions()
ScheduledFargateTaskProps.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ScheduledTaskBaseProps.getSecurityGroups()
ScheduledFargateTaskProps.Builder	subnetSelection(SubnetSelection subnetSelection)	Sets the value of ScheduledTaskBaseProps.getSubnetSelection()
ScheduledFargateTaskProps.Builder	tags(List<? extends Tag> tags)	Sets the value of ScheduledTaskBaseProps.getTags()
ScheduledFargateTaskProps.Builder	taskDefinition(FargateTaskDefinition taskDefinition)	Sets the value of FargateServiceBaseProps.getTaskDefinition()
ScheduledFargateTaskProps.Builder	vpc(IVpc vpc)	Sets the value of ScheduledTaskBaseProps.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

scheduledFargateTaskDefinitionOptions

@Stability(Stable)
public ScheduledFargateTaskProps.Builder scheduledFargateTaskDefinitionOptions(ScheduledFargateTaskDefinitionOptions scheduledFargateTaskDefinitionOptions)

Sets the value of ScheduledFargateTaskProps.getScheduledFargateTaskDefinitionOptions()

Parameters:

scheduledFargateTaskDefinitionOptions - The properties to define if using an existing TaskDefinition in this construct. ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

Returns:

this

scheduledFargateTaskImageOptions

@Stability(Stable)
public ScheduledFargateTaskProps.Builder scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions scheduledFargateTaskImageOptions)

Sets the value of ScheduledFargateTaskProps.getScheduledFargateTaskImageOptions()

Parameters:

scheduledFargateTaskImageOptions - The properties to define if the construct is to create a TaskDefinition. ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

Returns:

this

schedule

@Stability(Stable)
public ScheduledFargateTaskProps.Builder schedule(Schedule schedule)

Sets the value of ScheduledTaskBaseProps.getSchedule()

Parameters:

schedule - The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. This parameter is required. For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.

Returns:

this

cluster

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

Sets the value of ScheduledTaskBaseProps.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

desiredTaskCount

@Stability(Stable)
public ScheduledFargateTaskProps.Builder desiredTaskCount(Number desiredTaskCount)

Sets the value of ScheduledTaskBaseProps.getDesiredTaskCount()

Parameters:

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

Returns:

this

enabled

@Stability(Stable)
public ScheduledFargateTaskProps.Builder enabled(Boolean enabled)

Sets the value of ScheduledTaskBaseProps.getEnabled()

Parameters:

enabled - Indicates whether the rule is enabled.

Returns:

this

propagateTags

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

Sets the value of ScheduledTaskBaseProps.getPropagateTags()

Parameters:

propagateTags - Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated.

Returns:

this

ruleName

@Stability(Stable)
public ScheduledFargateTaskProps.Builder ruleName(String ruleName)

Sets the value of ScheduledTaskBaseProps.getRuleName()

Parameters:

ruleName - A name for the rule.

Returns:

this

securityGroups

@Stability(Stable)
public ScheduledFargateTaskProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of ScheduledTaskBaseProps.getSecurityGroups()

Parameters:

securityGroups - Existing security groups to use for your service.

Returns:

this

subnetSelection

@Stability(Stable)
public ScheduledFargateTaskProps.Builder subnetSelection(SubnetSelection subnetSelection)

Sets the value of ScheduledTaskBaseProps.getSubnetSelection()

Parameters:

subnetSelection - In what subnets to place the task's ENIs. (Only applicable in case the TaskDefinition is configured for AwsVpc networking)

Returns:

this

tags

@Stability(Stable)
public ScheduledFargateTaskProps.Builder tags(List<? extends Tag> tags)

Sets the value of ScheduledTaskBaseProps.getTags()

Parameters:

tags - The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

Returns:

this

vpc

@Stability(Stable)
public ScheduledFargateTaskProps.Builder vpc(IVpc vpc)

Sets the value of ScheduledTaskBaseProps.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

cpu

@Stability(Stable)
public ScheduledFargateTaskProps.Builder cpu(Number cpu)

Sets the value of FargateServiceBaseProps.getCpu()

Parameters:

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

8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments

16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

ephemeralStorageGiB

@Stability(Stable)
public ScheduledFargateTaskProps.Builder ephemeralStorageGiB(Number ephemeralStorageGiB)

Sets the value of FargateServiceBaseProps.getEphemeralStorageGiB()

Parameters:

ephemeralStorageGiB - The amount (in GiB) of ephemeral storage to be allocated to the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

Only supported in Fargate platform version 1.4.0 or later.

Returns:

this

memoryLimitMiB

@Stability(Stable)
public ScheduledFargateTaskProps.Builder memoryLimitMiB(Number memoryLimitMiB)

Sets the value of FargateServiceBaseProps.getMemoryLimitMiB()

Parameters:

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)

Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)

Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

Returns:

this

platformVersion

@Stability(Stable)
public ScheduledFargateTaskProps.Builder platformVersion(FargatePlatformVersion platformVersion)

Sets the value of FargateServiceBaseProps.getPlatformVersion()

Parameters:

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.

Returns:

this

runtimePlatform

@Stability(Stable)
public ScheduledFargateTaskProps.Builder runtimePlatform(RuntimePlatform runtimePlatform)

Sets the value of FargateServiceBaseProps.getRuntimePlatform()

Parameters:

runtimePlatform - The runtime platform of the task definition.

Returns:

this

taskDefinition

@Stability(Stable)
public ScheduledFargateTaskProps.Builder taskDefinition(FargateTaskDefinition taskDefinition)

Sets the value of FargateServiceBaseProps.getTaskDefinition()

Parameters:

taskDefinition - The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. [disable-awslint:ref-via-interface]

Returns:

this

build

@Stability(Stable)
public ScheduledFargateTaskProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ScheduledFargateTaskProps

Throws:

NullPointerException - if any required attribute was not provided