Package software.amazon.awscdk.services.ecs

Interface IExternalTaskDefinition.Jsii$Default

All Superinterfaces:

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

All Known Implementing Classes:

IExternalTaskDefinition.Jsii$Proxy

Enclosing interface:

IExternalTaskDefinition

@Internal
public static interface IExternalTaskDefinition.Jsii$Default
extends IExternalTaskDefinition, ITaskDefinition.Jsii$Default

Internal default implementation for IExternalTaskDefinition.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

IExternalTaskDefinition.Jsii$Default, IExternalTaskDefinition.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

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

ITaskDefinition.Jsii$Default, ITaskDefinition.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default Compatibility	getCompatibility()	What launch types this task definition should be compatible with.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default IRole	getExecutionRole()	Execution role for this task definition.
default Boolean	getIsEc2Compatible()	Return true if the task definition can be run on an EC2 cluster.
default Boolean	getIsExternalCompatible()	Return true if the task definition can be run on a ECS Anywhere cluster.
default Boolean	getIsFargateCompatible()	Return true if the task definition can be run on a Fargate cluster.
default NetworkMode	getNetworkMode()	The networking mode to use for the containers in the task.
default software.constructs.Node	getNode()	The tree node.
default Stack	getStack()	The stack in which this resource is defined.
default String	getTaskDefinitionArn()	ARN of this task definition.
default IRole	getTaskRole()	The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface ITaskDefinition.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface ITaskDefinition.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

Specified by:

getStack in interface ITaskDefinition.Jsii$Default

getCompatibility

@Stability(Stable)
@NotNull
default Compatibility getCompatibility()

What launch types this task definition should be compatible with.

Specified by:

getCompatibility in interface ITaskDefinition

Specified by:

getCompatibility in interface ITaskDefinition.Jsii$Default

getIsEc2Compatible

@Stability(Stable)
@NotNull
default Boolean getIsEc2Compatible()

Return true if the task definition can be run on an EC2 cluster.

Specified by:

getIsEc2Compatible in interface ITaskDefinition

Specified by:

getIsEc2Compatible in interface ITaskDefinition.Jsii$Default

getIsExternalCompatible

@Stability(Stable)
@NotNull
default Boolean getIsExternalCompatible()

Return true if the task definition can be run on a ECS Anywhere cluster.

Specified by:

getIsExternalCompatible in interface ITaskDefinition

Specified by:

getIsExternalCompatible in interface ITaskDefinition.Jsii$Default

getIsFargateCompatible

@Stability(Stable)
@NotNull
default Boolean getIsFargateCompatible()

Return true if the task definition can be run on a Fargate cluster.

Specified by:

getIsFargateCompatible in interface ITaskDefinition

Specified by:

getIsFargateCompatible in interface ITaskDefinition.Jsii$Default

getNetworkMode

@Stability(Stable)
@NotNull
default NetworkMode getNetworkMode()

The networking mode to use for the containers in the task.

Specified by:

getNetworkMode in interface ITaskDefinition

Specified by:

getNetworkMode in interface ITaskDefinition.Jsii$Default

getTaskDefinitionArn

@Stability(Stable)
@NotNull
default String getTaskDefinitionArn()

ARN of this task definition.

Specified by:

getTaskDefinitionArn in interface ITaskDefinition

Specified by:

getTaskDefinitionArn in interface ITaskDefinition.Jsii$Default

getTaskRole

@Stability(Stable)
@NotNull
default IRole getTaskRole()

The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

Specified by:

getTaskRole in interface ITaskDefinition

Specified by:

getTaskRole in interface ITaskDefinition.Jsii$Default

getExecutionRole

@Stability(Stable)
@Nullable
default IRole getExecutionRole()

Execution role for this task definition.

Specified by:

getExecutionRole in interface ITaskDefinition

Specified by:

getExecutionRole in interface ITaskDefinition.Jsii$Default

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Specified by:

applyRemovalPolicy in interface ITaskDefinition.Jsii$Default

Parameters:

policy - This parameter is required.