AWS cli: ECS update-service: document new --gateway-connectors parameter
Summary
Adds reference documentation for the new --gateway-connectors list parameter on the ECS update-service command, including the gateway connector structure (portName, healthCheck with protocol/port/path/timeouts/thresholds/matcher, and filters with accessTypes PUBLIC/PRIVATE), plus shorthand and JSON syntax examples. Also updates navigation links and the AWS CLI version from 2.38.2 to 2.38.3.
Security assessment
This is feature reference documentation for a new CLI parameter, not a fix for a vulnerability or incident. It does describe accessTypes (PUBLIC/PRIVATE) that govern whether a gateway ingress path is internet-exposed, which has network-exposure implications, but it is descriptive API documentation rather than security guidance or a remediation. No CVE or advisory is referenced.
Evidence
>>>> * `PUBLIC` \- The ingress path is publicly accessible.
Diff
diff --git a/cli/latest/reference/ecs/update-service.md b/cli/latest/reference/ecs/update-service.md index 9a3da3f..9f05821 100644 --- a//cli/latest/reference/ecs/update-service.md +++ b//cli/latest/reference/ecs/update-service.md @@ -14,2 +14,2 @@ - * [previous](update-express-gateway-service.html "update-express-gateway-service") | - * [AWS CLI 2.38.2 Command Reference](../../index.html) » + * [previous](update-gateway.html "update-gateway") | + * [AWS CLI 2.38.3 Command Reference](../../index.html) » @@ -22 +22 @@ - * [← update-express-gateway-service](update-express-gateway-service.html "previous chapter \(use the left arrow\)") / + * [← update-gateway](update-gateway.html "previous chapter \(use the left arrow\)") / @@ -138,0 +139 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/ecs-20 + [--gateway-connectors <value>] @@ -1918,0 +1920,143 @@ JSON Syntax: +`--gateway-connectors` (list) + +> The updated set of gateway connectors that connect the service to a gateway ingress path. A service supports no more than one gateway connector. +> +> Constraints: +> +> * min: `0` +> * max: `1` +> + +> +> (structure) +> +>> A gateway connector that attaches an Amazon ECS service to a gateway ingress path. The connector specifies the service port that receives gateway-managed ingress traffic, along with the health check and traffic filters that the gateway applies. A service can have at most one gateway connector. +>> +>> portName -> (string) [required] +>> +>>> The name of the service port that the gateway routes ingress traffic to. +>> +>> healthCheck -> (structure) +>> +>>> The health check that the gateway uses to determine whether the targets for this connector are healthy. +>>> +>>> healthCheckProtocol -> (string) +>>> +>>>> The protocol that the gateway uses to perform health checks. +>>>> +>>>> Valid values: +>>>> +>>>> * `HTTP` \- Health checks are performed over HTTP. +>>>> * `HTTPS` \- Health checks are performed over HTTPS. +>>>> + +>>>> +>>>> Possible values: +>>>> +>>>> * `HTTP` +>>>> * `HTTPS` +>>>> + +>>> +>>> healthCheckPort -> (integer) +>>> +>>>> The port that the gateway uses to perform health checks on the targets. +>>> +>>> healthCheckPath -> (string) +>>> +>>>> The destination path for health check requests. +>>> +>>> healthCheckTimeoutSeconds -> (integer) +>>> +>>>> The amount of time, in seconds, during which no response from a target means a failed health check. +>>> +>>> healthCheckIntervalSeconds -> (integer) +>>> +>>>> The approximate amount of time, in seconds, between health checks of an individual target. +>>> +>>> healthyThresholdCount -> (integer) +>>> +>>>> The number of consecutive successful health checks that a target must pass before the gateway considers it healthy. +>>> +>>> unhealthyThresholdCount -> (integer) +>>> +>>>> The number of consecutive failed health checks that a target must fail before the gateway considers it unhealthy. +>>> +>>> matcher -> (structure) +>>> +>>>> The HTTP or gRPC codes that indicate a successful health check response from a target. +>>>> +>>>> httpCode -> (string) +>>>> +>>>>> The HTTP codes that indicate a successful response from a target. +>>>> +>>>> grpcCode -> (string) +>>>> +>>>>> The gRPC codes that indicate a successful response from a target. +>> +>> filters -> (structure) +>> +>>> The filters that control which gateway ingress paths the connector applies to. +>>> +>>> accessTypes -> (list) +>>> +>>>> The access types of the gateway ingress paths that the connector applies to. +>>>> +>>>> The access type can be one of the following values: +>>>> +>>>> * `PUBLIC` \- The ingress path is publicly accessible. +>>>> * `PRIVATE` \- The ingress path is only accessible privately. +>>>> + +>>>> +>>>> Constraints: +>>>> +>>>> * min: `0` +>>>> * max: `2` +>>>> + +>>>> +>>>> (string) +>>>> +>>>>> Specifies whether a resource is publicly accessible from the internet or private to a VPC. +>>>>> +>>>>> Possible values: +>>>>> +>>>>> * `PUBLIC` +>>>>> * `PRIVATE` +>>>>> + + +Shorthand Syntax: + + + portName=string,healthCheck={healthCheckProtocol=string,healthCheckPort=integer,healthCheckPath=string,healthCheckTimeoutSeconds=integer,healthCheckIntervalSeconds=integer,healthyThresholdCount=integer,unhealthyThresholdCount=integer,matcher={httpCode=string,grpcCode=string}},filters={accessTypes=[string,string]} ... + + +JSON Syntax: + + + [ + { + "portName": "string", + "healthCheck": { + "healthCheckProtocol": "HTTP"|"HTTPS", + "healthCheckPort": integer, + "healthCheckPath": "string", + "healthCheckTimeoutSeconds": integer, + "healthCheckIntervalSeconds": integer, + "healthyThresholdCount": integer, + "unhealthyThresholdCount": integer, + "matcher": { + "httpCode": "string", + "grpcCode": "string" + } + }, + "filters": { + "accessTypes": ["PUBLIC"|"PRIVATE", ...] + } + } + ... + ] + + @@ -5112 +5256 @@ service -> (structure) - * [← update-express-gateway-service](update-express-gateway-service.html "previous chapter \(use the left arrow\)") / + * [← update-gateway](update-gateway.html "previous chapter \(use the left arrow\)") / @@ -5121,2 +5265,2 @@ service -> (structure) - * [previous](update-express-gateway-service.html "update-express-gateway-service") | - * [AWS CLI 2.38.2 Command Reference](../../index.html) » + * [previous](update-gateway.html "update-gateway") | + * [AWS CLI 2.38.3 Command Reference](../../index.html) »