Package software.amazon.awscdk.services.ecs

Interface ServiceConnectAccessLogConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServiceConnectAccessLogConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-24T20:29:27.962Z")
@Stability(Stable)
public interface ServiceConnectAccessLogConfiguration
extends software.amazon.jsii.JsiiSerializable

Configuration for Service Connect access logs.

Service Connect access logs provide detailed telemetry about individual requests processed by the Service Connect proxy, including HTTP methods, paths, response codes, and timing information.

Example:

 Cluster cluster;
 TaskDefinition taskDefinition;
 FargateService service = FargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .serviceConnectConfiguration(ServiceConnectProps.builder()
                 .services(List.of(ServiceConnectService.builder()
                         .portMappingName("api")
                         .build()))
                 .accessLogConfiguration(ServiceConnectAccessLogConfiguration.builder()
                         .format(ServiceConnectAccessLogFormat.JSON)
                         .includeQueryParameters(true)
                         .build())
                 // When configuring access log,
                 // you also need to configure the log driver accordingly.
                 .logDriver(LogDrivers.awsLogs(AwsLogDriverProps.builder()
                         .streamPrefix("prefix")
                         .build()))
                 .build())
         .build();
 

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-envoy-access-logs.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ServiceConnectAccessLogConfiguration.Builder	A builder for ServiceConnectAccessLogConfiguration
static final class	ServiceConnectAccessLogConfiguration.Jsii$Proxy	An implementation for ServiceConnectAccessLogConfiguration

Method Summary

Modifier and Type	Method	Description
static ServiceConnectAccessLogConfiguration.Builder	builder()
ServiceConnectAccessLogFormat	getFormat()	The format for Service Connect access log output.
default Boolean	getIncludeQueryParameters()	Whether to include query parameters in Service Connect access logs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFormat

@Stability(Stable)
@NotNull
ServiceConnectAccessLogFormat getFormat()

The format for Service Connect access log output.

• TEXT: Human-readable text format
• JSON: Structured JSON format for log analysis tools

getIncludeQueryParameters

@Stability(Stable)
@Nullable
default Boolean getIncludeQueryParameters()

Whether to include query parameters in Service Connect access logs.

When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications as query parameters may contain sensitive information such as request IDs and tokens.

Default: undefined - AWS ECS default is false, which means that query parameters are not included in access logs

builder

@Stability(Stable)
static ServiceConnectAccessLogConfiguration.Builder builder()

Returns:

a ServiceConnectAccessLogConfiguration.Builder of ServiceConnectAccessLogConfiguration