Class CfnRule.EcsParametersProperty
The custom parameters to be used when the target is an Amazon ECS task.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class EcsParametersProperty : Object, CfnRule.IEcsParametersProperty
Syntax (vb)
Public Class EcsParametersProperty
Inherits Object
Implements CfnRule.IEcsParametersProperty
Remarks
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
Constructors
EcsParametersProperty() |
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 |
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 |
TaskDefinitionArn | The ARN of the task definition to use if the event target is an Amazon ECS task. |
Constructors
EcsParametersProperty()
public EcsParametersProperty()
Properties
CapacityProviderStrategy
The capacity provider strategy to use for the task.
public object CapacityProviderStrategy { get; set; }
Property Value
System.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.
EnableEcsManagedTags
Specifies whether to enable Amazon ECS managed tags for the task.
public object EnableEcsManagedTags { get; set; }
Property Value
System.Object
Remarks
For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
EnableExecuteCommand
Whether or not to enable the execute command functionality for the containers in this task.
public object EnableExecuteCommand { get; set; }
Property Value
System.Object
Remarks
If true, this enables execute command functionality on all containers in the task.
Group
Specifies an ECS task group for the task.
public string Group { get; set; }
Property Value
System.String
Remarks
The maximum length is 255 characters.
LaunchType
Specifies the launch type on which your task is running.
public string LaunchType { get; set; }
Property Value
System.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 .
NetworkConfiguration
Use this structure if the Amazon ECS task uses the awsvpc
network mode.
public object NetworkConfiguration { get; set; }
Property Value
System.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.
PlacementConstraints
An array of placement constraint objects to use for the task.
public object PlacementConstraints { get; set; }
Property Value
System.Object
Remarks
You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
PlacementStrategies
The placement strategy objects to use for the task.
public object PlacementStrategies { get; set; }
Property Value
System.Object
Remarks
You can specify a maximum of five strategy rules per task.
PlatformVersion
Specifies the platform version for the task.
public string PlatformVersion { get; set; }
Property Value
System.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 .
PropagateTags
Specifies whether to propagate the tags from the task definition to the task.
public string PropagateTags { get; set; }
Property Value
System.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.
ReferenceId
The reference ID to use for the task.
public string ReferenceId { get; set; }
Property Value
System.String
Remarks
TagList
The metadata that you apply to the task to help you categorize and organize them.
public object TagList { get; set; }
Property Value
System.Object
Remarks
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.
TaskCount
The number of tasks to create based on TaskDefinition
.
public Nullable<double> TaskCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
System.String