Amazonka.APIGateway.Types.AccessLogSettings

Documentation

data AccessLogSettings

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

FromJSON AccessLogSettings

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Methods

parseJSON :: Value -> Parser AccessLogSettings

parseJSONList :: Value -> Parser [AccessLogSettings]

Generic AccessLogSettings

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Associated Types

type Rep AccessLogSettings :: Type -> Type

Methods

from :: AccessLogSettings -> Rep AccessLogSettings x

to :: Rep AccessLogSettings x -> AccessLogSettings

Read AccessLogSettings

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Methods

readsPrec :: Int -> ReadS AccessLogSettings

readList :: ReadS [AccessLogSettings]

readPrec :: ReadPrec AccessLogSettings

readListPrec :: ReadPrec [AccessLogSettings]

Show AccessLogSettings

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Methods

showsPrec :: Int -> AccessLogSettings -> ShowS

show :: AccessLogSettings -> String

showList :: [AccessLogSettings] -> ShowS

NFData AccessLogSettings

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Methods

rnf :: AccessLogSettings -> ()

Eq AccessLogSettings

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Methods

(==) :: AccessLogSettings -> AccessLogSettings -> Bool

(/=) :: AccessLogSettings -> AccessLogSettings -> Bool

Hashable AccessLogSettings

Defined in Amazonka.APIGateway.Types.AccessLogSettings

Methods

hashWithSalt :: Int -> AccessLogSettings -> Int

hash :: AccessLogSettings -> Int

type Rep AccessLogSettings

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

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)

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)

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