Interface ICfnTaskSetProps
Properties for defining a CfnTaskSet
.
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnTaskSetProps
Syntax (vb)
Public Interface ICfnTaskSetProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;
var cfnTaskSetProps = new CfnTaskSetProps {
Cluster = "cluster",
Service = "service",
TaskDefinition = "taskDefinition",
// the properties below are optional
ExternalId = "externalId",
LaunchType = "launchType",
LoadBalancers = new [] { new LoadBalancerProperty {
ContainerName = "containerName",
ContainerPort = 123,
TargetGroupArn = "targetGroupArn"
} },
NetworkConfiguration = new NetworkConfigurationProperty {
AwsVpcConfiguration = new AwsVpcConfigurationProperty {
Subnets = new [] { "subnets" },
// the properties below are optional
AssignPublicIp = "assignPublicIp",
SecurityGroups = new [] { "securityGroups" }
}
},
PlatformVersion = "platformVersion",
Scale = new ScaleProperty {
Unit = "unit",
Value = 123
},
ServiceRegistries = new [] { new ServiceRegistryProperty {
ContainerName = "containerName",
ContainerPort = 123,
Port = 123,
RegistryArn = "registryArn"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
Cluster | The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. |
ExternalId | An optional non-unique tag that identifies this task set in external systems. |
LaunchType | The launch type that new tasks in the task set uses. |
LoadBalancers | A load balancer object representing the load balancer to use with the task set. |
NetworkConfiguration | The network configuration for the task set. |
PlatformVersion | The platform version that the tasks in the task set uses. |
Scale | A floating-point percentage of your desired number of tasks to place and keep running in the task set. |
Service | The short name or full Amazon Resource Name (ARN) of the service to create the task set in. |
ServiceRegistries | The details of the service discovery registries to assign to this task set. |
Tags | The metadata that you apply to the task set to help you categorize and organize them. |
TaskDefinition | The task definition for the tasks in the task set to use. |
Properties
Cluster
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
string Cluster { get; }
Property Value
System.String
Remarks
ExternalId
An optional non-unique tag that identifies this task set in external systems.
virtual string ExternalId { get; }
Property Value
System.String
Remarks
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
The launch type that new tasks in the task set uses.
virtual string LaunchType { get; }
Property Value
System.String
Remarks
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
A load balancer object representing the load balancer to use with the task set.
virtual object LoadBalancers { get; }
Property Value
System.Object
Remarks
The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
NetworkConfiguration
The network configuration for the task set.
virtual object NetworkConfiguration { get; }
Property Value
System.Object
Remarks
PlatformVersion
The platform version that the tasks in the task set uses.
virtual string PlatformVersion { get; }
Property Value
System.String
Remarks
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
A floating-point percentage of your desired number of tasks to place and keep running in the task set.
virtual object Scale { get; }
Property Value
System.Object
Remarks
Service
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
string Service { get; }
Property Value
System.String
Remarks
ServiceRegistries
The details of the service discovery registries to assign to this task set.
virtual object ServiceRegistries { get; }
Property Value
System.Object
Remarks
Tags
The metadata that you apply to the task set to help you categorize and organize them.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
: .
- Tag keys and values are case-sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
TaskDefinition
The task definition for the tasks in the task set to use.
string TaskDefinition { get; }
Property Value
System.String
Remarks
If a revision isn't specified, the latest ACTIVE
revision is used.