| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::Service; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::CapacityProviderStrategyItem]', request_name => 'capacityProviderStrategy', traits => ['NameInRequest']); | ||
| 5 | has ClusterArn => (is => 'ro', isa => 'Str', request_name => 'clusterArn', traits => ['NameInRequest']); | ||
| 6 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 7 | has CreatedBy => (is => 'ro', isa => 'Str', request_name => 'createdBy', traits => ['NameInRequest']); | ||
| 8 | has DeploymentConfiguration => (is => 'ro', isa => 'Paws::ECS::DeploymentConfiguration', request_name => 'deploymentConfiguration', traits => ['NameInRequest']); | ||
| 9 | has DeploymentController => (is => 'ro', isa => 'Paws::ECS::DeploymentController', request_name => 'deploymentController', traits => ['NameInRequest']); | ||
| 10 | has Deployments => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Deployment]', request_name => 'deployments', traits => ['NameInRequest']); | ||
| 11 | has DesiredCount => (is => 'ro', isa => 'Int', request_name => 'desiredCount', traits => ['NameInRequest']); | ||
| 12 | has EnableECSManagedTags => (is => 'ro', isa => 'Bool', request_name => 'enableECSManagedTags', traits => ['NameInRequest']); | ||
| 13 | has EnableExecuteCommand => (is => 'ro', isa => 'Bool', request_name => 'enableExecuteCommand', traits => ['NameInRequest']); | ||
| 14 | has Events => (is => 'ro', isa => 'ArrayRef[Paws::ECS::ServiceEvent]', request_name => 'events', traits => ['NameInRequest']); | ||
| 15 | has HealthCheckGracePeriodSeconds => (is => 'ro', isa => 'Int', request_name => 'healthCheckGracePeriodSeconds', traits => ['NameInRequest']); | ||
| 16 | has LaunchType => (is => 'ro', isa => 'Str', request_name => 'launchType', traits => ['NameInRequest']); | ||
| 17 | has LoadBalancers => (is => 'ro', isa => 'ArrayRef[Paws::ECS::LoadBalancer]', request_name => 'loadBalancers', traits => ['NameInRequest']); | ||
| 18 | has NetworkConfiguration => (is => 'ro', isa => 'Paws::ECS::NetworkConfiguration', request_name => 'networkConfiguration', traits => ['NameInRequest']); | ||
| 19 | has PendingCount => (is => 'ro', isa => 'Int', request_name => 'pendingCount', traits => ['NameInRequest']); | ||
| 20 | has PlacementConstraints => (is => 'ro', isa => 'ArrayRef[Paws::ECS::PlacementConstraint]', request_name => 'placementConstraints', traits => ['NameInRequest']); | ||
| 21 | has PlacementStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::PlacementStrategy]', request_name => 'placementStrategy', traits => ['NameInRequest']); | ||
| 22 | has PlatformVersion => (is => 'ro', isa => 'Str', request_name => 'platformVersion', traits => ['NameInRequest']); | ||
| 23 | has PropagateTags => (is => 'ro', isa => 'Str', request_name => 'propagateTags', traits => ['NameInRequest']); | ||
| 24 | has RoleArn => (is => 'ro', isa => 'Str', request_name => 'roleArn', traits => ['NameInRequest']); | ||
| 25 | has RunningCount => (is => 'ro', isa => 'Int', request_name => 'runningCount', traits => ['NameInRequest']); | ||
| 26 | has SchedulingStrategy => (is => 'ro', isa => 'Str', request_name => 'schedulingStrategy', traits => ['NameInRequest']); | ||
| 27 | has ServiceArn => (is => 'ro', isa => 'Str', request_name => 'serviceArn', traits => ['NameInRequest']); | ||
| 28 | has ServiceName => (is => 'ro', isa => 'Str', request_name => 'serviceName', traits => ['NameInRequest']); | ||
| 29 | has ServiceRegistries => (is => 'ro', isa => 'ArrayRef[Paws::ECS::ServiceRegistry]', request_name => 'serviceRegistries', traits => ['NameInRequest']); | ||
| 30 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 31 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 32 | has TaskDefinition => (is => 'ro', isa => 'Str', request_name => 'taskDefinition', traits => ['NameInRequest']); | ||
| 33 | has TaskSets => (is => 'ro', isa => 'ArrayRef[Paws::ECS::TaskSet]', request_name => 'taskSets', traits => ['NameInRequest']); | ||
| 34 | |||
| 35 | 1; | ||
| 36 | |||
| 37 | ### main pod documentation begin ### | ||
| 38 | |||
| 39 | =head1 NAME | ||
| 40 | |||
| 41 | Paws::ECS::Service | ||
| 42 | |||
| 43 | =head1 USAGE | ||
| 44 | |||
| 45 | This class represents one of two things: | ||
| 46 | |||
| 47 | =head3 Arguments in a call to a service | ||
| 48 | |||
| 49 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 50 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 51 | |||
| 52 | As an example, if Att1 is expected to be a Paws::ECS::Service object: | ||
| 53 | |||
| 54 | $service_obj->Method(Att1 => { CapacityProviderStrategy => $value, ..., TaskSets => $value }); | ||
| 55 | |||
| 56 | =head3 Results returned from an API call | ||
| 57 | |||
| 58 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::Service object: | ||
| 59 | |||
| 60 | $result = $service_obj->Method(...); | ||
| 61 | $result->Att1->CapacityProviderStrategy | ||
| 62 | |||
| 63 | =head1 DESCRIPTION | ||
| 64 | |||
| 65 | Details on a service within a cluster | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 CapacityProviderStrategy => ArrayRef[L<Paws::ECS::CapacityProviderStrategyItem>] | ||
| 71 | |||
| 72 | The capacity provider strategy associated with the service. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 ClusterArn => Str | ||
| 76 | |||
| 77 | The Amazon Resource Name (ARN) of the cluster that hosts the service. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 CreatedAt => Str | ||
| 81 | |||
| 82 | The Unix timestamp for when the service was created. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 CreatedBy => Str | ||
| 86 | |||
| 87 | The principal that created the service. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 DeploymentConfiguration => L<Paws::ECS::DeploymentConfiguration> | ||
| 91 | |||
| 92 | Optional deployment parameters that control how many tasks run during | ||
| 93 | the deployment and the ordering of stopping and starting tasks. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 DeploymentController => L<Paws::ECS::DeploymentController> | ||
| 97 | |||
| 98 | The deployment controller type the service is using. When using the | ||
| 99 | DescribeServices API, this field is omitted if the service is using the | ||
| 100 | C<ECS> deployment controller type. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 Deployments => ArrayRef[L<Paws::ECS::Deployment>] | ||
| 104 | |||
| 105 | The current state of deployments for the service. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 DesiredCount => Int | ||
| 109 | |||
| 110 | The desired number of instantiations of the task definition to keep | ||
| 111 | running on the service. This value is specified when the service is | ||
| 112 | created with CreateService, and it can be modified with UpdateService. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 EnableECSManagedTags => Bool | ||
| 116 | |||
| 117 | Specifies whether to enable Amazon ECS managed tags for the tasks in | ||
| 118 | the service. For more information, see Tagging Your Amazon ECS | ||
| 119 | Resources | ||
| 120 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) | ||
| 121 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 EnableExecuteCommand => Bool | ||
| 125 | |||
| 126 | Whether or not the execute command functionality is enabled for the | ||
| 127 | service. If C<true>, the execute command functionality is enabled for | ||
| 128 | all containers in tasks as part of the service. | ||
| 129 | |||
| 130 | |||
| 131 | =head2 Events => ArrayRef[L<Paws::ECS::ServiceEvent>] | ||
| 132 | |||
| 133 | The event stream for your service. A maximum of 100 of the latest | ||
| 134 | events are displayed. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 HealthCheckGracePeriodSeconds => Int | ||
| 138 | |||
| 139 | The period of time, in seconds, that the Amazon ECS service scheduler | ||
| 140 | ignores unhealthy Elastic Load Balancing target health checks after a | ||
| 141 | task has first started. | ||
| 142 | |||
| 143 | |||
| 144 | =head2 LaunchType => Str | ||
| 145 | |||
| 146 | The infrastructure on which your service is running. For more | ||
| 147 | information, see Amazon ECS launch types | ||
| 148 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) | ||
| 149 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 150 | |||
| 151 | |||
| 152 | =head2 LoadBalancers => ArrayRef[L<Paws::ECS::LoadBalancer>] | ||
| 153 | |||
| 154 | A list of Elastic Load Balancing load balancer objects, containing the | ||
| 155 | load balancer name, the container name (as it appears in a container | ||
| 156 | definition), and the container port to access from the load balancer. | ||
| 157 | |||
| 158 | |||
| 159 | =head2 NetworkConfiguration => L<Paws::ECS::NetworkConfiguration> | ||
| 160 | |||
| 161 | The VPC subnet and security group configuration for tasks that receive | ||
| 162 | their own elastic network interface by using the C<awsvpc> networking | ||
| 163 | mode. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 PendingCount => Int | ||
| 167 | |||
| 168 | The number of tasks in the cluster that are in the C<PENDING> state. | ||
| 169 | |||
| 170 | |||
| 171 | =head2 PlacementConstraints => ArrayRef[L<Paws::ECS::PlacementConstraint>] | ||
| 172 | |||
| 173 | The placement constraints for the tasks in the service. | ||
| 174 | |||
| 175 | |||
| 176 | =head2 PlacementStrategy => ArrayRef[L<Paws::ECS::PlacementStrategy>] | ||
| 177 | |||
| 178 | The placement strategy that determines how tasks for the service are | ||
| 179 | placed. | ||
| 180 | |||
| 181 | |||
| 182 | =head2 PlatformVersion => Str | ||
| 183 | |||
| 184 | The platform version on which to run your service. A platform version | ||
| 185 | is only specified for tasks using the Fargate launch type. If one is | ||
| 186 | not specified, the C<LATEST> platform version is used by default. For | ||
| 187 | more information, see AWS Fargate Platform Versions | ||
| 188 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) | ||
| 189 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 190 | |||
| 191 | |||
| 192 | =head2 PropagateTags => Str | ||
| 193 | |||
| 194 | Specifies whether to propagate the tags from the task definition or the | ||
| 195 | service to the task. If no value is specified, the tags are not | ||
| 196 | propagated. | ||
| 197 | |||
| 198 | |||
| 199 | =head2 RoleArn => Str | ||
| 200 | |||
| 201 | The ARN of the IAM role associated with the service that allows the | ||
| 202 | Amazon ECS container agent to register container instances with an | ||
| 203 | Elastic Load Balancing load balancer. | ||
| 204 | |||
| 205 | |||
| 206 | =head2 RunningCount => Int | ||
| 207 | |||
| 208 | The number of tasks in the cluster that are in the C<RUNNING> state. | ||
| 209 | |||
| 210 | |||
| 211 | =head2 SchedulingStrategy => Str | ||
| 212 | |||
| 213 | The scheduling strategy to use for the service. For more information, | ||
| 214 | see Services | ||
| 215 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). | ||
| 216 | |||
| 217 | There are two service scheduler strategies available: | ||
| 218 | |||
| 219 | =over | ||
| 220 | |||
| 221 | =item * | ||
| 222 | |||
| 223 | C<REPLICA>-The replica scheduling strategy places and maintains the | ||
| 224 | desired number of tasks across your cluster. By default, the service | ||
| 225 | scheduler spreads tasks across Availability Zones. You can use task | ||
| 226 | placement strategies and constraints to customize task placement | ||
| 227 | decisions. | ||
| 228 | |||
| 229 | =item * | ||
| 230 | |||
| 231 | C<DAEMON>-The daemon scheduling strategy deploys exactly one task on | ||
| 232 | each active container instance that meets all of the task placement | ||
| 233 | constraints that you specify in your cluster. The service scheduler | ||
| 234 | also evaluates the task placement constraints for running tasks and | ||
| 235 | will stop tasks that do not meet the placement constraints. | ||
| 236 | |||
| 237 | Fargate tasks do not support the C<DAEMON> scheduling strategy. | ||
| 238 | |||
| 239 | =back | ||
| 240 | |||
| 241 | |||
| 242 | |||
| 243 | =head2 ServiceArn => Str | ||
| 244 | |||
| 245 | The ARN that identifies the service. The ARN contains the | ||
| 246 | C<arn:aws:ecs> namespace, followed by the Region of the service, the | ||
| 247 | AWS account ID of the service owner, the C<service> namespace, and then | ||
| 248 | the service name. For example, | ||
| 249 | C<arn:aws:ecs:region:012345678910:service/my-service>. | ||
| 250 | |||
| 251 | |||
| 252 | =head2 ServiceName => Str | ||
| 253 | |||
| 254 | The name of your service. Up to 255 letters (uppercase and lowercase), | ||
| 255 | numbers, underscores, and hyphens are allowed. Service names must be | ||
| 256 | unique within a cluster, but you can have similarly named services in | ||
| 257 | multiple clusters within a Region or across multiple Regions. | ||
| 258 | |||
| 259 | |||
| 260 | =head2 ServiceRegistries => ArrayRef[L<Paws::ECS::ServiceRegistry>] | ||
| 261 | |||
| 262 | The details of the service discovery registries to assign to this | ||
| 263 | service. For more information, see Service Discovery | ||
| 264 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). | ||
| 265 | |||
| 266 | |||
| 267 | =head2 Status => Str | ||
| 268 | |||
| 269 | The status of the service. The valid values are C<ACTIVE>, C<DRAINING>, | ||
| 270 | or C<INACTIVE>. | ||
| 271 | |||
| 272 | |||
| 273 | =head2 Tags => ArrayRef[L<Paws::ECS::Tag>] | ||
| 274 | |||
| 275 | The metadata that you apply to the service to help you categorize and | ||
| 276 | organize them. Each tag consists of a key and an optional value, both | ||
| 277 | of which you define. | ||
| 278 | |||
| 279 | The following basic restrictions apply to tags: | ||
| 280 | |||
| 281 | =over | ||
| 282 | |||
| 283 | =item * | ||
| 284 | |||
| 285 | Maximum number of tags per resource - 50 | ||
| 286 | |||
| 287 | =item * | ||
| 288 | |||
| 289 | For each resource, each tag key must be unique, and each tag key can | ||
| 290 | have only one value. | ||
| 291 | |||
| 292 | =item * | ||
| 293 | |||
| 294 | Maximum key length - 128 Unicode characters in UTF-8 | ||
| 295 | |||
| 296 | =item * | ||
| 297 | |||
| 298 | Maximum value length - 256 Unicode characters in UTF-8 | ||
| 299 | |||
| 300 | =item * | ||
| 301 | |||
| 302 | If your tagging schema is used across multiple services and resources, | ||
| 303 | remember that other services may have restrictions on allowed | ||
| 304 | characters. Generally allowed characters are: letters, numbers, and | ||
| 305 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 306 | : / @. | ||
| 307 | |||
| 308 | =item * | ||
| 309 | |||
| 310 | Tag keys and values are case-sensitive. | ||
| 311 | |||
| 312 | =item * | ||
| 313 | |||
| 314 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 315 | such as a prefix for either keys or values as it is reserved for AWS | ||
| 316 | use. You cannot edit or delete tag keys or values with this prefix. | ||
| 317 | Tags with this prefix do not count against your tags per resource | ||
| 318 | limit. | ||
| 319 | |||
| 320 | =back | ||
| 321 | |||
| 322 | |||
| 323 | |||
| 324 | =head2 TaskDefinition => Str | ||
| 325 | |||
| 326 | The task definition to use for tasks in the service. This value is | ||
| 327 | specified when the service is created with CreateService, and it can be | ||
| 328 | modified with UpdateService. | ||
| 329 | |||
| 330 | |||
| 331 | =head2 TaskSets => ArrayRef[L<Paws::ECS::TaskSet>] | ||
| 332 | |||
| 333 | Information about a set of Amazon ECS tasks in either an AWS CodeDeploy | ||
| 334 | or an C<EXTERNAL> deployment. An Amazon ECS task set includes details | ||
| 335 | such as the desired number of tasks, how many tasks are running, and | ||
| 336 | whether the task set serves production traffic. | ||
| 337 | |||
| 338 | |||
| 339 | |||
| 340 | =head1 SEE ALSO | ||
| 341 | |||
| 342 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 343 | |||
| 344 | =head1 BUGS and CONTRIBUTIONS | ||
| 345 | |||
| 346 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 347 | |||
| 348 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 349 | |||
| 350 | =cut | ||
| 351 |