software.amazon.awscdk.services.ecs

Interface ExternalTaskDefinitionProps

All Superinterfaces:

CommonTaskDefinitionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ExternalTaskDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.702Z")
 @Stability(value=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()
         .executionRole(role)
         .family("family")
         .networkMode(NetworkMode.NONE)
         .proxyConfiguration(proxyConfiguration)
         .taskRole(role)
         .volumes(List.of(Volume.builder()
                 .name("name")
                 // the properties below are optional
                 .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 Classes

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

Method Summary

Modifier and Type	Method and Description
static ExternalTaskDefinitionProps.Builder	builder()
default NetworkMode	getNetworkMode() The networking mode to use for the containers in the task.

Methods inherited from interface software.amazon.awscdk.services.ecs.CommonTaskDefinitionProps

getExecutionRole, getFamily, getProxyConfiguration, getTaskRole, getVolumes

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNetworkMode

@Stability(value=Stable)
 @Nullable
default NetworkMode 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

@Stability(value=Stable)
static ExternalTaskDefinitionProps.Builder builder()

Specified by:

builder in interface CommonTaskDefinitionProps

Returns:

a ExternalTaskDefinitionProps.Builder of ExternalTaskDefinitionProps