interface ScheduledTaskBaseProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECS.Patterns.ScheduledTaskBaseProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#ScheduledTaskBaseProps |
![]() | software.amazon.awscdk.services.ecs.patterns.ScheduledTaskBaseProps |
![]() | aws_cdk.aws_ecs_patterns.ScheduledTaskBaseProps |
![]() | aws-cdk-lib » 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 { aws_applicationautoscaling as appscaling } from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_ecs_patterns as ecs_patterns } from 'aws-cdk-lib';
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,
propagateTags: ecs.PropagatedTagSource.SERVICE,
ruleName: 'ruleName',
securityGroups: [securityGroup],
subnetSelection: {
availabilityZones: ['availabilityZones'],
onePerAz: false,
subnetFilters: [subnetFilter],
subnetGroupName: 'subnetGroupName',
subnets: [subnet],
subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
},
tags: [{
key: 'key',
value: 'value',
}],
vpc: vpc,
};
Properties
Name | Type | Description |
---|---|---|
schedule | Schedule | The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. |
cluster? | ICluster | The name of the cluster that hosts the service. |
desired | number | The desired number of instantiations of the task definition to keep running on the service. |
enabled? | boolean | Indicates whether the rule is enabled. |
propagate | Propagated | Specifies whether to propagate the tags from the task definition to the task. |
rule | string | A name for the rule. |
security | ISecurity [] | Existing security groups to use for your service. |
subnet | Subnet | In 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? | IVpc | The 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:
Propagated
(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.
securityGroups?
Type:
ISecurity
[]
(optional, default: a new security group will be created.)
Existing security groups to use for your service.
subnetSelection?
Type:
Subnet
(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.