The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::ECS::Service

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::ECS::Service object:

  $service_obj->Method(Att1 => { ClusterArn => $value, ..., TaskSets => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::Service object:

  $result = $service_obj->Method(...);
  $result->Att1->ClusterArn

DESCRIPTION

Details on a service within a cluster

ATTRIBUTES

ClusterArn => Str

  The Amazon Resource Name (ARN) of the cluster that hosts the service.

CreatedAt => Str

  The Unix timestamp for when the service was created.

CreatedBy => Str

  The principal that created the service.

DeploymentConfiguration => Paws::ECS::DeploymentConfiguration

  Optional deployment parameters that control how many tasks run during
the deployment and the ordering of stopping and starting tasks.

DeploymentController => Paws::ECS::DeploymentController

  The deployment controller type the service is using.

Deployments => ArrayRef[Paws::ECS::Deployment]

  The current state of deployments for the service.

DesiredCount => Int

  The desired number of instantiations of the task definition to keep
running on the service. This value is specified when the service is
created with CreateService, and it can be modified with UpdateService.

EnableECSManagedTags => Bool

  Specifies whether to enable Amazon ECS managed tags for the tasks in
the service. For more information, see Tagging Your Amazon ECS
Resources
(http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
in the I<Amazon Elastic Container Service Developer Guide>.

Events => ArrayRef[Paws::ECS::ServiceEvent]

  The event stream for your service. A maximum of 100 of the latest
events are displayed.

HealthCheckGracePeriodSeconds => Int

  The period of time, in seconds, that the Amazon ECS service scheduler
ignores unhealthy Elastic Load Balancing target health checks after a
task has first started.

LaunchType => Str

  The launch type on which your service is running. For more information,
see Amazon ECS Launch Types
(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)
in the I<Amazon Elastic Container Service Developer Guide>.

LoadBalancers => ArrayRef[Paws::ECS::LoadBalancer]

  A list of Elastic Load Balancing load balancer objects, containing the
load balancer name, the container name (as it appears in a container
definition), and the container port to access from the load balancer.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance. Tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

NetworkConfiguration => Paws::ECS::NetworkConfiguration

  The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the C<awsvpc> networking
mode.

PendingCount => Int

  The number of tasks in the cluster that are in the C<PENDING> state.

PlacementConstraints => ArrayRef[Paws::ECS::PlacementConstraint]

  The placement constraints for the tasks in the service.

PlacementStrategy => ArrayRef[Paws::ECS::PlacementStrategy]

  The placement strategy that determines how tasks for the service are
placed.

PlatformVersion => Str

  The platform version on which your tasks in the service are running. A
platform version is only specified for tasks using the Fargate launch
type. If one is not specified, the C<LATEST> platform version is used
by default. For more information, see AWS Fargate Platform Versions
(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
in the I<Amazon Elastic Container Service Developer Guide>.

PropagateTags => Str

  Specifies whether to propagate the tags from the task definition or the
service to the task. If no value is specified, the tags are not
propagated.

RoleArn => Str

  The ARN of the IAM role associated with the service that allows the
Amazon ECS container agent to register container instances with an
Elastic Load Balancing load balancer.

RunningCount => Int

  The number of tasks in the cluster that are in the C<RUNNING> state.

SchedulingStrategy => Str

  The scheduling strategy to use for the service. For more information,
see Services
(http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).

There are two service scheduler strategies available:

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

  • DAEMON-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.

    Fargate tasks do not support the DAEMON scheduling strategy.

ServiceArn => Str

  The ARN that identifies the service. The ARN contains the
C<arn:aws:ecs> namespace, followed by the Region of the service, the
AWS account ID of the service owner, the C<service> namespace, and then
the service name. For example,
C<arn:aws:ecs:I<region>:I<012345678910>:service/I<my-service> >.

ServiceName => Str

  The name of your service. Up to 255 letters (uppercase and lowercase),
numbers, hyphens, and underscores are allowed. Service names must be
unique within a cluster, but you can have similarly named services in
multiple clusters within a Region or across multiple Regions.

ServiceRegistries => ArrayRef[Paws::ECS::ServiceRegistry]

Status => Str

  The status of the service. The valid values are C<ACTIVE>, C<DRAINING>,
or C<INACTIVE>.

Tags => ArrayRef[Paws::ECS::Tag]

  The metadata that you apply to the service to help you categorize and
organize them. Each tag consists of a key and an optional value, both
of which you define. Tag keys can have a maximum character length of
128 characters, and tag values can have a maximum length of 256
characters.

TaskDefinition => Str

  The task definition to use for tasks in the service. This value is
specified when the service is created with CreateService, and it can be
modified with UpdateService.

TaskSets => ArrayRef[Paws::ECS::TaskSet]

  Information about a set of Amazon ECS tasks in an AWS CodeDeploy
deployment. An Amazon ECS task set includes details such as the desired
number of tasks, how many tasks are running, and whether the task set
serves production traffic.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::ECS

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