class
Amazonite::EventBridge::EcsParameters
- Amazonite::EventBridge::EcsParameters
- Reference
- Object
Overview
The custom parameters to be used when the target is an Amazon ECS task.
Included Modules
- JSON::Serializable
Defined in:
eventbridge/ecs_parameters.crConstructors
- .new(pull : JSON::PullParser)
- .new(task_definition_arn : String, task_count : Int32 | Nil = nil, launch_type : LaunchType | Nil = nil, network_configuration : NetworkConfiguration | Nil = nil, platform_version : String | Nil = nil, group : String | Nil = nil, capacity_provider_strategy : Array(CapacityProviderStrategyItem) | Nil = nil, enable_ecs_managed_tags : Bool | Nil = nil, enable_execute_command : Bool | Nil = nil, placement_constraints : Array(PlacementConstraint) | Nil = nil, placement_strategy : Array(PlacementStrategy) | Nil = nil, propagate_tags : PropagateTags | Nil = nil, reference_id : String | Nil = nil, tags : Array(Tag) | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#capacity_provider_strategy : Array(CapacityProviderStrategyItem) | Nil
The capacity provider strategy to use for the task.
-
#capacity_provider_strategy=(capacity_provider_strategy : Array(CapacityProviderStrategyItem) | Nil)
The capacity provider strategy to use for the task.
-
#enable_ecs_managed_tags : Bool | Nil
Specifies whether to enable Amazon ECS managed tags for the task.
-
#enable_ecs_managed_tags=(enable_ecs_managed_tags : Bool | Nil)
Specifies whether to enable Amazon ECS managed tags for the task.
-
#enable_execute_command : Bool | Nil
Whether or not to enable the execute command functionality for the containers in this task.
-
#enable_execute_command=(enable_execute_command : Bool | Nil)
Whether or not to enable the execute command functionality for the containers in this task.
-
#group : String | Nil
Specifies an ECS task group for the task.
-
#group=(group : String | Nil)
Specifies an ECS task group for the task.
-
#hash(hasher)
See
Object#hash(hasher) -
#launch_type : LaunchType | Nil
Specifies the launch type on which your task is running.
-
#launch_type=(launch_type : LaunchType | Nil)
Specifies the launch type on which your task is running.
-
#network_configuration : NetworkConfiguration | Nil
Use this structure if the Amazon ECS task uses the
awsvpcnetwork mode. -
#network_configuration=(network_configuration : NetworkConfiguration | Nil)
Use this structure if the Amazon ECS task uses the
awsvpcnetwork mode. -
#placement_constraints : Array(PlacementConstraint) | Nil
An array of placement constraint objects to use for the task.
-
#placement_constraints=(placement_constraints : Array(PlacementConstraint) | Nil)
An array of placement constraint objects to use for the task.
-
#placement_strategy : Array(PlacementStrategy) | Nil
The placement strategy objects to use for the task.
-
#placement_strategy=(placement_strategy : Array(PlacementStrategy) | Nil)
The placement strategy objects to use for the task.
-
#platform_version : String | Nil
Specifies the platform version for the task.
-
#platform_version=(platform_version : String | Nil)
Specifies the platform version for the task.
-
#propagate_tags : PropagateTags | Nil
Specifies whether to propagate the tags from the task definition to the task.
-
#propagate_tags=(propagate_tags : PropagateTags | Nil)
Specifies whether to propagate the tags from the task definition to the task.
-
#reference_id : String | Nil
The reference ID to use for the task.
-
#reference_id=(reference_id : String | Nil)
The reference ID to use for the task.
-
#tags : Array(Tag) | Nil
The metadata that you apply to the task to help you categorize and organize them.
-
#tags=(tags : Array(Tag) | Nil)
The metadata that you apply to the task to help you categorize and organize them.
-
#task_count : Int32 | Nil
The number of tasks to create based on
TaskDefinition. -
#task_count=(task_count : Int32 | Nil)
The number of tasks to create based on
TaskDefinition. -
#task_definition_arn : String
The ARN of the task definition to use if the event target is an Amazon ECS task.
-
#task_definition_arn=(task_definition_arn : String)
The ARN of the task definition to use if the event target is an Amazon ECS task.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
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.
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.
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.
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.
Specifies an ECS task group for the task. The maximum length is 255 characters.
Specifies an ECS task group for the task. The maximum length is 255 characters.
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.
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.
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.
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.
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).
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).
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
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.
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.
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.
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.
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.
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.
The number of tasks to create based on TaskDefinition. The default is 1.
The number of tasks to create based on TaskDefinition. The default is 1.
The ARN of the task definition to use if the event target is an Amazon ECS task.
The ARN of the task definition to use if the event target is an Amazon ECS task.