software.amazon.awscdk.services.ecs

Class ExternalTaskDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ecs.TaskDefinition

software.amazon.awscdk.services.ecs.ExternalTaskDefinition

All Implemented Interfaces:

IResource, IExternalTaskDefinition, ITaskDefinition, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.701Z")
 @Stability(value=Stable)
public class ExternalTaskDefinition
extends TaskDefinition
implements IExternalTaskDefinition

The details of a task definition run on an External cluster.

Example:

 ExternalTaskDefinition externalTaskDefinition = new ExternalTaskDefinition(this, "TaskDef");
 ContainerDefinition container = externalTaskDefinition.addContainer("WebContainer", ContainerDefinitionOptions.builder()
         // Use an image from DockerHub
         .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
         .memoryLimitMiB(1024)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalTaskDefinition.Builder A fluent builder for ExternalTaskDefinition.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.IExternalTaskDefinition

IExternalTaskDefinition.Jsii$Default, IExternalTaskDefinition.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExternalTaskDefinition(software.constructs.Construct scope, String id) Constructs a new instance of the ExternalTaskDefinition class.
	ExternalTaskDefinition(software.constructs.Construct scope, String id, ExternalTaskDefinitionProps props) Constructs a new instance of the ExternalTaskDefinition class.
protected	ExternalTaskDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ExternalTaskDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addInferenceAccelerator(InferenceAccelerator _inferenceAccelerator) Overriden method to throw error as interface accelerators are not supported for external tasks.
static IExternalTaskDefinition	fromEc2TaskDefinitionArn(software.constructs.Construct scope, String id, String externalTaskDefinitionArn) Imports a task definition from the specified task definition ARN.
static IExternalTaskDefinition	fromExternalTaskDefinitionAttributes(software.constructs.Construct scope, String id, ExternalTaskDefinitionAttributes attrs) Imports an existing External task definition from its attributes.

Methods inherited from class software.amazon.awscdk.services.ecs.TaskDefinition

addContainer, addExtension, addFirelensLogRouter, addPlacementConstraint, addToExecutionRolePolicy, addToTaskRolePolicy, addVolume, findContainer, fromTaskDefinitionArn, fromTaskDefinitionAttributes, getCompatibility, getContainers, getDefaultContainer, getEphemeralStorageGiB, getExecutionRole, getFamily, getInferenceAccelerators, getIsEc2Compatible, getIsExternalCompatible, getIsFargateCompatible, getNetworkMode, getReferencesSecretJsonField, getTaskDefinitionArn, getTaskRole, grantRun, obtainExecutionRole, setDefaultContainer

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getCompatibility, getExecutionRole, getIsEc2Compatible, getIsExternalCompatible, getIsFargateCompatible, getNetworkMode, getTaskDefinitionArn, getTaskRole

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

ExternalTaskDefinition

protected ExternalTaskDefinition(software.amazon.jsii.JsiiObjectRef objRef)

ExternalTaskDefinition

protected ExternalTaskDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ExternalTaskDefinition

@Stability(value=Stable)
public ExternalTaskDefinition(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id,
                                                       @Nullable
                                                       ExternalTaskDefinitionProps props)

Constructs a new instance of the ExternalTaskDefinition class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

ExternalTaskDefinition

@Stability(value=Stable)
public ExternalTaskDefinition(@NotNull
                                                       software.constructs.Construct scope,
                                                       @NotNull
                                                       String id)

Constructs a new instance of the ExternalTaskDefinition class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

fromEc2TaskDefinitionArn

@Stability(value=Stable)
 @NotNull
public static IExternalTaskDefinition fromEc2TaskDefinitionArn(@NotNull
                                                                                                  software.constructs.Construct scope,
                                                                                                  @NotNull
                                                                                                  String id,
                                                                                                  @NotNull
                                                                                                  String externalTaskDefinitionArn)

Imports a task definition from the specified task definition ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

externalTaskDefinitionArn - This parameter is required.

fromExternalTaskDefinitionAttributes

@Stability(value=Stable)
 @NotNull
public static IExternalTaskDefinition fromExternalTaskDefinitionAttributes(@NotNull
                                                                                                              software.constructs.Construct scope,
                                                                                                              @NotNull
                                                                                                              String id,
                                                                                                              @NotNull
                                                                                                              ExternalTaskDefinitionAttributes attrs)

Imports an existing External task definition from its attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addInferenceAccelerator

@Stability(value=Stable)
public void addInferenceAccelerator(@NotNull
                                                             InferenceAccelerator _inferenceAccelerator)

Overriden method to throw error as interface accelerators are not supported for external tasks.

Overrides:

addInferenceAccelerator in class TaskDefinition

Parameters:

_inferenceAccelerator - This parameter is required.