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

Interface ScheduledEc2TaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ScheduledTaskBaseProps

All Known Implementing Classes:

ScheduledEc2TaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:01.288Z")
@Stability(Stable)
public interface ScheduledEc2TaskProps
extends software.amazon.jsii.JsiiSerializable, ScheduledTaskBaseProps

The properties for the ScheduledEc2Task task.

Example:

 // Instantiate an Amazon EC2 Task to run at a scheduled interval
 Cluster cluster;
 ScheduledEc2Task ecsScheduledTask = ScheduledEc2Task.Builder.create(this, "ScheduledTask")
         .cluster(cluster)
         .scheduledEc2TaskImageOptions(ScheduledEc2TaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .memoryLimitMiB(256)
                 .environment(Map.of("name", "TRIGGER", "value", "CloudWatch Events"))
                 .build())
         .schedule(Schedule.expression("rate(1 minute)"))
         .enabled(true)
         .ruleName("sample-scheduled-task-rule")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ScheduledEc2TaskProps.Builder	builder()
default ScheduledEc2TaskDefinitionOptions	getScheduledEc2TaskDefinitionOptions()	The properties to define if using an existing TaskDefinition in this construct.
default ScheduledEc2TaskImageOptions	getScheduledEc2TaskImageOptions()	The properties to define if the construct is to create a TaskDefinition.

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

getScheduledEc2TaskDefinitionOptions

@Stability(Stable)
@Nullable
default ScheduledEc2TaskDefinitionOptions getScheduledEc2TaskDefinitionOptions()

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

ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.

Default: none

getScheduledEc2TaskImageOptions

@Stability(Stable)
@Nullable
default ScheduledEc2TaskImageOptions getScheduledEc2TaskImageOptions()

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

ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.

Default: none

builder

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

Returns:

a ScheduledEc2TaskProps.Builder of ScheduledEc2TaskProps