Interface CfnPipe.PipeTargetEcsTaskParametersProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPipe.PipeTargetEcsTaskParametersProperty.Jsii$Proxy
- Enclosing class:
CfnPipe
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.pipes.*;
PipeTargetEcsTaskParametersProperty pipeTargetEcsTaskParametersProperty = PipeTargetEcsTaskParametersProperty.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())
.overrides(EcsTaskOverrideProperty.builder()
.containerOverrides(List.of(EcsContainerOverrideProperty.builder()
.command(List.of("command"))
.cpu(123)
.environment(List.of(EcsEnvironmentVariableProperty.builder()
.name("name")
.value("value")
.build()))
.environmentFiles(List.of(EcsEnvironmentFileProperty.builder()
.type("type")
.value("value")
.build()))
.memory(123)
.memoryReservation(123)
.name("name")
.resourceRequirements(List.of(EcsResourceRequirementProperty.builder()
.type("type")
.value("value")
.build()))
.build()))
.cpu("cpu")
.ephemeralStorage(EcsEphemeralStorageProperty.builder()
.sizeInGiB(123)
.build())
.executionRoleArn("executionRoleArn")
.inferenceAcceleratorOverrides(List.of(EcsInferenceAcceleratorOverrideProperty.builder()
.deviceName("deviceName")
.deviceType("deviceType")
.build()))
.memory("memory")
.taskRoleArn("taskRoleArn")
.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(CfnTag.builder()
.key("key")
.value("value")
.build()))
.taskCount(123)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnPipe.PipeTargetEcsTaskParametersPropertystatic final classAn implementation forCfnPipe.PipeTargetEcsTaskParametersProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe capacity provider strategy to use for the task.default ObjectSpecifies whether to enable Amazon ECS managed tags for the task.default ObjectWhether or not to enable the execute command functionality for the containers in this task.default StringgetGroup()Specifies an Amazon ECS task group for the task.default StringSpecifies the launch type on which your task is running.default ObjectUse this structure if the Amazon ECS task uses theawsvpcnetwork mode.default ObjectThe overrides that are associated with a task.default ObjectAn array of placement constraint objects to use for the task.default ObjectThe placement strategy objects to use for the task.default StringSpecifies the platform version for the task.default StringSpecifies whether to propagate the tags from the task definition to the task.default StringThe reference ID to use for the task.getTags()The metadata that you apply to the task to help you categorize and organize them.default NumberThe 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
capacityProviderStrategyis specified, thelaunchTypeparameter must be omitted. If nocapacityProviderStrategyor launchType is specified, thedefaultCapacityProviderStrategyfor the cluster is used.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPipe.CapacityProviderStrategyItemProperty>- 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.
Returns union: either
BooleanorIResolvableDefault: - false
- 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.
Returns union: either
BooleanorIResolvableDefault: - false
- See Also:
-
getGroup
Specifies an Amazon 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
FARGATEvalue 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 theawsvpcnetwork 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
LaunchTypeisFARGATEbecause theawsvpcmode is required for Fargate tasks.If you specify
NetworkConfigurationwhen the target ECS task does not use theawsvpcnetwork mode, the task fails.Returns union: either
IResolvableorCfnPipe.NetworkConfigurationProperty- See Also:
-
getOverrides
The overrides that are associated with a task.Returns union: either
IResolvableorCfnPipe.EcsTaskOverrideProperty- 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).
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPipe.PlacementConstraintProperty>- See Also:
-
getPlacementStrategy
The placement strategy objects to use for the task.You can specify a maximum of five strategy rules per task.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnPipe.PlacementStrategyProperty>- 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
LaunchTypeisFARGATE. 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
TagResourceAPI action.- See Also:
-
getReferenceId
The reference ID to use for the task.- See Also:
-
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. 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
-