aws-cdk-lib.aws_ecs.ExternalTaskDefinitionAttributes

interface ExternalTaskDefinitionAttributes

LanguageType name
.NETAmazon.CDK.AWS.ECS.ExternalTaskDefinitionAttributes
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecs#ExternalTaskDefinitionAttributes
Javasoftware.amazon.awscdk.services.ecs.ExternalTaskDefinitionAttributes
Pythonaws_cdk.aws_ecs.ExternalTaskDefinitionAttributes
TypeScript (source)aws-cdk-lib » aws_ecs » ExternalTaskDefinitionAttributes

Attributes used to import an existing External task definition.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';

declare const role: iam.Role;
const externalTaskDefinitionAttributes: ecs.ExternalTaskDefinitionAttributes = {
  taskDefinitionArn: 'taskDefinitionArn',

  // the properties below are optional
  executionRole: role,
  networkMode: ecs.NetworkMode.NONE,
  taskRole: role,
};

Properties

NameTypeDescription
taskDefinitionArnstringThe arn of the task definition.
executionRole?IRoleThe IAM role that grants containers and Fargate agents permission to make AWS API calls on your behalf.
networkMode?NetworkModeThe networking mode to use for the containers in the task.
taskRole?IRoleThe name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

taskDefinitionArn

Type: string

The arn of the task definition.


executionRole?

Type: IRole (optional, default: undefined)

The IAM role that grants containers and Fargate agents permission to make AWS API calls on your behalf.

Some tasks do not have an execution role.


networkMode?

Type: NetworkMode (optional, default: Network mode cannot be provided to the imported task.)

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


taskRole?

Type: IRole (optional, default: Permissions cannot be granted to the imported task.)

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