AWS CDK Reference

Appearance

v2.274.0

ScheduledFargateTaskImageOptions Struct ​

The properties for the ScheduledFargateTask using an image.

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

Example ​

ts
declare const cluster: ecs.Cluster;
const scheduledFargateTask = new ecsPatterns.ScheduledFargateTask(this, 'ScheduledFargateTask', {
  cluster,
  scheduledFargateTaskImageOptions: {
    image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
    containerName: 'customContainerName',
    memoryLimitMiB: 512,
  },
  schedule: appscaling.Schedule.expression('rate(1 minute)'),
  platformVersion: ecs.FargatePlatformVersion.LATEST,
});

Properties ​

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

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

commandstring[]commandtyping.List[str]commandList<String>Commandstring[]Command*[]*string#
The command that is passed to the container.

Default: CMD value built into container image.

If you provide a shell command as a single string, you have to quote command-line arguments.

containerNamestringcontainer_namestrcontainerNameStringContainerNamestringContainerName*string= ScheduledContainer#
Optional name for the container added.
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.

environment{ [key: string]: string }environmenttyping.Mapping[str, str]environmentMap<String, String>EnvironmentIDictionary<string, string>Environment*map[string]*string= none#
The environment variables to pass to the container.
ephemeralStorageGiBnumberephemeral_storage_gi_bint | floatephemeralStorageGiBNumberEphemeralStorageGiBdoubleEphemeralStorageGiB*float64#
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.

imageContainerImageimageContainerImageimageContainerImageImageContainerImageImageContainerImage= nonerequired#
The image used to start a container.

Image or taskDefinition must be specified, but not both.

logDriverLogDriverlog_driverLogDriverlogDriverLogDriverLogDriverLogDriverLogDriverLogDriver#
The log driver to use.

Default: AwsLogDriver if enableLogging is true

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.

runtimePlatformRuntimePlatformruntime_platformRuntimePlatformruntimePlatformRuntimePlatformRuntimePlatformRuntimePlatformRuntimePlatformRuntimePlatform#
The runtime platform of the task definition.

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

secrets{ [key: string]: Secret }secretstyping.Mapping[str, Secret]secretsMap<String, Secret>SecretsIDictionary<string, Secret>Secrets*map[string]Secret#
The secret to expose to the container as an environment variable.

Default: No secret environment variables.

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]