You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::AccessLogSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Note:

When making an API call, you may pass AccessLogSettings data as a hash:

{
  destination_arn: "Arn",
  format: "StringWithLengthBetween1And1024",
}

Settings for logging access in a stage.

Instance Attribute Summary collapse

Instance Attribute Details

#destination_arnString

The ARN of the CloudWatch Logs log group to receive access logs.

Returns:

  • (String)


31
32
33
34
35
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 31

class AccessLogSettings < Struct.new(
  :destination_arn,
  :format)
  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.

Returns:

  • (String)


31
32
33
34
35
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 31

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