1.204.0

interface ScheduledTaskBaseProps

LanguageType name
.NETAmazon.CDK.AWS.ECS.Patterns.ScheduledTaskBaseProps
Javasoftware.amazon.awscdk.services.ecs.patterns.ScheduledTaskBaseProps
Pythonaws_cdk.aws_ecs_patterns.ScheduledTaskBaseProps
TypeScript (source)@aws-cdk/aws-ecs-patterns » ScheduledTaskBaseProps

The properties for the base ScheduledEc2Task or ScheduledFargateTask task.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appscaling from '@aws-cdk/aws-applicationautoscaling';
import * as ec2 from '@aws-cdk/aws-ec2';
import * as ecs from '@aws-cdk/aws-ecs';
import * as ecs_patterns from '@aws-cdk/aws-ecs-patterns';

declare const cluster: ecs.Cluster;
declare const schedule: appscaling.Schedule;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const scheduledTaskBaseProps: ecs_patterns.ScheduledTaskBaseProps = {
  schedule: schedule,

  // the properties below are optional
  cluster: cluster,
  desiredTaskCount: 123,
  enabled: false,
  ruleName: 'ruleName',
  securityGroups: [securityGroup],
  subnetSelection: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnetName: 'subnetName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.ISOLATED,
  },
  vpc: vpc,
};

Properties

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.
ruleName?stringA name for the rule.
securityGroups?ISecurityGroup[]Existing security groups to use for your service.
subnetSelection?SubnetSelectionIn what subnets to place the task's ENIs.
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.

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.

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)

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.

← PreviousNext →