ScheduledEc2Task L3 construct

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

Source: aws-ecs-patterns/lib/ecs/scheduled-ecs-task.ts

Example

// Instantiate an Amazon EC2 Task to run at a scheduled interval
declare const cluster: ecs.Cluster;
const ecsScheduledTask = new ecsPatterns.ScheduledEc2Task(this, 'ScheduledTask', {
  cluster,
  scheduledEc2TaskImageOptions: {
    image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
    memoryLimitMiB: 256,
    environment: { name: 'TRIGGER', value: 'CloudWatch Events' },
  },
  schedule: appscaling.Schedule.expression('rate(1 minute)'),
  enabled: true,
  ruleName: 'sample-scheduled-task-rule',
});

python

# Instantiate an Amazon EC2 Task to run at a scheduled interval
# cluster: ecs.Cluster

ecs_scheduled_task = ecs_patterns.ScheduledEc2Task(self, "ScheduledTask",
    cluster=cluster,
    scheduled_ec2_task_image_options=ecsPatterns.ScheduledEc2TaskImageOptions(
        image=ecs.ContainerImage.from_registry("amazon/amazon-ecs-sample"),
        memory_limit_mi_b=256,
        environment={"name": "TRIGGER", "value": "CloudWatch Events"}
    ),
    schedule=appscaling.Schedule.expression("rate(1 minute)"),
    enabled=True,
    rule_name="sample-scheduled-task-rule"
)

java

// 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();

csharp

// Install: dotnet add package Amazon.CDK.Lib
// Instantiate an Amazon EC2 Task to run at a scheduled interval
Cluster cluster;

var ecsScheduledTask = new ScheduledEc2Task(this, "ScheduledTask", new ScheduledEc2TaskProps {
    Cluster = cluster,
    ScheduledEc2TaskImageOptions = new ScheduledEc2TaskImageOptions {
        Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample"),
        MemoryLimitMiB = 256,
        Environment = new Dictionary<string, string> { { "name", "TRIGGER" }, { "value", "CloudWatch Events" } }
    },
    Schedule = Schedule.Expression("rate(1 minute)"),
    Enabled = true,
    RuleName = "sample-scheduled-task-rule"
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Instantiate an Amazon EC2 Task to run at a scheduled interval
var cluster Cluster

ecsScheduledTask := ecsPatterns.NewScheduledEc2Task(this, jsii.String("ScheduledTask"), &ScheduledEc2TaskProps{
	Cluster: Cluster,
	ScheduledEc2TaskImageOptions: &ScheduledEc2TaskImageOptions{
		Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")),
		MemoryLimitMiB: jsii.Number(256),
		Environment: map[string]*string{
			"name": jsii.String("TRIGGER"),
			"value": jsii.String("CloudWatch Events"),
		},
	},
	Schedule: appscaling.Schedule_Expression(jsii.String("rate(1 minute)")),
	Enabled: jsii.Boolean(true),
	RuleName: jsii.String("sample-scheduled-task-rule"),
})

Initializer

new ScheduledEc2Task(scope: Construct, id: string, props: ScheduledEc2TaskProps)

python

ScheduledEc2Task(scope: Construct, id: str, props: ScheduledEc2TaskProps)

java

new ScheduledEc2Task(Construct scope, String id, ScheduledEc2TaskProps props)

csharp

new ScheduledEc2Task(Construct scope, string id, ScheduledEc2TaskProps props)

NewScheduledEc2Task(Scope Construct, Id *string, Props ScheduledEc2TaskProps)

Construct Props

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterICluster= create a new cluster; if both cl…#

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

Default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

desiredTaskCountnumberdesired_task_countint | floatdesiredTaskCountNumberDesiredTaskCountdoubleDesiredTaskCount*float64= 1#

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

enabledbooleanenabledboolenabledBooleanEnabledboolEnabled*bool= true#

Indicates whether the rule is enabled.

propagateTagsPropagatedTagSourcepropagate_tagsPropagatedTagSourcepropagateTagsPropagatedTagSourcePropagateTagsPropagatedTagSourcePropagateTagsPropagatedTagSource= Tags will not be propagated#

Specifies whether to propagate the tags from the task definition to the task.

If no value is specified, the tags are not propagated.

ruleNamestringrule_namestrruleNameStringRuleNamestringRuleName*string= AWS CloudFormation generates a u…#

A name for the rule.

default

Default: AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

scheduleSchedulescheduleSchedulescheduleScheduleScheduleScheduleScheduleSchedulerequired#

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.

scheduledEc2TaskDefinitionOptionsScheduledEc2TaskDefinitionOptionsscheduled_ec2_task_definition_optionsScheduledEc2TaskDefinitionOptionsscheduledEc2TaskDefinitionOptionsScheduledEc2TaskDefinitionOptionsScheduledEc2TaskDefinitionOptionsScheduledEc2TaskDefinitionOptionsScheduledEc2TaskDefinitionOptionsScheduledEc2TaskDefinitionOptions= none#

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

ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.

scheduledEc2TaskImageOptionsScheduledEc2TaskImageOptionsscheduled_ec2_task_image_optionsScheduledEc2TaskImageOptionsscheduledEc2TaskImageOptionsScheduledEc2TaskImageOptionsScheduledEc2TaskImageOptionsScheduledEc2TaskImageOptionsScheduledEc2TaskImageOptionsScheduledEc2TaskImageOptions= none#

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

ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= a new security group will be cre…#

Existing security groups to use for your service.

default

Default: a new security group will be created.

subnetSelectionSubnetSelectionsubnet_selectionSubnetSelectionsubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelection= Private subnets#

In what subnets to place the task's ENIs.

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

tagsTag[]tagstyping.List[Tag]tagsList<Tag>TagsTag[]Tags*[]Tag= No tags are applied to the task#

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.

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpc= uses the VPC defined in the clus…#

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

Default: uses the VPC defined in the cluster or creates a new VPC.

Properties

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#

The name of the cluster that hosts the service.

desiredTaskCountnumberdesired_task_countint | floatdesiredTaskCountNumberDesiredTaskCountdoubleDesiredTaskCount*float64required#

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

The minimum value is 1

eventRuleRuleevent_ruleRuleeventRuleRuleEventRuleRuleEventRuleRulerequired#

The CloudWatch Events rule for the service.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

Specifies whether to propagate the tags from the task definition to the task.

If no value is specified, the tags are not propagated.

subnetSelectionSubnetSelectionsubnet_selectionSubnetSelectionsubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelection= Private subnetsrequired#

In what subnets to place the task's ENIs.

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

tagsTag[]tagstyping.List[Tag]tagsList<Tag>TagsTag[]Tags*[]Tag= No tags are applied to the task#

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.

taskEcsTasktaskEcsTasktaskEcsTaskTaskEcsTaskTaskEcsTaskrequired#

The ECS task in this construct.

taskDefinitionEc2TaskDefinitiontask_definitionEc2TaskDefinitiontaskDefinitionEc2TaskDefinitionTaskDefinitionEc2TaskDefinitionTaskDefinitionEc2TaskDefinitionrequired#

The EC2 task definition in this construct.

Methods

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining

ScheduledEc2Task L3 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​

ScheduledEc2Task L3 construct

Example

Initializer

Construct Props

Properties

Methods