NAME
Paws::CloudWatchEvents::EcsParameters
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::CloudWatchEvents::EcsParameters object:
$service_obj->Method(Att1 => { CapacityProviderStrategy => $value, ..., TaskDefinitionArn => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::EcsParameters object:
$result = $service_obj->Method(...);
$result->Att1->CapacityProviderStrategy
DESCRIPTION
The custom parameters to be used when the target is an Amazon ECS task.
ATTRIBUTES
CapacityProviderStrategy => ArrayRef[Paws::CloudWatchEvents::CapacityProviderStrategyItem]
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.
EnableECSManagedTags => Bool
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide.
EnableExecuteCommand => Bool
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.
Group => Str
Specifies an ECS task group for the task. The maximum length is 255 characters.
LaunchType => Str
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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) in the Amazon Elastic Container Service Developer Guide.
NetworkConfiguration => Paws::CloudWatchEvents::NetworkConfiguration
Use this structure if the 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.
PlacementConstraints => ArrayRef[Paws::CloudWatchEvents::PlacementConstraint]
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).
PlacementStrategy => ArrayRef[Paws::CloudWatchEvents::PlacementStrategy]
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
PlatformVersion => Str
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 AWS Fargate Platform Versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the Amazon Elastic Container Service Developer Guide.
PropagateTags => Str
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.
ReferenceId => Str
The reference ID to use for the task.
Tags => ArrayRef[Paws::CloudWatchEvents::Tag]
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 (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) in the Amazon ECS API Reference.
TaskCount => Int
The number of tasks to create based on TaskDefinition
. The default is 1.
REQUIRED TaskDefinitionArn => Str
The ARN of the task definition to use if the event target is an Amazon ECS task.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::CloudWatchEvents
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues