Class: Aws::SecurityHub::Types::AwsEcsServiceDetails

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsEcsServiceDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

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",
}

Provides details about a service within an ECS cluster.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capacity_provider_strategy ⇒ Array<Types::AwsEcsServiceCapacityProviderStrategyDetails>

  The capacity provider strategy that the service uses.

• #cluster ⇒ String

  The ARN of the cluster that hosts the service.

• #deployment_configuration ⇒ Types::AwsEcsServiceDeploymentConfigurationDetails

  Deployment parameters for the service.

• #deployment_controller ⇒ Types::AwsEcsServiceDeploymentControllerDetails

  Contains the deployment controller type that the service uses.

• #desired_count ⇒ Integer

  The number of instantiations of the task definition to run on the service.

• #enable_ecs_managed_tags ⇒ Boolean

  Whether to enable Amazon ECS managed tags for the tasks in the service.

• #enable_execute_command ⇒ Boolean

  Whether the execute command functionality is enabled for the service.

• #health_check_grace_period_seconds ⇒ Integer

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

• #launch_type ⇒ String

  The launch type that the service uses.

• #load_balancers ⇒ Array<Types::AwsEcsServiceLoadBalancersDetails>

  Information about the load balancers that the service uses.

• #name ⇒ String

  The name of the service.

• #network_configuration ⇒ Types::AwsEcsServiceNetworkConfigurationDetails

  For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

• #placement_constraints ⇒ Array<Types::AwsEcsServicePlacementConstraintsDetails>

  The placement constraints for the tasks in the service.

• #placement_strategies ⇒ Array<Types::AwsEcsServicePlacementStrategiesDetails>

  Information about how tasks for the service are placed.

• #platform_version ⇒ String

  The platform version on which to run the service.

• #propagate_tags ⇒ String

  Indicates whether to propagate the tags from the task definition to the task or from the service to the task.

• #role ⇒ String

  The ARN of the IAM role that is associated with the service.

• #scheduling_strategy ⇒ String

  The scheduling strategy to use for the service.

• #service_arn ⇒ String

  The ARN of the service.

• #service_name ⇒ String

  The name of the service.

• #service_registries ⇒ Array<Types::AwsEcsServiceServiceRegistriesDetails>

  Information about the service discovery registries to assign to the service.

• #task_definition ⇒ String

  The task definition to use for tasks in the service.

Instance Attribute Details

#capacity_provider_strategy ⇒ Array<Types::AwsEcsServiceCapacityProviderStrategyDetails>

The capacity provider strategy that the service uses.

Returns:

• (Array<Types::AwsEcsServiceCapacityProviderStrategyDetails>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#cluster ⇒ String

The ARN of the cluster that hosts the service.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_configuration ⇒ Types::AwsEcsServiceDeploymentConfigurationDetails

Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.

Returns:

• (Types::AwsEcsServiceDeploymentConfigurationDetails)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_controller ⇒ Types::AwsEcsServiceDeploymentControllerDetails

Contains the deployment controller type that the service uses.

Returns:

• (Types::AwsEcsServiceDeploymentControllerDetails)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#desired_count ⇒ Integer

The number of instantiations of the task definition to run on the service.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#enable_ecs_managed_tags ⇒ Boolean

Whether to enable Amazon ECS managed tags for the tasks in the service.

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#enable_execute_command ⇒ Boolean

Whether the execute command functionality is enabled for the service.

Returns:

• (Boolean)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_grace_period_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#launch_type ⇒ String

The launch type that the service uses.

Valid values: EC2 | FARGATE | EXTERNAL

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancers ⇒ Array<Types::AwsEcsServiceLoadBalancersDetails>

Information about the load balancers that the service uses.

Returns:

• (Array<Types::AwsEcsServiceLoadBalancersDetails>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the service.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#network_configuration ⇒ Types::AwsEcsServiceNetworkConfigurationDetails

For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.

Returns:

• (Types::AwsEcsServiceNetworkConfigurationDetails)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#placement_constraints ⇒ Array<Types::AwsEcsServicePlacementConstraintsDetails>

The placement constraints for the tasks in the service.

Returns:

• (Array<Types::AwsEcsServicePlacementConstraintsDetails>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#placement_strategies ⇒ Array<Types::AwsEcsServicePlacementStrategiesDetails>

Information about how tasks for the service are placed.

Returns:

• (Array<Types::AwsEcsServicePlacementStrategiesDetails>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#platform_version ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#propagate_tags ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#scheduling_strategy ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#service_arn ⇒ String

The ARN of the service.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#service_name ⇒ String

The name of the service.

The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#service_registries ⇒ Array<Types::AwsEcsServiceServiceRegistriesDetails>

Information about the service discovery registries to assign to the service.

Returns:

• (Array<Types::AwsEcsServiceServiceRegistriesDetails>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end

#task_definition ⇒ String

The task definition to use for tasks in the service.

Returns:

• (String)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8253

class AwsEcsServiceDetails < Struct.new(
  :capacity_provider_strategy,
  :cluster,
  :deployment_configuration,
  :deployment_controller,
  :desired_count,
  :enable_ecs_managed_tags,
  :enable_execute_command,
  :health_check_grace_period_seconds,
  :launch_type,
  :load_balancers,
  :name,
  :network_configuration,
  :placement_constraints,
  :placement_strategies,
  :platform_version,
  :propagate_tags,
  :role,
  :scheduling_strategy,
  :service_arn,
  :service_name,
  :service_registries,
  :task_definition)
  SENSITIVE = []
  include Aws::Structure
end