Table of Contents

Class EcsParameters

Namespace
Amazon.EventBridge.Model
Assembly
AWSSDK.EventBridge.dll

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

public class EcsParameters
Inheritance
EcsParameters
Inherited Members

Constructors

EcsParameters() 

public EcsParameters()

Properties

CapacityProviderStrategy

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 List<CapacityProviderStrategyItem> CapacityProviderStrategy { get; set; }

Property Value

List<CapacityProviderStrategyItem>

EnableECSManagedTags

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 bool EnableECSManagedTags { get; set; }

Property Value

bool

EnableExecuteCommand

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 bool EnableExecuteCommand { get; set; }

Property Value

bool

Group

Gets and sets the property Group.

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

public string Group { get; set; }

Property Value

string

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 with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide. 

public LaunchType LaunchType { get; set; }

Property Value

LaunchType

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 NetworkConfiguration NetworkConfiguration { get; set; }

Property Value

NetworkConfiguration

PlacementConstraints

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 List<PlacementConstraint> PlacementConstraints { get; set; }

Property Value

List<PlacementConstraint>

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 List<PlacementStrategy> PlacementStrategy { get; set; }

Property Value

List<PlacementStrategy>

PlatformVersion

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

Property Value

string

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 PropagateTags PropagateTags { get; set; }

Property Value

PropagateTags

ReferenceId

Gets and sets the property ReferenceId.

The reference ID to use for the task. 

public string ReferenceId { get; set; }

Property Value

string

Tags

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 List<Tag> Tags { get; set; }

Property Value

List<Tag>

TaskCount

Gets and sets the property TaskCount.

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

public int TaskCount { get; set; }

Property Value

int

TaskDefinitionArn

Gets and sets the property TaskDefinitionArn.

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

public string TaskDefinitionArn { get; set; }

Property Value

string