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

Inherits:
Struct
  • Object
show all
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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_arnString

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)


33
34
35
36
37
38
# File 'lib/aws-sdk-apigateway/types.rb', line 33

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

#formatString

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

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference

Returns:

  • (String)


33
34
35
36
37
38
# File 'lib/aws-sdk-apigateway/types.rb', line 33

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