AWS CDK Reference

Appearance

v2.274.0

ScheduledFargateTaskProps Struct ​

The properties for the ScheduledFargateTask task.

Source
aws-ecs-patterns/lib/fargate/scheduled-fargate-task.ts
Type last changed
v2.38.0 · 17 Aug 2022

Example ​

ts
const vpc = new ec2.Vpc(this, 'Vpc', { maxAzs: 1 });
const cluster = new ecs.Cluster(this, 'EcsCluster', { vpc });
const scheduledFargateTask = new ecsPatterns.ScheduledFargateTask(this, 'ScheduledFargateTask', {
  cluster,
  scheduledFargateTaskImageOptions: {
    image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
    memoryLimitMiB: 512,
  },
  schedule: appscaling.Schedule.expression('rate(1 minute)'),
  tags: [
    {
      key: 'my-tag',
      value: 'my-tag-value',
    },
  ],
});

Properties ​

circuitBreakerDeploymentCircuitBreakercircuit_breakerDeploymentCircuitBreakercircuitBreakerDeploymentCircuitBreakerCircuitBreakerDeploymentCircuitBreakerCircuitBreakerDeploymentCircuitBreaker= disabled#
Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

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.

cpunumbercpuint | floatcpuNumberCpudoubleCpu*float64= 256#
The number of cpu units used by the task.
notes

Valid values, which determines your range of valid values for the memory parameter:

256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB

512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB

1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB

2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments

4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments

8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments

16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments

This default is set in the underlying FargateTaskDefinition construct.

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.
ephemeralStorageGiBnumberephemeral_storage_gi_bint | floatephemeralStorageGiBNumberEphemeralStorageGiBdoubleEphemeralStorageGiB*float64= Undefined, in which case, the ta…#
The amount (in GiB) of ephemeral storage to be allocated to the task.

The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

Only supported in Fargate platform version 1.4.0 or later.

default

Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.

memoryLimitMiBnumbermemory_limit_mi_bint | floatmemoryLimitMiBNumberMemoryLimitMiBdoubleMemoryLimitMiB*float64= 512#
The amount (in MiB) of memory used by the task.
notes

This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)

Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)

This default is set in the underlying FargateTaskDefinition construct.

platformVersionFargatePlatformVersionplatform_versionFargatePlatformVersionplatformVersionFargatePlatformVersionPlatformVersionFargatePlatformVersionPlatformVersionFargatePlatformVersion= Latest#
The platform version on which to run your service.
notes

If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

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.

runtimePlatformRuntimePlatformruntime_platformRuntimePlatformruntimePlatformRuntimePlatformRuntimePlatformRuntimePlatformRuntimePlatformRuntimePlatform= If the property is undefined, `o…#
The runtime platform of the task definition.
default

Default: If the property is undefined, operatingSystemFamily is LINUX and cpuArchitecture is X86_64

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.

scheduledFargateTaskDefinitionOptionsScheduledFargateTaskDefinitionOptionsscheduled_fargate_task_definition_optionsScheduledFargateTaskDefinitionOptionsscheduledFargateTaskDefinitionOptionsScheduledFargateTaskDefinitionOptionsScheduledFargateTaskDefinitionOptionsScheduledFargateTaskDefinitionOptionsScheduledFargateTaskDefinitionOptionsScheduledFargateTaskDefinitionOptions= none#
The properties to define if using an existing TaskDefinition in this construct.

ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

scheduledFargateTaskImageOptionsScheduledFargateTaskImageOptionsscheduled_fargate_task_image_optionsScheduledFargateTaskImageOptionsscheduledFargateTaskImageOptionsScheduledFargateTaskImageOptionsScheduledFargateTaskImageOptionsScheduledFargateTaskImageOptionsScheduledFargateTaskImageOptionsScheduledFargateTaskImageOptions= none#
The properties to define if the construct is to create a TaskDefinition.

ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions 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.

taskDefinitionFargateTaskDefinitiontask_definitionFargateTaskDefinitiontaskDefinitionFargateTaskDefinitionTaskDefinitionFargateTaskDefinitionTaskDefinitionFargateTaskDefinition= none#
The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.

[disable-awslint:ref-via-interface]

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.