Class: AWSCDK::ECS::ServiceConnectAccessLogConfiguration

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ecs/service_connect_access_log_configuration.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(format:, include_query_parameters: nil) ⇒ ServiceConnectAccessLogConfiguration

Returns a new instance of ServiceConnectAccessLogConfiguration.

Parameters:

  • format (AWSCDK::ECS::ServiceConnectAccessLogFormat) —

    The format for Service Connect access log output.

  • include_query_parameters (Boolean, nil) (defaults to: nil) —

    Whether to include query parameters in Service Connect access logs.



14
15
16
17
18
19
 
# File 'ecs/service_connect_access_log_configuration.rb', line 14

def initialize(format:, include_query_parameters: nil)
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLlNlcnZpY2VDb25uZWN0QWNjZXNzTG9nRm9ybWF0In0=")), "format")
  @include_query_parameters = include_query_parameters
  Jsii::Type.check_type(@include_query_parameters, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "includeQueryParameters") unless @include_query_parameters.nil?
end

Instance Attribute Details

#format ⇒ AWSCDK::ECS::ServiceConnectAccessLogFormat (readonly)

The format for Service Connect access log output.

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

Returns:



27
28
29
 
# File 'ecs/service_connect_access_log_configuration.rb', line 27

def format
  @format
end

#include_query_parameters ⇒ Boolean? (readonly)

Note:

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

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.

Returns:

  • (Boolean, nil) 


35
36
37
 
# File 'ecs/service_connect_access_log_configuration.rb', line 35

def include_query_parameters
  @include_query_parameters
end

Class Method Details

.jsii_properties ⇒ Object 



37
38
39
40
41
42
 
# File 'ecs/service_connect_access_log_configuration.rb', line 37

def self.jsii_properties
  {
    :format => "format",
    :include_query_parameters => "includeQueryParameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



44
45
46
47
48
49
50
51
 
# File 'ecs/service_connect_access_log_configuration.rb', line 44

def to_jsii
  result = {}
  result.merge!({
    "format" => @format,
    "includeQueryParameters" => @include_query_parameters,
  })
  result.compact
end