Class CfnTaskSet

A CloudFormation AWS::ECS::TaskSet.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnTaskSet
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public class CfnTaskSet : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnTaskSet
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

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 .

CloudformationResource: AWS::ECS::TaskSet

Link: 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 cfnTaskSet = new CfnTaskSet(this, "MyCfnTaskSet", 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,
        LoadBalancerName = "loadBalancerName",
        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"
    } }
});

Synopsis

Constructors

CfnTaskSet(Construct, String, ICfnTaskSetProps)

Create a new AWS::ECS::TaskSet.
CfnTaskSet(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnTaskSet(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrId

The ID of the task set.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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.
TaskDefinition

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnTaskSet(Construct, String, ICfnTaskSetProps)

Create a new AWS::ECS::TaskSet.

public CfnTaskSet(Construct scope, string id, ICfnTaskSetProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnTaskSetProps
  • resource properties.

CfnTaskSet(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnTaskSet(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnTaskSet(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnTaskSet(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrId

The ID of the task set.

public virtual string AttrId { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Cluster

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

public virtual string Cluster { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-cluster

ExternalId

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

public virtual string ExternalId { get; set; }
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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-externalid

LaunchType

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

public virtual string LaunchType { get; set; }
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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-launchtype

LoadBalancers

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

public virtual object LoadBalancers { get; set; }
Property Value

System.Object

Remarks

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

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-loadbalancers

NetworkConfiguration

The network configuration for the task set.

public virtual object NetworkConfiguration { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-networkconfiguration

PlatformVersion

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

public virtual string PlatformVersion { get; set; }
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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-platformversion

Scale

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

public virtual object Scale { get; set; }
Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-scale

Service

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

public virtual string Service { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-service

ServiceRegistries

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

public virtual object ServiceRegistries { get; set; }
Property Value

System.Object

Remarks

For more information, see Service discovery .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-serviceregistries

TaskDefinition

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

public virtual string TaskDefinition { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-taskdefinition

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector
  • tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements

Constructs.IConstruct