amazonka-apigateway-2.0: Amazon API Gateway SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.APIGateway.Types.AccessLogSettings

Description

 
Synopsis

Documentation

data AccessLogSettings Source #

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

See: newAccessLogSettings smart constructor.

Constructors

AccessLogSettings' 

Fields

  • destinationArn :: Maybe Text

    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-.

  • format :: Maybe Text

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

Instances

Instances details
FromJSON AccessLogSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Generic AccessLogSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Associated Types

type Rep AccessLogSettings :: Type -> Type #

Read AccessLogSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Show AccessLogSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.AccessLogSettings

NFData AccessLogSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Methods

rnf :: AccessLogSettings -> () #

Eq AccessLogSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Hashable AccessLogSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.AccessLogSettings

type Rep AccessLogSettings Source # 
Instance details

Defined in Amazonka.APIGateway.Types.AccessLogSettings

type Rep AccessLogSettings = D1 ('MetaData "AccessLogSettings" "Amazonka.APIGateway.Types.AccessLogSettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "AccessLogSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "destinationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAccessLogSettings :: AccessLogSettings Source #

Create a value of AccessLogSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:destinationArn:AccessLogSettings', accessLogSettings_destinationArn - 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-.

$sel:format:AccessLogSettings', accessLogSettings_format - A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

accessLogSettings_destinationArn :: Lens' AccessLogSettings (Maybe Text) Source #

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-.

accessLogSettings_format :: Lens' AccessLogSettings (Maybe Text) Source #

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