interface CfnTaskSetMixinProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.ECS.Mixins.CfnTaskSetMixinProps |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsecs/mixins#CfnTaskSetMixinProps |
 Java | software.amazon.awscdk.mixins.preview.services.ecs.mixins.CfnTaskSetMixinProps |
 Python | aws_cdk.mixins_preview.aws_ecs.mixins.CfnTaskSetMixinProps |
 TypeScript | @aws-cdk/mixins-preview » aws_ecs » mixins » CfnTaskSetMixinProps |
Properties for CfnTaskSetPropsMixin.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as ecs_mixins } from '@aws-cdk/mixins-preview/aws-ecs';
const cfnTaskSetMixinProps: ecs_mixins.CfnTaskSetMixinProps = {
capacityProviderStrategy: [{
base: 123,
capacityProvider: 'capacityProvider',
weight: 123,
}],
cluster: 'cluster',
externalId: 'externalId',
launchType: 'launchType',
loadBalancers: [{
containerName: 'containerName',
containerPort: 123,
targetGroupArn: 'targetGroupArn',
}],
networkConfiguration: {
awsVpcConfiguration: {
assignPublicIp: 'assignPublicIp',
securityGroups: ['securityGroups'],
subnets: ['subnets'],
},
},
platformVersion: 'platformVersion',
scale: {
unit: 'unit',
value: 123,
},
service: 'service',
serviceRegistries: [{
containerName: 'containerName',
containerPort: 123,
port: 123,
registryArn: 'registryArn',
}],
tags: [{
key: 'key',
value: 'value',
}],
taskDefinition: 'taskDefinition',
};
Properties
| Name | Type | Description |
|---|---|---|
| capacity | IResolvable | (IResolvable | Capacity)[] | The capacity provider strategy that are associated with the task set. |
| cluster? | string | The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. |
| external | string | An optional non-unique tag that identifies this task set in external systems. |
| launch | string | The launch type that new tasks in the task set uses. |
| load | IResolvable | (IResolvable | Load)[] | A load balancer object representing the load balancer to use with the task set. |
| network | IResolvable | Network | The network configuration for the task set. |
| platform | string | The platform version that the tasks in the task set uses. |
| scale? | IResolvable | Scale | A floating-point percentage of your desired number of tasks to place and keep running in the task set. |
| service? | string | The short name or full Amazon Resource Name (ARN) of the service to create the task set in. |
| service | IResolvable | (IResolvable | Service)[] | The details of the service discovery registries to assign to this task set. |
| tags? | Cfn[] | The metadata that you apply to the task set to help you categorize and organize them. |
| task | string | The task definition for the tasks in the task set to use. |
capacityProviderStrategy?
Type:
IResolvable | (IResolvable | Capacity)[]
(optional)
The capacity provider strategy that are associated with the task set.
cluster?
Type:
string
(optional)
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
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 | Load)[]
(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 | Network
(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 | Scale
(optional)
A floating-point percentage of your desired number of tasks to place and keep running in the task set.
service?
Type:
string
(optional)
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
serviceRegistries?
Type:
IResolvable | (IResolvable | Service)[]
(optional)
The details of the service discovery registries to assign to this task set.
For more information, see Service discovery .
tags?
Type:
Cfn[]
(optional)
The metadata that you apply to the task set to help you categorize and organize them.
Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /
taskDefinition?
Type:
string
(optional)
The task definition for the tasks in the task set to use.
If a revision isn't specified, the latest ACTIVE revision is used.