software.amazon.awscdk.services.ecs

Interface ITaskDefinition.Jsii$Default

All Superinterfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, ITaskDefinition

All Known Subinterfaces:

IEc2TaskDefinition.Jsii$Default, IExternalTaskDefinition.Jsii$Default, IFargateTaskDefinition.Jsii$Default

All Known Implementing Classes:

IEc2TaskDefinition.Jsii$Proxy, IExternalTaskDefinition.Jsii$Proxy, IFargateTaskDefinition.Jsii$Proxy, ITaskDefinition.Jsii$Proxy

Enclosing interface:

ITaskDefinition

public static interface ITaskDefinition.Jsii$Default
extends ITaskDefinition, IResource.Jsii$Default

Internal default implementation for ITaskDefinition.

Nested Class Summary

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

ITaskDefinition.Jsii$Default, ITaskDefinition.Jsii$Proxy

Method Summary

Modifier and Type	Method and 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 java.lang.Boolean	getIsEc2Compatible() Return true if the task definition can be run on an EC2 cluster.
default java.lang.Boolean	getIsExternalCompatible() Return true if the task definition can be run on a ECS Anywhere cluster.
default java.lang.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 ConstructNode	getNode() The construct tree node for this construct.
default Stack	getStack() The stack in which this resource is defined.
default java.lang.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.

Method Detail

getNode

default ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

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

getStack

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

getCompatibility

default Compatibility getCompatibility()

What launch types this task definition should be compatible with.

Specified by:

getCompatibility in interface ITaskDefinition

getIsEc2Compatible

default java.lang.Boolean getIsEc2Compatible()

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

Specified by:

getIsEc2Compatible in interface ITaskDefinition

getIsExternalCompatible

default java.lang.Boolean getIsExternalCompatible()

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

Specified by:

getIsExternalCompatible in interface ITaskDefinition

getIsFargateCompatible

default java.lang.Boolean getIsFargateCompatible()

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

Specified by:

getIsFargateCompatible in interface ITaskDefinition

getNetworkMode

default NetworkMode getNetworkMode()

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

Specified by:

getNetworkMode in interface ITaskDefinition

getTaskDefinitionArn

default java.lang.String getTaskDefinitionArn()

ARN of this task definition.

Specified by:

getTaskDefinitionArn in interface ITaskDefinition

getTaskRole

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

getExecutionRole

default IRole getExecutionRole()

Execution role for this task definition.

Specified by:

getExecutionRole in interface ITaskDefinition

applyRemovalPolicy

default void applyRemovalPolicy(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

Parameters:

policy - This parameter is required.