Skip to content

UpdateExpressGatewayServiceRequest

Source code in docs_src/capo_ecs/types/update_express_gateway_service_request.py
class UpdateExpressGatewayServiceRequest(TypedDict, closed=True):
    service_arn: "capo_ecs.types.string.String"
    """<p>The Amazon Resource Name (ARN) of the Express service to update.</p>"""
    execution_role_arn: NotRequired["capo_ecs.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the task execution role for the Express service.</p>"""
    health_check_path: NotRequired["capo_ecs.types.string.String"]
    """<p>The path on the container for Application Load Balancer health checks.</p>"""
    primary_container: NotRequired[
        "capo_ecs.types.express_gateway_container.ExpressGatewayContainer"
    ]
    """<p>The primary container configuration for the Express service.</p>"""
    task_role_arn: NotRequired["capo_ecs.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the IAM role for containers in this task.</p>"""
    network_configuration: NotRequired[
        "capo_ecs.types.express_gateway_service_network_configuration.ExpressGatewayServiceNetworkConfiguration"
    ]
    """<p>The network configuration for the Express service tasks. By default, the network configuration for an Express service uses the default VPC.</p>"""
    cpu: NotRequired["capo_ecs.types.string.String"]
    """<p>The number of CPU units used by the task.</p>"""
    memory: NotRequired["capo_ecs.types.string.String"]
    """<p>The amount of memory (in MiB) used by the task.</p>"""
    cpu_architecture: NotRequired[
        "capo_ecs.types.express_cpu_architecture.ExpressCpuArchitecture"
    ]
    """<p>The CPU architecture that the task runs on. If you don't specify a value, the service keeps its current architecture.</p> <p>Valid values:</p> <ul> <li> <p> <code>X86_64</code> - The x86 64-bit architecture.</p> </li> <li> <p> <code>ARM64</code> - The 64-bit ARM architecture.</p> </li> </ul> <p>Changing the architecture starts a new deployment that replaces the running tasks. Ensure that the container image you specify supports the architecture you choose. The operating system family for an Express service is always <code>LINUX</code>.</p> <p>You can't specify <code>cpuArchitecture</code> together with <code>taskDefinitionArn</code>.</p>"""
    scaling_target: NotRequired[
        "capo_ecs.types.express_gateway_scaling_target.ExpressGatewayScalingTarget"
    ]
    """<p>The auto-scaling configuration for the Express service.</p>"""
    task_definition_arn: NotRequired["capo_ecs.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.</p> <p>The task definition must have a container named <code>Main</code> with a single TCP port mapping that includes a container port and port name. The task definition must also have <code>FARGATE</code> compatibility.</p> <p>If you provide a task definition ARN, you cannot also specify <code>primaryContainer</code>, <code>executionRoleArn</code>, <code>taskRoleArn</code>, <code>cpu</code>, <code>memory</code>, or <code>cpuArchitecture</code>.</p>"""

cpu instance-attribute

cpu: NotRequired[String]

The number of CPU units used by the task.

cpu_architecture instance-attribute

cpu_architecture: NotRequired[ExpressCpuArchitecture]

The CPU architecture that the task runs on. If you don't specify a value, the service keeps its current architecture.

Valid values:

  • X86_64 - The x86 64-bit architecture.

  • ARM64 - The 64-bit ARM architecture.

Changing the architecture starts a new deployment that replaces the running tasks. Ensure that the container image you specify supports the architecture you choose. The operating system family for an Express service is always LINUX.

You can't specify cpuArchitecture together with taskDefinitionArn.

execution_role_arn instance-attribute

execution_role_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the task execution role for the Express service.

health_check_path instance-attribute

health_check_path: NotRequired[String]

The path on the container for Application Load Balancer health checks.

memory instance-attribute

memory: NotRequired[String]

The amount of memory (in MiB) used by the task.

network_configuration instance-attribute

network_configuration: NotRequired[ExpressGatewayServiceNetworkConfiguration]

The network configuration for the Express service tasks. By default, the network configuration for an Express service uses the default VPC.

primary_container instance-attribute

primary_container: NotRequired[ExpressGatewayContainer]

The primary container configuration for the Express service.

scaling_target instance-attribute

scaling_target: NotRequired[ExpressGatewayScalingTarget]

The auto-scaling configuration for the Express service.

service_arn instance-attribute

service_arn: String

The Amazon Resource Name (ARN) of the Express service to update.

task_definition_arn instance-attribute

task_definition_arn: NotRequired[String]

The Amazon Resource Name (ARN) of a task definition to use to update the Express Gateway service. This allows you to manage your own task definition, giving you more control over the service configuration such as adding sidecar containers.

The task definition must have a container named Main with a single TCP port mapping that includes a container port and port name. The task definition must also have FARGATE compatibility.

If you provide a task definition ARN, you cannot also specify primaryContainer, executionRoleArn, taskRoleArn, cpu, memory, or cpuArchitecture.

task_role_arn instance-attribute

task_role_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the IAM role for containers in this task.