software.amazon.awscdk.services.ecs.patterns

Interface ScheduledFargateTaskImageOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ScheduledTaskImageProps

All Known Implementing Classes:

ScheduledFargateTaskImageOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T22:36:21.932Z")
 @Stability(value=Stable)
public interface ScheduledFargateTaskImageOptions
extends software.amazon.jsii.JsiiSerializable, ScheduledTaskImageProps

The properties for the ScheduledFargateTask using an image.

Example:

 Cluster cluster;
 ScheduledFargateTask scheduledFargateTask = ScheduledFargateTask.Builder.create(this, "ScheduledFargateTask")
         .cluster(cluster)
         .scheduledFargateTaskImageOptions(ScheduledFargateTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .memoryLimitMiB(512)
                 .build())
         .schedule(Schedule.expression("rate(1 minute)"))
         .platformVersion(FargatePlatformVersion.LATEST)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScheduledFargateTaskImageOptions.Builder A builder for ScheduledFargateTaskImageOptions
static class	ScheduledFargateTaskImageOptions.Jsii$Proxy An implementation for ScheduledFargateTaskImageOptions

Method Summary

Modifier and Type	Method and Description
static ScheduledFargateTaskImageOptions.Builder	builder()
default Number	getCpu() The number of cpu units used by the task.
default Number	getMemoryLimitMiB() The hard limit (in MiB) of memory to present to the container.

Methods inherited from interface software.amazon.awscdk.services.ecs.patterns.ScheduledTaskImageProps

getCommand, getEnvironment, getImage, getLogDriver, getSecrets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCpu

@Stability(value=Stable)
 @Nullable
default Number getCpu()

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

This default is set in the underlying FargateTaskDefinition construct.

Default: 256

getMemoryLimitMiB

@Stability(value=Stable)
 @Nullable
default Number getMemoryLimitMiB()

The hard limit (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

Default: 512

builder

@Stability(value=Stable)
static ScheduledFargateTaskImageOptions.Builder builder()

Specified by:

builder in interface ScheduledTaskImageProps

Returns:

a ScheduledFargateTaskImageOptions.Builder of ScheduledFargateTaskImageOptions