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

Interface ScheduledFargateTaskProps

All Superinterfaces:

FargateServiceBaseProps, software.amazon.jsii.JsiiSerializable, ScheduledTaskBaseProps

All Known Implementing Classes:

ScheduledFargateTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:41.144Z")
@Stability(Stable)
public interface ScheduledFargateTaskProps
extends software.amazon.jsii.JsiiSerializable, ScheduledTaskBaseProps, FargateServiceBaseProps

The properties for the ScheduledFargateTask task.

Example:

 Vpc vpc = Vpc.Builder.create(this, "Vpc").maxAzs(1).build();
 Cluster cluster = Cluster.Builder.create(this, "EcsCluster").vpc(vpc).build();
 ScheduledFargateTask scheduledFargateTask = ScheduledFargateTask.Builder.create(this, "ScheduledFargateTask")
         .cluster(cluster)
         .scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .memoryLimitMiB(512)
                 .build())
         .schedule(Schedule.expression("rate(1 minute)"))
         .tags(List.of(Tag.builder()
                 .key("my-tag")
                 .value("my-tag-value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ScheduledFargateTaskProps.Builder	A builder for ScheduledFargateTaskProps
static final class	ScheduledFargateTaskProps.Jsii$Proxy	An implementation for ScheduledFargateTaskProps

Method Summary

Modifier and Type	Method	Description
static ScheduledFargateTaskProps.Builder	builder()
default ScheduledFargateTaskDefinitionOptions	getScheduledFargateTaskDefinitionOptions()	The properties to define if using an existing TaskDefinition in this construct.
default ScheduledFargateTaskImageOptions	getScheduledFargateTaskImageOptions()	The properties to define if the construct is to create a TaskDefinition.

Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.FargateServiceBaseProps

getCpu, getEphemeralStorageGiB, getMemoryLimitMiB, getPlatformVersion, getRuntimePlatform, getTaskDefinition

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.ScheduledTaskBaseProps

getCluster, getDesiredTaskCount, getEnabled, getPropagateTags, getRuleName, getSchedule, getSecurityGroups, getSubnetSelection, getTags, getVpc

Method Details

getScheduledFargateTaskDefinitionOptions

@Stability(Stable)
@Nullable
default ScheduledFargateTaskDefinitionOptions getScheduledFargateTaskDefinitionOptions()

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

ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

Default: none

getScheduledFargateTaskImageOptions

@Stability(Stable)
@Nullable
default ScheduledFargateTaskImageOptions getScheduledFargateTaskImageOptions()

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

ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

Default: none

builder

@Stability(Stable)
static ScheduledFargateTaskProps.Builder builder()

Returns:

a ScheduledFargateTaskProps.Builder of ScheduledFargateTaskProps