# ScheduledFargateTask

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

Extends: Construct › ScheduledTaskBase › ScheduledFargateTask
Implements: IConstruct, IDependable

- Source: [`aws-ecs-patterns/lib/fargate/scheduled-fargate-task.ts`](https://github.com/aws/aws-cdk/blob/v2.276.0/packages/aws-cdk-lib/aws-ecs-patterns/lib/fargate/scheduled-fargate-task.ts#L55)

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

## Initializer

```ts
new ScheduledFargateTask(scope: Construct, id: string, props: ScheduledFargateTaskProps)
```

## Construct Props

- `circuitBreaker`: [DeploymentCircuitBreaker](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.DeploymentCircuitBreaker.html) = disabled — Whether to enable the deployment circuit breaker.

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

- `cluster`: [ICluster](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ICluster.html) — The name of the cluster that hosts the service.

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

  If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

- `cpu`: number = 256 — The number of cpu units used by the task.

  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.

- `desiredTaskCount`: number = 1 — The desired number of instantiations of the task definition to keep running on the service.

- `enabled`: boolean = true — Indicates whether the rule is enabled.

- `ephemeralStorageGiB`: number — The amount (in GiB) of ephemeral storage to be allocated to the task.

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

  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.

- `memoryLimitMiB`: number = 512 — The amount (in MiB) of memory used by the task.

  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.

- `platformVersion`: [FargatePlatformVersion](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargatePlatformVersion.html) = Latest — The platform version on which to run your service.

  If one is not specified, the LATEST platform version is used by default. For more information, see
  [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
  in the Amazon Elastic Container Service Developer Guide.

- `propagateTags`: [PropagatedTagSource](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PropagatedTagSource.html) — Specifies whether to propagate the tags from the task definition to the task.

  **Default:** Tags will not be propagated

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

- `ruleName`: string — A name for the rule.

  **Default:** AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).

- `runtimePlatform`: [RuntimePlatform](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.RuntimePlatform.html) — The runtime platform of the task definition.

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

- `schedule`: [Schedule](/cdk/api/v2/docs/aws-cdk-lib.aws_applicationautoscaling.Schedule.html) (required) — The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.

  For more information, see
  [Schedule Expression Syntax for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html)
  in the Amazon CloudWatch User Guide.

- `scheduledFargateTaskDefinitionOptions`: [ScheduledFargateTaskDefinitionOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.ScheduledFargateTaskDefinitionOptions.html) = none — The properties to define if using an existing TaskDefinition in this construct.

  ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

- `scheduledFargateTaskImageOptions`: [ScheduledFargateTaskImageOptions](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs_patterns.ScheduledFargateTaskImageOptions.html) = none — The properties to define if the construct is to create a TaskDefinition.

  ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

- `securityGroups`: [ISecurityGroup](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ISecurityGroup.html)[] — Existing security groups to use for your service.

  **Default:** a new security group will be created.

- `subnetSelection`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html) — In what subnets to place the task's ENIs.

  **Default:** Private subnets

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

- `tags`: [Tag](/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets.Tag.html)[] — The metadata that you apply to the task to help you categorize and organize them.

  **Default:** No tags are applied to the task

  Each tag consists of a key and an optional value, both of which you define.

- `taskDefinition`: [FargateTaskDefinition](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinition.html) = 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]

- `vpc`: [IVpc](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) — The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

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

  If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

## Properties

- `cluster`: [ICluster](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ICluster.html) — The name of the cluster that hosts the service.

- `desiredTaskCount`: number — The desired number of instantiations of the task definition to keep running on the service.

  The minimum value is 1

- `eventRule`: [Rule](/cdk/api/v2/docs/aws-cdk-lib.aws_events.Rule.html) — The CloudWatch Events rule for the service.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `propagateTags`: [PropagatedTagSource](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PropagatedTagSource.html) — Specifies whether to propagate the tags from the task definition to the task.

  **Default:** Tags will not be propagated

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

- `subnetSelection`: [SubnetSelection](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.SubnetSelection.html) — In what subnets to place the task's ENIs.

  **Default:** Private subnets

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

- `tags`: [Tag](/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets.Tag.html)[] — The metadata that you apply to the task to help you categorize and organize them.

  **Default:** No tags are applied to the task

  Each tag consists of a key and an optional value, both of which you define.

- `task`: [EcsTask](/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets.EcsTask.html) — The ECS task in this construct.

- `taskDefinition`: [FargateTaskDefinition](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.FargateTaskDefinition.html) — The Fargate task definition in this construct.

## Methods

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  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**

  - `x` — Any object.

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

- `toString(): string` — Returns a string representation of this construct.

- `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.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining