Interface CfnRule.EcsParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnRule.EcsParametersProperty.Jsii$Proxy
- Enclosing class:
CfnRule
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();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnRule.EcsParametersProperty
static final class
An implementation forCfnRule.EcsParametersProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The capacity provider strategy to use for the task.default Object
Specifies whether to enable Amazon ECS managed tags for the task.default Object
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
Specifies the launch type on which your task is running.default Object
Use this structure if the Amazon ECS task uses theawsvpc
network mode.default Object
An array of placement constraint objects to use for the task.default Object
The placement strategy objects to use for the task.default String
Specifies the platform version for the task.default String
Specifies whether to propagate the tags from the task definition to the task.default String
The reference ID to use for the task.default Object
The metadata that you apply to the task to help you categorize and organize them.default Number
The number of tasks to create based onTaskDefinition
.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 Details
-
getTaskDefinitionArn
The ARN of the task definition to use if the event target is an Amazon ECS task.- See Also:
-
getCapacityProviderStrategy
The capacity provider strategy to use for the task.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
getGroup
Specifies an ECS task group for the task.The maximum length is 255 characters.
- See Also:
-
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 .- See Also:
-
getNetworkConfiguration
Use this structure if the Amazon ECS task uses theawsvpc
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
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- See Also:
-
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).
- See Also:
-
getPlacementStrategies
The placement strategy objects to use for the task.You can specify a maximum of five strategy rules per task.
- See Also:
-
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
isFARGATE
. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .- See Also:
-
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.
- See Also:
-
getReferenceId
The reference ID to use for the task.- See Also:
-
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.
- See Also:
-
getTaskCount
The number of tasks to create based onTaskDefinition
.The default is 1.
- See Also:
-
builder
-