Interface CfnRule.IEcsParametersProperty

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

Namespace: Amazon.CDK.AWS.Events

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnRule.IEcsParametersProperty

Syntax (vb)

Public Interface CfnRule.IEcsParametersProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-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.AWS.Events;

             var ecsParametersProperty = new EcsParametersProperty {
                 TaskDefinitionArn = "taskDefinitionArn",

                 // the properties below are optional
                 CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                     CapacityProvider = "capacityProvider",

                     // the properties below are optional
                     Base = 123,
                     Weight = 123
                 } },
                 EnableEcsManagedTags = false,
                 EnableExecuteCommand = false,
                 Group = "group",
                 LaunchType = "launchType",
                 NetworkConfiguration = new NetworkConfigurationProperty {
                     AwsVpcConfiguration = new AwsVpcConfigurationProperty {
                         Subnets = new [] { "subnets" },

                         // the properties below are optional
                         AssignPublicIp = "assignPublicIp",
                         SecurityGroups = new [] { "securityGroups" }
                     }
                 },
                 PlacementConstraints = new [] { new PlacementConstraintProperty {
                     Expression = "expression",
                     Type = "type"
                 } },
                 PlacementStrategies = new [] { new PlacementStrategyProperty {
                     Field = "field",
                     Type = "type"
                 } },
                 PlatformVersion = "platformVersion",
                 PropagateTags = "propagateTags",
                 ReferenceId = "referenceId",
                 TagList = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TaskCount = 123
             };

Synopsis

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 ECS task group for the task.
LaunchType	Specifies the launch type on which your task is running.
NetworkConfiguration	Use this structure if the Amazon ECS task uses the `awsvpc` network mode.
PlacementConstraints	An array of placement constraint objects to use for the task.
PlacementStrategies	The placement strategy objects to use for the task.
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.
TagList	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 ARN of the task definition to use if the event target is an Amazon ECS task.

Properties

CapacityProviderStrategy

The capacity provider strategy to use for the task.

object? CapacityProviderStrategy { get; }

Property Value

object

Remarks

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.

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

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

EnableEcsManagedTags

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

object? EnableEcsManagedTags { get; }

Property Value

object

Remarks

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

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

Type union: either bool or IResolvable

EnableExecuteCommand

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

object? EnableExecuteCommand { get; }

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-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-enableexecutecommand

Type union: either bool or IResolvable

Group

Specifies an ECS task group for the task.

string? Group { get; }

Property Value

string

Remarks

The maximum length is 255 characters.

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

LaunchType

Specifies the launch type on which your task is running.

string? LaunchType { get; }

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

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

NetworkConfiguration

Use this structure if the Amazon ECS task uses the awsvpc network mode.

object? NetworkConfiguration { get; }

Property Value

object

Remarks

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.

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

Type union: either IResolvable or CfnRule.INetworkConfigurationProperty

PlacementConstraints

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

object? PlacementConstraints { get; }

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-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementconstraints

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

PlacementStrategies

The placement strategy objects to use for the task.

object? PlacementStrategies { get; }

Property Value

object

Remarks

You can specify a maximum of five strategy rules per task.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-ecsparameters.html#cfn-events-rule-ecsparameters-placementstrategies

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

PlatformVersion

Specifies the platform version for the task.

string? PlatformVersion { get; }

Property Value

string

Remarks

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 AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .

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

PropagateTags

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

string? PropagateTags { get; }

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 TagResource API action.

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