Class ScheduledFargateTaskProps
The properties for the ScheduledFargateTask task.
Inheritance
Namespace: Amazon.CDK.AWS.ECS.Patterns
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ScheduledFargateTaskProps : Object, IScheduledFargateTaskProps, IScheduledTaskBaseProps, IFargateServiceBaseProps
Syntax (vb)
Public Class ScheduledFargateTaskProps
Inherits Object
Implements IScheduledFargateTaskProps, IScheduledTaskBaseProps, IFargateServiceBaseProps
Remarks
ExampleMetadata: infused
Examples
var vpc = new Vpc(this, "Vpc", new VpcProps { MaxAzs = 1 });
var cluster = new Cluster(this, "EcsCluster", new ClusterProps { Vpc = vpc });
var scheduledFargateTask = new ScheduledFargateTask(this, "ScheduledFargateTask", new ScheduledFargateTaskProps {
Cluster = cluster,
ScheduledFargateTaskImageOptions = new ScheduledFargateTaskImageOptions {
Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample"),
MemoryLimitMiB = 512
},
Schedule = Schedule.Expression("rate(1 minute)"),
Tags = new [] { new Tag {
Key = "my-tag",
Value = "my-tag-value"
} }
});
Synopsis
Constructors
ScheduledFargateTaskProps() |
Properties
Cluster | The name of the cluster that hosts the service. |
Cpu | The number of cpu units used by the task. |
DesiredTaskCount | The desired number of instantiations of the task definition to keep running on the service. |
Enabled | Indicates whether the rule is enabled. |
EphemeralStorageGiB | The amount (in GiB) of ephemeral storage to be allocated to the task. |
MemoryLimitMiB | The amount (in MiB) of memory used by the task. |
PlatformVersion | The platform version on which to run your service. |
PropagateTags | Specifies whether to propagate the tags from the task definition to the task. |
RuleName | A name for the rule. |
RuntimePlatform | The runtime platform of the task definition. |
Schedule | The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. |
ScheduledFargateTaskDefinitionOptions | The properties to define if using an existing TaskDefinition in this construct. |
ScheduledFargateTaskImageOptions | The properties to define if the construct is to create a TaskDefinition. |
SecurityGroups | Existing security groups to use for your service. |
SubnetSelection | In what subnets to place the task's ENIs. |
Tags | The metadata that you apply to the task to help you categorize and organize them. |
TaskDefinition | The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. |
Vpc | The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. |
Constructors
ScheduledFargateTaskProps()
public ScheduledFargateTaskProps()
Properties
Cluster
The name of the cluster that hosts the service.
public ICluster Cluster { get; set; }
Property Value
Remarks
If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
Cpu
The number of cpu units used by the task.
public Nullable<double> Cpu { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
Default: 256
DesiredTaskCount
The desired number of instantiations of the task definition to keep running on the service.
public Nullable<double> DesiredTaskCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
Enabled
Indicates whether the rule is enabled.
public Nullable<bool> Enabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
EphemeralStorageGiB
The amount (in GiB) of ephemeral storage to be allocated to the task.
public Nullable<double> EphemeralStorageGiB { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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: Undefined, in which case, the task will receive 20GiB ephemeral storage.
MemoryLimitMiB
The amount (in MiB) of memory used by the task.
public Nullable<double> MemoryLimitMiB { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
Default: 512
PlatformVersion
The platform version on which to run your service.
public Nullable<FargatePlatformVersion> PlatformVersion { get; set; }
Property Value
System.Nullable<FargatePlatformVersion>
Remarks
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.
Default: Latest
PropagateTags
Specifies whether to propagate the tags from the task definition to the task.
public Nullable<PropagatedTagSource> PropagateTags { get; set; }
Property Value
System.Nullable<PropagatedTagSource>
Remarks
If no value is specified, the tags are not propagated.
Default: - Tags will not be propagated
RuleName
A name for the rule.
public string RuleName { get; set; }
Property Value
System.String
Remarks
Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.
RuntimePlatform
The runtime platform of the task definition.
public IRuntimePlatform RuntimePlatform { get; set; }
Property Value
Remarks
Default: - If the property is undefined, operatingSystemFamily
is LINUX and cpuArchitecture
is X86_64
Schedule
The schedule or rate (frequency) that determines when CloudWatch Events runs the rule.
public Schedule Schedule { get; set; }
Property Value
Remarks
For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.
ScheduledFargateTaskDefinitionOptions
The properties to define if using an existing TaskDefinition in this construct.
public IScheduledFargateTaskDefinitionOptions ScheduledFargateTaskDefinitionOptions { get; set; }
Property Value
IScheduledFargateTaskDefinitionOptions
Remarks
ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.
Default: none
ScheduledFargateTaskImageOptions
The properties to define if the construct is to create a TaskDefinition.
public IScheduledFargateTaskImageOptions ScheduledFargateTaskImageOptions { get; set; }
Property Value
IScheduledFargateTaskImageOptions
Remarks
ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.
Default: none
SecurityGroups
Existing security groups to use for your service.
public ISecurityGroup[] SecurityGroups { get; set; }
Property Value
Remarks
Default: - a new security group will be created.
SubnetSelection
In what subnets to place the task's ENIs.
public ISubnetSelection SubnetSelection { get; set; }
Property Value
Remarks
(Only applicable in case the TaskDefinition is configured for AwsVpc networking)
Default: Private subnets
Tags
The metadata that you apply to the task to help you categorize and organize them.
public ITag[] Tags { get; set; }
Property Value
ITag[]
Remarks
Each tag consists of a key and an optional value, both of which you define.
Default: - No tags are applied to the task
TaskDefinition
The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
public FargateTaskDefinition TaskDefinition { get; set; }
Property Value
Remarks
[disable-awslint:ref-via-interface]
Default: - none
Vpc
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
public IVpc Vpc { get; set; }
Property Value
Remarks
If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.
Default: - uses the VPC defined in the cluster or creates a new VPC.