Skip to content

ECS  >  Operations  >  update_express_gateway_service

update_express_gateway_service

Operation

update_express_gateway_service async

update_express_gateway_service(request: UpdateExpressGatewayServiceInput | UpdateExpressGatewayServiceInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateExpressGatewayServiceOutput
update_express_gateway_service(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateExpressGatewayServiceInputDict]) -> UpdateExpressGatewayServiceOutput

Updates an existing Express service configuration. Modifies container settings, resource allocation, auto-scaling configuration, and other service parameters without recreating the service.

Amazon ECS creates a new service revision with updated configuration and performs a rolling deployment to replace existing tasks. The service remains available during updates, ensuring zero-downtime deployments.

Some parameters like the infrastructure role cannot be modified after service creation and require creating a new service.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
UpdateExpressGatewayServiceOutput

An instance of UpdateExpressGatewayServiceOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

UpdateExpressGatewayServiceInput dataclass

Bases: _SerdeShape

Dataclass for UpdateExpressGatewayServiceInput structure.

Attributes
cpu class-attribute instance-attribute
cpu: str | None = ...

The number of CPU units used by the task.

cpu_architecture class-attribute instance-attribute
cpu_architecture: str | None = ...

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 class-attribute instance-attribute
execution_role_arn: str | None = ...

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

health_check_path class-attribute instance-attribute
health_check_path: str | None = ...

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

memory class-attribute instance-attribute
memory: str | None = ...

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

network_configuration class-attribute instance-attribute
network_configuration: ExpressGatewayServiceNetworkConfiguration | None = ...

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

primary_container class-attribute instance-attribute
primary_container: ExpressGatewayContainer | None = ...

The primary container configuration for the Express service.

scaling_target class-attribute instance-attribute
scaling_target: ExpressGatewayScalingTarget | None = ...

The auto-scaling configuration for the Express service.

service_arn class-attribute instance-attribute
service_arn: str | None = ...

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

task_definition_arn class-attribute instance-attribute
task_definition_arn: str | None = ...

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 class-attribute instance-attribute
task_role_arn: str | None = ...

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

Dictionaries

UpdateExpressGatewayServiceInputDict

Bases: TypedDict

Dictionary form of UpdateExpressGatewayServiceInput.

Attributes
cpu instance-attribute
cpu: str | None

The number of CPU units used by the task.

cpu_architecture instance-attribute
cpu_architecture: str | None

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: str | None

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

health_check_path instance-attribute
health_check_path: str | None

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

memory instance-attribute
memory: str | None

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

network_configuration instance-attribute

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

The primary container configuration for the Express service.

scaling_target instance-attribute

The auto-scaling configuration for the Express service.

service_arn instance-attribute
service_arn: Required[str]

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

task_definition_arn instance-attribute
task_definition_arn: str | None

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: str | None

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

Output

UpdateExpressGatewayServiceOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateExpressGatewayServiceOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

service class-attribute instance-attribute
service: UpdatedExpressGatewayService | None = ...

The full description of your express gateway service following the update call.