Class: AWSCDK::ECS::CfnService::ServiceConnectAccessLogConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ECS::CfnService::ServiceConnectAccessLogConfigurationProperty

Defined in:

ecs/cfn_service.rb

Overview

Configuration for Service Connect access logging.

Access logs provide detailed information about requests made to your service, including request patterns, response codes, and timing data for debugging and monitoring purposes.

To enable access logs, you must also specify a log_configuration in the service_connect_configuration .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectaccesslogconfiguration.html

Instance Attribute Summary

• #format ⇒ String readonly

  The format for Service Connect access log output.

• #include_query_parameters ⇒ String^? readonly

  Specifies whether to include query parameters in Service Connect access logs.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(format:, include_query_parameters: nil) ⇒ ServiceConnectAccessLogConfigurationProperty constructor

  A new instance of ServiceConnectAccessLogConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

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

Returns a new instance of ServiceConnectAccessLogConfigurationProperty.

Parameters:

• format (String) —

  The format for Service Connect access log output.

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

  Specifies whether to include query parameters in Service Connect access logs.

# File 'ecs/cfn_service.rb', line 2409

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

Instance Attribute Details

#format ⇒ String (readonly)

The format for Service Connect access log output.

Choose TEXT for human-readable logs or JSON for structured data that integrates well with log analysis tools.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectaccesslogconfiguration.html#cfn-ecs-service-serviceconnectaccesslogconfiguration-format

# File 'ecs/cfn_service.rb', line 2422

def format
  @format
end

#include_query_parameters ⇒ String^? (readonly)

Specifies 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 when enabling this feature, as query parameters may contain sensitive information such as request IDs and tokens. By default, this parameter is DISABLED .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-serviceconnectaccesslogconfiguration.html#cfn-ecs-service-serviceconnectaccesslogconfiguration-includequeryparameters

# File 'ecs/cfn_service.rb', line 2429

def include_query_parameters
  @include_query_parameters
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ecs/cfn_service.rb', line 2431

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

Instance Method Details

#to_jsii ⇒ Object

# File 'ecs/cfn_service.rb', line 2438

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