software.amazon.awscdk.services.ecs.patterns

Class ScheduledEc2Task

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.ecs.patterns.ScheduledTaskBase

software.amazon.awscdk.services.ecs.patterns.ScheduledEc2Task

All Implemented Interfaces:

IConstruct, IDependable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:17.217Z")
public class ScheduledEc2Task
extends ScheduledTaskBase

A scheduled EC2 task that will be initiated off of CloudWatch Events.

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	Class and Description
static class	ScheduledEc2Task.Builder A fluent builder for ScheduledEc2Task.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScheduledEc2Task(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ScheduledEc2Task(software.amazon.jsii.JsiiObjectRef objRef)
	ScheduledEc2Task(software.constructs.Construct scope, java.lang.String id, ScheduledEc2TaskProps props) Constructs a new instance of the ScheduledEc2Task class.

Method Summary

Modifier and Type	Method and Description
EcsTask	getTask() The ECS task in this construct.
Ec2TaskDefinition	getTaskDefinition() The EC2 task definition in this construct.

Methods inherited from class software.amazon.awscdk.services.ecs.patterns.ScheduledTaskBase

addTaskAsTarget, addTaskDefinitionToEventTarget, createAWSLogDriver, getCluster, getDefaultCluster, getDefaultCluster, getDesiredTaskCount, getEventRule, getSubnetSelection

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScheduledEc2Task

protected ScheduledEc2Task(software.amazon.jsii.JsiiObjectRef objRef)

ScheduledEc2Task

protected ScheduledEc2Task(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ScheduledEc2Task

public ScheduledEc2Task(software.constructs.Construct scope,
                        java.lang.String id,
                        ScheduledEc2TaskProps props)

Constructs a new instance of the ScheduledEc2Task class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getTask

public EcsTask getTask()

The ECS task in this construct.

getTaskDefinition

public Ec2TaskDefinition getTaskDefinition()

The EC2 task definition in this construct.