AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The custom parameters to be used when the target is an Amazon ECS task.

Inheritance Hierarchy

System.Object
  Amazon.CloudWatchEvents.Model.EcsParameters

Namespace: Amazon.CloudWatchEvents.Model
Assembly: AWSSDK.CloudWatchEvents.dll
Version: 3.x.y.z

Syntax

C#
public class EcsParameters

The EcsParameters type exposes the following members

Constructors

NameDescription
Public Method EcsParameters()

Properties

NameTypeDescription
Public Property CapacityProviderStrategy System.Collections.Generic.List<Amazon.CloudWatchEvents.Model.CapacityProviderStrategyItem>

Gets and sets the property CapacityProviderStrategy.

The capacity provider strategy to use for the task.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

Public Property EnableECSManagedTags System.Boolean

Gets and sets the property EnableECSManagedTags.

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

Public Property EnableExecuteCommand System.Boolean

Gets and sets the property EnableExecuteCommand.

Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

Public Property Group System.String

Gets and sets the property Group.

Specifies an ECS task group for the task. The maximum length is 255 characters.

Public Property LaunchType Amazon.CloudWatchEvents.LaunchType

Gets and sets the property LaunchType.

Specifies the launch type on which your task is running. 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 witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Public Property NetworkConfiguration Amazon.CloudWatchEvents.Model.NetworkConfiguration

Gets and sets the property NetworkConfiguration.

Use this structure if the Amazon ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task does not use the awsvpc network mode, the task fails.

Public Property PlacementConstraints System.Collections.Generic.List<Amazon.CloudWatchEvents.Model.PlacementConstraint>

Gets and sets the property PlacementConstraints.

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

Public Property PlacementStrategy System.Collections.Generic.List<Amazon.CloudWatchEvents.Model.PlacementStrategy>

Gets and sets the property PlacementStrategy.

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Public Property PlatformVersion System.String

Gets and sets the property PlatformVersion.

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

This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Public Property PropagateTags Amazon.CloudWatchEvents.PropagateTags

Gets and sets the property PropagateTags.

Specifies whether to propagate the tags from the task definition to the task. 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 TagResource API action.

Public Property ReferenceId System.String

Gets and sets the property ReferenceId.

The reference ID to use for the task.

Public Property Tags System.Collections.Generic.List<Amazon.CloudWatchEvents.Model.Tag>

Gets and sets the property Tags.

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.

Public Property TaskCount System.Int32

Gets and sets the property TaskCount.

The number of tasks to create based on TaskDefinition. The default is 1.

Public Property TaskDefinitionArn System.String

Gets and sets the property TaskDefinitionArn.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5