Skip to content

AwsEcsServiceDetails

Source code in docs_src/capo_securityhub/types/aws_ecs_service_details.py
class AwsEcsServiceDetails(TypedDict, closed=True):
    capacity_provider_strategy: NotRequired[
        "capo_securityhub.types.aws_ecs_service_capacity_provider_strategy_list.AwsEcsServiceCapacityProviderStrategyList"
    ]
    """<p>The capacity provider strategy that the service uses.</p>"""
    cluster: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The ARN of the cluster that hosts the service.</p>"""
    deployment_configuration: NotRequired[
        "capo_securityhub.types.aws_ecs_service_deployment_configuration_details.AwsEcsServiceDeploymentConfigurationDetails"
    ]
    """<p>Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.</p>"""
    deployment_controller: NotRequired[
        "capo_securityhub.types.aws_ecs_service_deployment_controller_details.AwsEcsServiceDeploymentControllerDetails"
    ]
    """<p>Contains the deployment controller type that the service uses.</p>"""
    desired_count: NotRequired["capo_securityhub.types.integer.Integer"]
    """<p>The number of instantiations of the task definition to run on the service.</p>"""
    enable_ecs_managed_tags: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether to enable Amazon ECS managed tags for the tasks in the service.</p>"""
    enable_execute_command: NotRequired["capo_securityhub.types.boolean.Boolean"]
    """<p>Whether the execute command functionality is enabled for the service.</p>"""
    health_check_grace_period_seconds: NotRequired[
        "capo_securityhub.types.integer.Integer"
    ]
    """<p>After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.</p>"""
    launch_type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The launch type that the service uses.</p> <p>Valid values: <code>EC2</code> | <code>FARGATE</code> | <code>EXTERNAL</code> </p>"""
    load_balancers: NotRequired[
        "capo_securityhub.types.aws_ecs_service_load_balancers_list.AwsEcsServiceLoadBalancersList"
    ]
    """<p>Information about the load balancers that the service uses.</p>"""
    name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the service.</p>"""
    network_configuration: NotRequired[
        "capo_securityhub.types.aws_ecs_service_network_configuration_details.AwsEcsServiceNetworkConfigurationDetails"
    ]
    """<p>For tasks that use the <code>awsvpc</code> networking mode, the VPC subnet and security group configuration.</p>"""
    placement_constraints: NotRequired[
        "capo_securityhub.types.aws_ecs_service_placement_constraints_list.AwsEcsServicePlacementConstraintsList"
    ]
    """<p>The placement constraints for the tasks in the service.</p>"""
    placement_strategies: NotRequired[
        "capo_securityhub.types.aws_ecs_service_placement_strategies_list.AwsEcsServicePlacementStrategiesList"
    ]
    """<p>Information about how tasks for the service are placed.</p>"""
    platform_version: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>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 <code>LATEST</code> platform version is used by default.</p>"""
    propagate_tags: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>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.</p> <p>Valid values: <code>TASK_DEFINITION</code> | <code>SERVICE</code> </p>"""
    role: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>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.</p>"""
    scheduling_strategy: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The scheduling strategy to use for the service.</p> <p>The <code>REPLICA</code> 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.</p> <p>The <code>DAEMON</code> 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 don't meet the placement constraints.</p> <p>Valid values: <code>REPLICA</code> | <code>DAEMON</code> </p>"""
    service_arn: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The ARN of the service.</p>"""
    service_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the service.</p> <p>The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.</p>"""
    service_registries: NotRequired[
        "capo_securityhub.types.aws_ecs_service_service_registries_list.AwsEcsServiceServiceRegistriesList"
    ]
    """<p>Information about the service discovery registries to assign to the service.</p>"""
    task_definition: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The task definition to use for tasks in the service.</p>"""

capacity_provider_strategy instance-attribute

capacity_provider_strategy: NotRequired[AwsEcsServiceCapacityProviderStrategyList]

The capacity provider strategy that the service uses.

cluster instance-attribute

cluster: NotRequired[NonEmptyString]

The ARN of the cluster that hosts the service.

deployment_configuration instance-attribute

deployment_configuration: NotRequired[AwsEcsServiceDeploymentConfigurationDetails]

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

deployment_controller instance-attribute

deployment_controller: NotRequired[AwsEcsServiceDeploymentControllerDetails]

Contains the deployment controller type that the service uses.

desired_count instance-attribute

desired_count: NotRequired[Integer]

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

enable_ecs_managed_tags instance-attribute

enable_ecs_managed_tags: NotRequired[Boolean]

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

enable_execute_command instance-attribute

enable_execute_command: NotRequired[Boolean]

Whether the execute command functionality is enabled for the service.

health_check_grace_period_seconds instance-attribute

health_check_grace_period_seconds: NotRequired[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 instance-attribute

launch_type: NotRequired[NonEmptyString]

The launch type that the service uses.

Valid values: EC2 | FARGATE | EXTERNAL

load_balancers instance-attribute

load_balancers: NotRequired[AwsEcsServiceLoadBalancersList]

Information about the load balancers that the service uses.

name instance-attribute

name: NotRequired[NonEmptyString]

The name of the service.

network_configuration instance-attribute

network_configuration: NotRequired[AwsEcsServiceNetworkConfigurationDetails]

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

placement_constraints instance-attribute

placement_constraints: NotRequired[AwsEcsServicePlacementConstraintsList]

The placement constraints for the tasks in the service.

placement_strategies instance-attribute

placement_strategies: NotRequired[AwsEcsServicePlacementStrategiesList]

Information about how tasks for the service are placed.

platform_version instance-attribute

platform_version: NotRequired[NonEmptyString]

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.

propagate_tags instance-attribute

propagate_tags: NotRequired[NonEmptyString]

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

role instance-attribute

role: NotRequired[NonEmptyString]

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.

scheduling_strategy instance-attribute

scheduling_strategy: NotRequired[NonEmptyString]

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 don't meet the placement constraints.

Valid values: REPLICA | DAEMON

service_arn instance-attribute

service_arn: NotRequired[NonEmptyString]

The ARN of the service.

service_name instance-attribute

service_name: NotRequired[NonEmptyString]

The name of the service.

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

service_registries instance-attribute

service_registries: NotRequired[AwsEcsServiceServiceRegistriesList]

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

task_definition instance-attribute

task_definition: NotRequired[NonEmptyString]

The task definition to use for tasks in the service.