Class CfnSchedulePropsMixin.EcsParametersProperty

The templated target type for the Amazon ECS RunTask API operation.

Inheritance

object

CfnSchedulePropsMixin.EcsParametersProperty

Implements

CfnSchedulePropsMixin.IEcsParametersProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Scheduler

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnSchedulePropsMixin.EcsParametersProperty : CfnSchedulePropsMixin.IEcsParametersProperty

Syntax (vb)

Public Class CfnSchedulePropsMixin.EcsParametersProperty Implements CfnSchedulePropsMixin.IEcsParametersProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.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.CfnPropertyMixins.AWS.Scheduler;

             var tags;

             var ecsParametersProperty = new EcsParametersProperty {
                 CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                     Base = 123,
                     CapacityProvider = "capacityProvider",
                     Weight = 123
                 } },
                 EnableEcsManagedTags = false,
                 EnableExecuteCommand = false,
                 Group = "group",
                 LaunchType = "launchType",
                 NetworkConfiguration = new NetworkConfigurationProperty {
                     AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                         AssignPublicIp = "assignPublicIp",
                         SecurityGroups = new [] { "securityGroups" },
                         Subnets = new [] { "subnets" }
                     }
                 },
                 PlacementConstraints = new [] { new PlacementConstraintProperty {
                     Expression = "expression",
                     Type = "type"
                 } },
                 PlacementStrategy = new [] { new PlacementStrategyProperty {
                     Field = "field",
                     Type = "type"
                 } },
                 PlatformVersion = "platformVersion",
                 PropagateTags = "propagateTags",
                 ReferenceId = "referenceId",
                 Tags = tags,
                 TaskCount = 123,
                 TaskDefinitionArn = "taskDefinitionArn"
             };

Synopsis

Constructors

EcsParametersProperty()

The templated target type for the Amazon ECS RunTask API operation.

Properties

CapacityProviderStrategy	The capacity provider strategy to use for the task.
EnableEcsManagedTags	Specifies whether to enable Amazon ECS managed tags for the task.
EnableExecuteCommand	Whether or not to enable the execute command functionality for the containers in this task.
Group	Specifies an Amazon ECS task group for the task.
LaunchType	Specifies the launch type on which your task is running.
NetworkConfiguration	This structure specifies the network configuration for an ECS task.
PlacementConstraints	An array of placement constraint objects to use for the task.
PlacementStrategy	The task placement strategy for a task or service.
PlatformVersion	Specifies the platform version for the task.
PropagateTags	Specifies whether to propagate the tags from the task definition to the task.
ReferenceId	The reference ID to use for the task.
Tags	The metadata that you apply to the task to help you categorize and organize them.
TaskCount	The number of tasks to create based on TaskDefinition .
TaskDefinitionArn	The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.

Constructors

EcsParametersProperty()

The templated target type for the Amazon ECS RunTask API operation.

public EcsParametersProperty()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.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.CfnPropertyMixins.AWS.Scheduler;

             var tags;

             var ecsParametersProperty = new EcsParametersProperty {
                 CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                     Base = 123,
                     CapacityProvider = "capacityProvider",
                     Weight = 123
                 } },
                 EnableEcsManagedTags = false,
                 EnableExecuteCommand = false,
                 Group = "group",
                 LaunchType = "launchType",
                 NetworkConfiguration = new NetworkConfigurationProperty {
                     AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                         AssignPublicIp = "assignPublicIp",
                         SecurityGroups = new [] { "securityGroups" },
                         Subnets = new [] { "subnets" }
                     }
                 },
                 PlacementConstraints = new [] { new PlacementConstraintProperty {
                     Expression = "expression",
                     Type = "type"
                 } },
                 PlacementStrategy = new [] { new PlacementStrategyProperty {
                     Field = "field",
                     Type = "type"
                 } },
                 PlatformVersion = "platformVersion",
                 PropagateTags = "propagateTags",
                 ReferenceId = "referenceId",
                 Tags = tags,
                 TaskCount = 123,
                 TaskDefinitionArn = "taskDefinitionArn"
             };

Properties

CapacityProviderStrategy

The capacity provider strategy to use for the task.

public object? CapacityProviderStrategy { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-capacityproviderstrategy

Type union: either IResolvable or (either IResolvable or CfnSchedulePropsMixin.ICapacityProviderStrategyItemProperty)[]

EnableEcsManagedTags

Specifies whether to enable Amazon ECS managed tags for the task.

public object? EnableEcsManagedTags { get; set; }

Property Value

object

Remarks

For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-enableecsmanagedtags

Type union: either bool or IResolvable

EnableExecuteCommand

Whether or not to enable the execute command functionality for the containers in this task.

public object? EnableExecuteCommand { get; set; }

Property Value

object

Remarks

If true, this enables execute command functionality on all containers in the task.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-enableexecutecommand

Type union: either bool or IResolvable

Group

Specifies an Amazon ECS task group for the task.

public string? Group { get; set; }

Property Value

string

Remarks

The maximum length is 255 characters.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-group

LaunchType

Specifies the launch type on which your task is running.

public string? LaunchType { get; set; }

Property Value

string

Remarks

The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-launchtype

NetworkConfiguration

This structure specifies the network configuration for an ECS task.

public object? NetworkConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-networkconfiguration

Type union: either IResolvable or CfnSchedulePropsMixin.INetworkConfigurationProperty

PlacementConstraints

An array of placement constraint objects to use for the task.

public object? PlacementConstraints { get; set; }

Property Value

object

Remarks

You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-placementconstraints

Type union: either IResolvable or (either IResolvable or CfnSchedulePropsMixin.IPlacementConstraintProperty)[]

PlacementStrategy

The task placement strategy for a task or service.

public object? PlacementStrategy { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-placementstrategy

Type union: either IResolvable or (either IResolvable or CfnSchedulePropsMixin.IPlacementStrategyProperty)[]

PlatformVersion

Specifies the platform version for the task.

public string? PlatformVersion { get; set; }

Property Value

string

Remarks

Specify only the numeric portion of the platform version, such as 1.1.0 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-platformversion

PropagateTags

Specifies whether to propagate the tags from the task definition to the task.

public string? PropagateTags { get; set; }

Property Value

string

Remarks

If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS TagResource API action.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-propagatetags

ReferenceId

The reference ID to use for the task.

public string? ReferenceId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-referenceid

Tags

The metadata that you apply to the task to help you categorize and organize them.

public object? Tags { get; set; }

Property Value

object

Remarks

Each tag consists of a key and an optional value, both of which you define. For more information, see RunTask in the Amazon ECS API Reference .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-tags

TaskCount

The number of tasks to create based on TaskDefinition .

public double? TaskCount { get; set; }

Property Value

double?

Remarks

The default is 1 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-taskcount

TaskDefinitionArn

The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.

public string? TaskDefinitionArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-taskdefinitionarn

Implements

CfnSchedulePropsMixin.IEcsParametersProperty