Package software.amazon.awscdk.services.ecs.patterns

Interface ScheduledFargateTaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ScheduledTaskBaseProps

All Known Implementing Classes:

ScheduledFargateTaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.810Z")
@Stability(Stable)
public interface ScheduledFargateTaskProps
extends software.amazon.jsii.JsiiSerializable, ScheduledTaskBaseProps

The properties for the ScheduledFargateTask task.

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	Description
static final class	ScheduledFargateTaskProps.Builder	A builder for ScheduledFargateTaskProps
static final class	ScheduledFargateTaskProps.Jsii$Proxy	An implementation for ScheduledFargateTaskProps

Method Summary

Modifier and Type	Method	Description
static ScheduledFargateTaskProps.Builder	builder()
default FargatePlatformVersion	getPlatformVersion()	The platform version on which to run your service.
default ScheduledFargateTaskDefinitionOptions	getScheduledFargateTaskDefinitionOptions()	The properties to define if using an existing TaskDefinition in this construct.
default ScheduledFargateTaskImageOptions	getScheduledFargateTaskImageOptions()	The properties to define if the construct is to create a TaskDefinition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getCluster, getDesiredTaskCount, getEnabled, getRuleName, getSchedule, getSecurityGroups, getSubnetSelection, getVpc

Method Details

getPlatformVersion

@Stability(Stable)
@Nullable
default FargatePlatformVersion getPlatformVersion()

The platform version on which to run your service.

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

getScheduledFargateTaskDefinitionOptions

@Stability(Stable)
@Nullable
default ScheduledFargateTaskDefinitionOptions getScheduledFargateTaskDefinitionOptions()

The properties to define if using an existing TaskDefinition in this construct.

ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

Default: none

getScheduledFargateTaskImageOptions

@Stability(Stable)
@Nullable
default ScheduledFargateTaskImageOptions getScheduledFargateTaskImageOptions()

The properties to define if the construct is to create a TaskDefinition.

ScheduledFargateTaskDefinitionOptions or ScheduledFargateTaskImageOptions must be defined, but not both.

Default: none

builder

@Stability(Stable)
static ScheduledFargateTaskProps.Builder builder()

Returns:

a ScheduledFargateTaskProps.Builder of ScheduledFargateTaskProps