Interface ExternalTaskDefinitionProps
- All Superinterfaces:
CommonTaskDefinitionProps,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
ExternalTaskDefinitionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-17T14:40:50.519Z")
@Stability(Stable)
public interface ExternalTaskDefinitionProps
extends software.amazon.jsii.JsiiSerializable, CommonTaskDefinitionProps
The properties for a task definition run on an External cluster.
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.ecs.*;
import software.amazon.awscdk.services.iam.*;
ProxyConfiguration proxyConfiguration;
Role role;
ExternalTaskDefinitionProps externalTaskDefinitionProps = ExternalTaskDefinitionProps.builder()
.enableFaultInjection(false)
.executionRole(role)
.family("family")
.networkMode(NetworkMode.NONE)
.proxyConfiguration(proxyConfiguration)
.taskRole(role)
.volumes(List.of(Volume.builder()
.name("name")
// the properties below are optional
.configuredAtLaunch(false)
.dockerVolumeConfiguration(DockerVolumeConfiguration.builder()
.driver("driver")
.scope(Scope.TASK)
// the properties below are optional
.autoprovision(false)
.driverOpts(Map.of(
"driverOptsKey", "driverOpts"))
.labels(Map.of(
"labelsKey", "labels"))
.build())
.efsVolumeConfiguration(EfsVolumeConfiguration.builder()
.fileSystemId("fileSystemId")
// the properties below are optional
.authorizationConfig(AuthorizationConfig.builder()
.accessPointId("accessPointId")
.iam("iam")
.build())
.rootDirectory("rootDirectory")
.transitEncryption("transitEncryption")
.transitEncryptionPort(123)
.build())
.host(Host.builder()
.sourcePath("sourcePath")
.build())
.build()))
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forExternalTaskDefinitionPropsstatic final classAn implementation forExternalTaskDefinitionProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default NetworkModeThe networking mode to use for the containers in the task.Methods inherited from interface software.amazon.awscdk.services.ecs.CommonTaskDefinitionProps
getEnableFaultInjection, getExecutionRole, getFamily, getProxyConfiguration, getTaskRole, getVolumesMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getNetworkMode
The networking mode to use for the containers in the task.With ECS Anywhere, supported modes are bridge, host and none.
Default: NetworkMode.BRIDGE
-
builder
-