Class: Aws::APIGateway::Types::AccessLogSettings

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::AccessLogSettings

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Access log settings, including the access log format and access log destination ARN.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #destination_arn ⇒ String

  The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.

• #format ⇒ String

  A single line format of the access logs of data, as specified by selected $context variables.

Instance Attribute Details

#destination_arn ⇒ String

The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ‘amazon-apigateway-`.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 29

class AccessLogSettings < Struct.new(
  :format,
  :destination_arn)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ‘$context.requestId`.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 29

class AccessLogSettings < Struct.new(
  :format,
  :destination_arn)
  SENSITIVE = []
  include Aws::Structure
end