« blib/lib/Paws/CloudWatchEvents/DisableRule.pm
↑ Summary
blib/lib/Paws/CloudWatchEvents/EnableRule.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudWatchEvents::EcsParameters; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatchEvents::CapacityProviderStrategyItem]'); | ||
| 5 | has EnableECSManagedTags => (is => 'ro', isa => 'Bool'); | ||
| 6 | has EnableExecuteCommand => (is => 'ro', isa => 'Bool'); | ||
| 7 | has Group => (is => 'ro', isa => 'Str'); | ||
| 8 | has LaunchType => (is => 'ro', isa => 'Str'); | ||
| 9 | has NetworkConfiguration => (is => 'ro', isa => 'Paws::CloudWatchEvents::NetworkConfiguration'); | ||
| 10 | has PlacementConstraints => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatchEvents::PlacementConstraint]'); | ||
| 11 | has PlacementStrategy => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatchEvents::PlacementStrategy]'); | ||
| 12 | has PlatformVersion => (is => 'ro', isa => 'Str'); | ||
| 13 | has PropagateTags => (is => 'ro', isa => 'Str'); | ||
| 14 | has ReferenceId => (is => 'ro', isa => 'Str'); | ||
| 15 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CloudWatchEvents::Tag]'); | ||
| 16 | has TaskCount => (is => 'ro', isa => 'Int'); | ||
| 17 | has TaskDefinitionArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::CloudWatchEvents::EcsParameters | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::CloudWatchEvents::EcsParameters object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { CapacityProviderStrategy => $value, ..., TaskDefinitionArn => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudWatchEvents::EcsParameters object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->CapacityProviderStrategy | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | The custom parameters to be used when the target is an Amazon ECS task. | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 CapacityProviderStrategy => ArrayRef[L<Paws::CloudWatchEvents::CapacityProviderStrategyItem>] | ||
| 55 | |||
| 56 | The capacity provider strategy to use for the task. | ||
| 57 | |||
| 58 | If a C<capacityProviderStrategy> is specified, the C<launchType> | ||
| 59 | parameter must be omitted. If no C<capacityProviderStrategy> or | ||
| 60 | launchType is specified, the C<defaultCapacityProviderStrategy> for the | ||
| 61 | cluster is used. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 EnableECSManagedTags => Bool | ||
| 65 | |||
| 66 | Specifies whether to enable Amazon ECS managed tags for the task. For | ||
| 67 | more information, see Tagging Your Amazon ECS Resources | ||
| 68 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) | ||
| 69 | in the Amazon Elastic Container Service Developer Guide. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 EnableExecuteCommand => Bool | ||
| 73 | |||
| 74 | Whether or not to enable the execute command functionality for the | ||
| 75 | containers in this task. If true, this enables execute command | ||
| 76 | functionality on all containers in the task. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 Group => Str | ||
| 80 | |||
| 81 | Specifies an ECS task group for the task. The maximum length is 255 | ||
| 82 | characters. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 LaunchType => Str | ||
| 86 | |||
| 87 | Specifies the launch type on which your task is running. The launch | ||
| 88 | type that you specify here must match one of the launch type | ||
| 89 | (compatibilities) of the target task. The C<FARGATE> value is supported | ||
| 90 | only in the Regions where AWS Fargate with Amazon ECS is supported. For | ||
| 91 | more information, see AWS Fargate on Amazon ECS | ||
| 92 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/AWS-Fargate.html) | ||
| 93 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 NetworkConfiguration => L<Paws::CloudWatchEvents::NetworkConfiguration> | ||
| 97 | |||
| 98 | Use this structure if the ECS task uses the C<awsvpc> network mode. | ||
| 99 | This structure specifies the VPC subnets and security groups associated | ||
| 100 | with the task, and whether a public IP address is to be used. This | ||
| 101 | structure is required if C<LaunchType> is C<FARGATE> because the | ||
| 102 | C<awsvpc> mode is required for Fargate tasks. | ||
| 103 | |||
| 104 | If you specify C<NetworkConfiguration> when the target ECS task does | ||
| 105 | not use the C<awsvpc> network mode, the task fails. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 PlacementConstraints => ArrayRef[L<Paws::CloudWatchEvents::PlacementConstraint>] | ||
| 109 | |||
| 110 | An array of placement constraint objects to use for the task. You can | ||
| 111 | specify up to 10 constraints per task (including constraints in the | ||
| 112 | task definition and those specified at runtime). | ||
| 113 | |||
| 114 | |||
| 115 | =head2 PlacementStrategy => ArrayRef[L<Paws::CloudWatchEvents::PlacementStrategy>] | ||
| 116 | |||
| 117 | The placement strategy objects to use for the task. You can specify a | ||
| 118 | maximum of five strategy rules per task. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 PlatformVersion => Str | ||
| 122 | |||
| 123 | Specifies the platform version for the task. Specify only the numeric | ||
| 124 | portion of the platform version, such as C<1.1.0>. | ||
| 125 | |||
| 126 | This structure is used only if C<LaunchType> is C<FARGATE>. For more | ||
| 127 | information about valid platform versions, see AWS Fargate Platform | ||
| 128 | Versions | ||
| 129 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) | ||
| 130 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 PropagateTags => Str | ||
| 134 | |||
| 135 | Specifies whether to propagate the tags from the task definition to the | ||
| 136 | task. If no value is specified, the tags are not propagated. Tags can | ||
| 137 | only be propagated to the task during task creation. To add tags to a | ||
| 138 | task after task creation, use the TagResource API action. | ||
| 139 | |||
| 140 | |||
| 141 | =head2 ReferenceId => Str | ||
| 142 | |||
| 143 | The reference ID to use for the task. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 Tags => ArrayRef[L<Paws::CloudWatchEvents::Tag>] | ||
| 147 | |||
| 148 | The metadata that you apply to the task to help you categorize and | ||
| 149 | organize them. Each tag consists of a key and an optional value, both | ||
| 150 | of which you define. To learn more, see RunTask | ||
| 151 | (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html#ECS-RunTask-request-tags) | ||
| 152 | in the Amazon ECS API Reference. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 TaskCount => Int | ||
| 156 | |||
| 157 | The number of tasks to create based on C<TaskDefinition>. The default | ||
| 158 | is 1. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 B<REQUIRED> TaskDefinitionArn => Str | ||
| 162 | |||
| 163 | The ARN of the task definition to use if the event target is an Amazon | ||
| 164 | ECS task. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | =head1 SEE ALSO | ||
| 169 | |||
| 170 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudWatchEvents> | ||
| 171 | |||
| 172 | =head1 BUGS and CONTRIBUTIONS | ||
| 173 | |||
| 174 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 175 | |||
| 176 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 177 | |||
| 178 | =cut | ||
| 179 |