class Aws::SecurityHub::Types::AwsEcsServiceDetails

Provides details about a service within an ECS cluster.

@note When making an API call, you may pass AwsEcsServiceDetails

data as a hash:

    {
      capacity_provider_strategy: [
        {
          base: 1,
          capacity_provider: "NonEmptyString",
          weight: 1,
        },
      ],
      cluster: "NonEmptyString",
      deployment_configuration: {
        deployment_circuit_breaker: {
          enable: false,
          rollback: false,
        },
        maximum_percent: 1,
        minimum_healthy_percent: 1,
      },
      deployment_controller: {
        type: "NonEmptyString",
      },
      desired_count: 1,
      enable_ecs_managed_tags: false,
      enable_execute_command: false,
      health_check_grace_period_seconds: 1,
      launch_type: "NonEmptyString",
      load_balancers: [
        {
          container_name: "NonEmptyString",
          container_port: 1,
          load_balancer_name: "NonEmptyString",
          target_group_arn: "NonEmptyString",
        },
      ],
      name: "NonEmptyString",
      network_configuration: {
        aws_vpc_configuration: {
          assign_public_ip: "NonEmptyString",
          security_groups: ["NonEmptyString"],
          subnets: ["NonEmptyString"],
        },
      },
      placement_constraints: [
        {
          expression: "NonEmptyString",
          type: "NonEmptyString",
        },
      ],
      placement_strategies: [
        {
          field: "NonEmptyString",
          type: "NonEmptyString",
        },
      ],
      platform_version: "NonEmptyString",
      propagate_tags: "NonEmptyString",
      role: "NonEmptyString",
      scheduling_strategy: "NonEmptyString",
      service_arn: "NonEmptyString",
      service_name: "NonEmptyString",
      service_registries: [
        {
          container_name: "NonEmptyString",
          container_port: 1,
          port: 1,
          registry_arn: "NonEmptyString",
        },
      ],
      task_definition: "NonEmptyString",
    }

@!attribute [rw] capacity_provider_strategy

The capacity provider strategy that the service uses.
@return [Array<Types::AwsEcsServiceCapacityProviderStrategyDetails>]

@!attribute [rw] cluster

The ARN of the cluster that hosts the service.
@return [String]

@!attribute [rw] deployment_configuration

Deployment parameters for the service. Includes the number of tasks
that run and the order in which to start and stop tasks.
@return [Types::AwsEcsServiceDeploymentConfigurationDetails]

@!attribute [rw] deployment_controller

Contains the deployment controller type that the service uses.
@return [Types::AwsEcsServiceDeploymentControllerDetails]

@!attribute [rw] desired_count

The number of instantiations of the task definition to run on the
service.
@return [Integer]

@!attribute [rw] enable_ecs_managed_tags

Whether to enable Amazon ECS managed tags for the tasks in the
service.
@return [Boolean]

@!attribute [rw] enable_execute_command

Whether the execute command functionality is enabled for the
service.
@return [Boolean]

@!attribute [rw] health_check_grace_period_seconds

After a task starts, the amount of time in seconds that the Amazon
ECS service scheduler ignores unhealthy Elastic Load Balancing
target health checks.
@return [Integer]

@!attribute [rw] launch_type

The launch type that the service uses.

Valid values: `EC2` \| `FARGATE` \| `EXTERNAL`
@return [String]

@!attribute [rw] load_balancers

Information about the load balancers that the service uses.
@return [Array<Types::AwsEcsServiceLoadBalancersDetails>]

@!attribute [rw] name

The name of the service.
@return [String]

@!attribute [rw] network_configuration

For tasks that use the `awsvpc` networking mode, the VPC subnet and
security group configuration.
@return [Types::AwsEcsServiceNetworkConfigurationDetails]

@!attribute [rw] placement_constraints

The placement constraints for the tasks in the service.
@return [Array<Types::AwsEcsServicePlacementConstraintsDetails>]

@!attribute [rw] placement_strategies

Information about how tasks for the service are placed.
@return [Array<Types::AwsEcsServicePlacementStrategiesDetails>]

@!attribute [rw] platform_version

The platform version on which to run the service. Only specified for
tasks that are hosted on Fargate. If a platform version is not
specified, the `LATEST` platform version is used by default.
@return [String]

@!attribute [rw] propagate_tags

Indicates whether to propagate the tags from the task definition to
the task or from the service to the task. If no value is provided,
then tags are not propagated.

Valid values: `TASK_DEFINITION` \| `SERVICE`
@return [String]

@!attribute [rw] role

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

@!attribute [rw] scheduling_strategy

The scheduling strategy to use for the service.

The `REPLICA` scheduling strategy places and maintains the desired
number of tasks across the cluster. By default, the service
scheduler spreads tasks across Availability Zones. Task placement
strategies and constraints are used to customize task placement
decisions.

The `DAEMON` scheduling strategy deploys exactly one task on each
active container instance that meets all of the task placement
constraints that are specified in the cluster. The service scheduler
also evaluates the task placement constraints for running tasks and
stops tasks that do not meet the placement constraints.

Valid values: `REPLICA` \| `DAEMON`
@return [String]

@!attribute [rw] service_arn

The ARN of the service.
@return [String]

@!attribute [rw] service_name

The name of the service.

The name can contain up to 255 characters. It can use letters,
numbers, underscores, and hyphens.
@return [String]

@!attribute [rw] service_registries

Information about the service discovery registries to assign to the
service.
@return [Array<Types::AwsEcsServiceServiceRegistriesDetails>]

@!attribute [rw] task_definition

The task definition to use for tasks in the service.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/AwsEcsServiceDetails AWS API Documentation

Constants

SENSITIVE