class CfnTaskSet (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.CfnTaskSet`
Java	`software.amazon.awscdk.services.ecs.CfnTaskSet`
Python	`aws_cdk.aws_ecs.CfnTaskSet`
TypeScript	`@aws-cdk/aws-ecs` » `CfnTaskSet`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::ECS::TaskSet.

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const cfnTaskSet = new ecs.CfnTaskSet(this, 'MyCfnTaskSet', {
  cluster: 'cluster',
  service: 'service',
  taskDefinition: 'taskDefinition',

  // the properties below are optional
  externalId: 'externalId',
  launchType: 'launchType',
  loadBalancers: [{
    containerName: 'containerName',
    containerPort: 123,
    loadBalancerName: 'loadBalancerName',
    targetGroupArn: 'targetGroupArn',
  }],
  networkConfiguration: {
    awsVpcConfiguration: {
      subnets: ['subnets'],

      // the properties below are optional
      assignPublicIp: 'assignPublicIp',
      securityGroups: ['securityGroups'],
    },
  },
  platformVersion: 'platformVersion',
  scale: {
    unit: 'unit',
    value: 123,
  },
  serviceRegistries: [{
    containerName: 'containerName',
    containerPort: 123,
    port: 123,
    registryArn: 'registryArn',
  }],
});

Initializer

new CfnTaskSet(scope: Construct, id: string, props: CfnTaskSetProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnTaskSetProps — - resource properties.

Create a new AWS::ECS::TaskSet.

Construct Props

Name	Type	Description
cluster	`string`	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
service	`string`	The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
taskDefinition	`string`	The task definition for the tasks in the task set to use.
externalId?	`string`	An optional non-unique tag that identifies this task set in external systems.
launchType?	`string`	The launch type that new tasks in the task set uses.
loadBalancers?	`IResolvable` `\|` `IResolvable` `\|` `LoadBalancerProperty[]`	A load balancer object representing the load balancer to use with the task set.
networkConfiguration?	`IResolvable` `\|` `NetworkConfigurationProperty`	The network configuration for the task set.
platformVersion?	`string`	The platform version that the tasks in the task set uses.
scale?	`IResolvable` `\|` `ScaleProperty`	A floating-point percentage of your desired number of tasks to place and keep running in the task set.
serviceRegistries?	`IResolvable` `\|` `IResolvable` `\|` `ServiceRegistryProperty[]`	The details of the service discovery registries to assign to this task set.

cluster

Type: string

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

service

Type: string

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

taskDefinition

Type: string

The task definition for the tasks in the task set to use.

externalId?

Type: string (optional)

An optional non-unique tag that identifies this task set in external systems.

If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

launchType?

Type: string (optional)

The launch type that new tasks in the task set uses.

For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

loadBalancers?

Type: IResolvable | IResolvable | LoadBalancerProperty[] (optional)

A load balancer object representing the load balancer to use with the task set.

The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

networkConfiguration?

Type: IResolvable | NetworkConfigurationProperty (optional)

The network configuration for the task set.

platformVersion?

Type: string (optional)

The platform version that the tasks in the task set uses.

A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

scale?

Type: IResolvable | ScaleProperty (optional)

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

serviceRegistries?

Type: IResolvable | IResolvable | ServiceRegistryProperty[] (optional)

The details of the service discovery registries to assign to this task set.

For more information, see Service discovery .

Properties

Name	Type	Description
attrId	`string`	The ID of the task set.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
cluster	`string`	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
service	`string`	The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
stack	`Stack`	The stack in which this element is defined.
taskDefinition	`string`	The task definition for the tasks in the task set to use.
externalId?	`string`	An optional non-unique tag that identifies this task set in external systems.
launchType?	`string`	The launch type that new tasks in the task set uses.
loadBalancers?	`IResolvable` `\|` `IResolvable` `\|` `LoadBalancerProperty[]`	A load balancer object representing the load balancer to use with the task set.
networkConfiguration?	`IResolvable` `\|` `NetworkConfigurationProperty`	The network configuration for the task set.
platformVersion?	`string`	The platform version that the tasks in the task set uses.
scale?	`IResolvable` `\|` `ScaleProperty`	A floating-point percentage of your desired number of tasks to place and keep running in the task set.
serviceRegistries?	`IResolvable` `\|` `IResolvable` `\|` `ServiceRegistryProperty[]`	The details of the service discovery registries to assign to this task set.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrId

Type: string

The ID of the task set.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

cluster

Type: string

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

service

Type: string

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

taskDefinition

Type: string

The task definition for the tasks in the task set to use.

externalId?

Type: string (optional)

An optional non-unique tag that identifies this task set in external systems.

If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

launchType?

Type: string (optional)

The launch type that new tasks in the task set uses.

For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

loadBalancers?

Type: IResolvable | IResolvable | LoadBalancerProperty[] (optional)

A load balancer object representing the load balancer to use with the task set.

The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

networkConfiguration?

Type: IResolvable | NetworkConfigurationProperty (optional)

The network configuration for the task set.

platformVersion?

Type: string (optional)

The platform version that the tasks in the task set uses.

A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

scale?

Type: IResolvable | ScaleProperty (optional)

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

serviceRegistries?

Type: IResolvable | IResolvable | ServiceRegistryProperty[] (optional)

The details of the service discovery registries to assign to this task set.

For more information, see Service discovery .

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }