software.amazon.awscdk.services.events

Interface CfnRule.EcsParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRule.EcsParametersProperty.Jsii$Proxy

Enclosing class:

CfnRule

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

The custom parameters to be used when the target is an Amazon ECS task.

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.events.*;
 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()))
         .placementStrategies(List.of(PlacementStrategyProperty.builder()
                 .field("field")
                 .type("type")
                 .build()))
         .platformVersion("platformVersion")
         .propagateTags("propagateTags")
         .referenceId("referenceId")
         .tagList(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .taskCount(123)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnRule.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() Use this structure if the Amazon ECS task uses the `awsvpc` network mode.
default Object	getPlacementConstraints() An array of placement constraint objects to use for the task.
default Object	getPlacementStrategies() The placement strategy objects to use for the task.
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 Object	getTagList() 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 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 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.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

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 Elastic Container Service 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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide .

getNetworkConfiguration

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

Use this structure if the Amazon ECS task uses the `awsvpc` network mode.

This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

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).

getPlacementStrategies

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

The placement strategy objects to use for the task.

You can specify a maximum of five strategy rules per task.

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 .

This structure is used only if LaunchType is FARGATE . For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .

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 the TagResource API action.

getReferenceId

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

The reference ID to use for the task.

getTagList

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

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. To learn more, 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 CfnRule.EcsParametersProperty.Builder builder()

Returns:

a CfnRule.EcsParametersProperty.Builder of CfnRule.EcsParametersProperty