software.amazon.awscdk.services.scheduler

Interface CfnSchedule.EcsParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSchedule.EcsParametersProperty.Jsii$Proxy

Enclosing class:

CfnSchedule

@Stability(value=Stable)
public static interface CfnSchedule.EcsParametersProperty
extends software.amazon.jsii.JsiiSerializable

The templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.scheduler.*;
 Object tags;
 EcsParametersProperty ecsParametersProperty = EcsParametersProperty.builder()
         .taskDefinitionArn("taskDefinitionArn")
         // the properties below are optional
         .capacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                 .capacityProvider("capacityProvider")
                 // the properties below are optional
                 .base(123)
                 .weight(123)
                 .build()))
         .enableEcsManagedTags(false)
         .enableExecuteCommand(false)
         .group("group")
         .launchType("launchType")
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .awsvpcConfiguration(AwsVpcConfigurationProperty.builder()
                         .subnets(List.of("subnets"))
                         // the properties below are optional
                         .assignPublicIp("assignPublicIp")
                         .securityGroups(List.of("securityGroups"))
                         .build())
                 .build())
         .placementConstraints(List.of(PlacementConstraintProperty.builder()
                 .expression("expression")
                 .type("type")
                 .build()))
         .placementStrategy(List.of(PlacementStrategyProperty.builder()
                 .field("field")
                 .type("type")
                 .build()))
         .platformVersion("platformVersion")
         .propagateTags("propagateTags")
         .referenceId("referenceId")
         .tags(List.of(tags))
         .taskCount(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnSchedule.EcsParametersProperty.Builder	builder()
default Object	getCapacityProviderStrategy() The capacity provider strategy to use for the task.
default Object	getEnableEcsManagedTags() Specifies whether to enable Amazon ECS managed tags for the task.
default Object	getEnableExecuteCommand() Whether or not to enable the execute command functionality for the containers in this task.
default String	getGroup() Specifies an ECS task group for the task.
default String	getLaunchType() Specifies the launch type on which your task is running.
default Object	getNetworkConfiguration() This structure specifies the network configuration for an ECS task.
default Object	getPlacementConstraints() An array of placement constraint objects to use for the task.
default Object	getPlacementStrategy() The task placement strategy for a task or service.
default String	getPlatformVersion() Specifies the platform version for the task.
default String	getPropagateTags() Specifies whether to propagate the tags from the task definition to the task.
default String	getReferenceId() The reference ID to use for the task.
default List<Object>	getTags() The metadata that you apply to the task to help you categorize and organize them.
default Number	getTaskCount() The number of tasks to create based on `TaskDefinition` .
String	getTaskDefinitionArn() The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTaskDefinitionArn

@Stability(value=Stable)
 @NotNull
String getTaskDefinitionArn()

The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.

getCapacityProviderStrategy

@Stability(value=Stable)
 @Nullable
default Object getCapacityProviderStrategy()

The capacity provider strategy to use for the task.

getEnableEcsManagedTags

@Stability(value=Stable)
 @Nullable
default Object getEnableEcsManagedTags()

Specifies whether to enable Amazon ECS managed tags for the task.

For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide .

getEnableExecuteCommand

@Stability(value=Stable)
 @Nullable
default Object getEnableExecuteCommand()

Whether or not to enable the execute command functionality for the containers in this task.

If true, this enables execute command functionality on all containers in the task.

getGroup

@Stability(value=Stable)
 @Nullable
default String getGroup()

Specifies an ECS task group for the task.

The maximum length is 255 characters.

getLaunchType

@Stability(value=Stable)
 @Nullable
default String getLaunchType()

Specifies the launch type on which your task is running.

The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .

getNetworkConfiguration

@Stability(value=Stable)
 @Nullable
default Object getNetworkConfiguration()

This structure specifies the network configuration for an ECS task.

getPlacementConstraints

@Stability(value=Stable)
 @Nullable
default Object getPlacementConstraints()

An array of placement constraint objects to use for the task.

You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

getPlacementStrategy

@Stability(value=Stable)
 @Nullable
default Object getPlacementStrategy()

The task placement strategy for a task or service.

getPlatformVersion

@Stability(value=Stable)
 @Nullable
default String getPlatformVersion()

Specifies the platform version for the task.

Specify only the numeric portion of the platform version, such as 1.1.0 .

getPropagateTags

@Stability(value=Stable)
 @Nullable
default String getPropagateTags()

Specifies whether to propagate the tags from the task definition to the task.

If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use Amazon ECS's TagResource API action.

getReferenceId

@Stability(value=Stable)
 @Nullable
default String getReferenceId()

The reference ID to use for the task.

getTags

@Stability(value=Stable)
 @Nullable
default List<Object> getTags()

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. For more information, see RunTask in the Amazon ECS API Reference .

getTaskCount

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

The number of tasks to create based on `TaskDefinition` .

The default is 1 .

builder

@Stability(value=Stable)
static CfnSchedule.EcsParametersProperty.Builder builder()

Returns:

a CfnSchedule.EcsParametersProperty.Builder of CfnSchedule.EcsParametersProperty