aws-cdk-lib.aws_ecs_patterns.ScheduledEc2Task

class ScheduledEc2Task (construct)

LanguageType name
.NETAmazon.CDK.AWS.ECS.Patterns.ScheduledEc2Task
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#ScheduledEc2Task
Javasoftware.amazon.awscdk.services.ecs.patterns.ScheduledEc2Task
Pythonaws_cdk.aws_ecs_patterns.ScheduledEc2Task
TypeScript (source)aws-cdk-lib » aws_ecs_patterns » ScheduledEc2Task

Implements IConstruct, IDependable

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

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',
});

Initializer

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

Parameters

  • scope Construct
  • id string
  • props ScheduledEc2TaskProps

Constructs a new instance of the ScheduledEc2Task class.

Construct Props

NameTypeDescription
scheduleScheduleThe schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
cluster?IClusterThe name of the cluster that hosts the service.
desiredTaskCount?numberThe desired number of instantiations of the task definition to keep running on the service.
enabled?booleanIndicates whether the rule is enabled.
propagateTags?PropagatedTagSourceSpecifies whether to propagate the tags from the task definition to the task.
ruleName?stringA name for the rule.
scheduledEc2TaskDefinitionOptions?ScheduledEc2TaskDefinitionOptionsThe properties to define if using an existing TaskDefinition in this construct.
scheduledEc2TaskImageOptions?ScheduledEc2TaskImageOptionsThe properties to define if the construct is to create a TaskDefinition.
securityGroups?ISecurityGroup[]Existing security groups to use for your service.
subnetSelection?SubnetSelectionIn what subnets to place the task's ENIs.
tags?Tag[]The metadata that you apply to the task to help you categorize and organize them.
vpc?IVpcThe VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

schedule

Type: Schedule

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.


cluster?

Type: ICluster (optional, default: create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.)

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.


desiredTaskCount?

Type: number (optional, default: 1)

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


enabled?

Type: boolean (optional, default: true)

Indicates whether the rule is enabled.


propagateTags?

Type: PropagatedTagSource (optional, default: 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.


ruleName?

Type: string (optional, default: AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.)

A name for the rule.


scheduledEc2TaskDefinitionOptions?

Type: ScheduledEc2TaskDefinitionOptions (optional, default: none)

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

ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.


scheduledEc2TaskImageOptions?

Type: ScheduledEc2TaskImageOptions (optional, default: none)

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

ScheduledEc2TaskDefinitionOptions or ScheduledEc2TaskImageOptions must be defined, but not both.


securityGroups?

Type: ISecurityGroup[] (optional, default: a new security group will be created.)

Existing security groups to use for your service.


subnetSelection?

Type: SubnetSelection (optional, default: Private subnets)

In what subnets to place the task's ENIs.

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


tags?

Type: Tag[] (optional, default: 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.


vpc?

Type: IVpc (optional, default: uses the VPC defined in the cluster or creates a new 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.

Properties

NameTypeDescription
clusterIClusterThe name of the cluster that hosts the service.
desiredTaskCountnumberThe desired number of instantiations of the task definition to keep running on the service.
eventRuleRuleThe CloudWatch Events rule for the service.
nodeNodeThe tree node.
subnetSelectionSubnetSelectionIn what subnets to place the task's ENIs.
taskEcsTaskThe ECS task in this construct.
taskDefinitionEc2TaskDefinitionThe EC2 task definition in this construct.
propagateTags?PropagatedTagSourceSpecifies whether to propagate the tags from the task definition to the task.
tags?Tag[]The metadata that you apply to the task to help you categorize and organize them.

cluster

Type: ICluster

The name of the cluster that hosts the service.


desiredTaskCount

Type: number

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

The minimum value is 1


eventRule

Type: Rule

The CloudWatch Events rule for the service.


node

Type: Node

The tree node.


subnetSelection

Type: SubnetSelection

In what subnets to place the task's ENIs.

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


task

Type: EcsTask

The ECS task in this construct.


taskDefinition

Type: Ec2TaskDefinition

The EC2 task definition in this construct.


propagateTags?

Type: PropagatedTagSource (optional, default: 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.


tags?

Type: Tag[] (optional, default: 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.

Methods

NameDescription
toString()Returns a string representation of this construct.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.