AWS SDK for C++  1.8.99
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::AccessLogSettings Class Reference

#include <AccessLogSettings.h>

Public Member Functions

 AccessLogSettings ()
 
 AccessLogSettings (Aws::Utils::Json::JsonView jsonValue)
 
AccessLogSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetFormat () const
 
bool FormatHasBeenSet () const
 
void SetFormat (const Aws::String &value)
 
void SetFormat (Aws::String &&value)
 
void SetFormat (const char *value)
 
AccessLogSettingsWithFormat (const Aws::String &value)
 
AccessLogSettingsWithFormat (Aws::String &&value)
 
AccessLogSettingsWithFormat (const char *value)
 
const Aws::StringGetDestinationArn () const
 
bool DestinationArnHasBeenSet () const
 
void SetDestinationArn (const Aws::String &value)
 
void SetDestinationArn (Aws::String &&value)
 
void SetDestinationArn (const char *value)
 
AccessLogSettingsWithDestinationArn (const Aws::String &value)
 
AccessLogSettingsWithDestinationArn (Aws::String &&value)
 
AccessLogSettingsWithDestinationArn (const char *value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 32 of file AccessLogSettings.h.

Constructor & Destructor Documentation

◆ AccessLogSettings() [1/2]

Aws::APIGateway::Model::AccessLogSettings::AccessLogSettings ( )

◆ AccessLogSettings() [2/2]

Aws::APIGateway::Model::AccessLogSettings::AccessLogSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DestinationArnHasBeenSet()

bool Aws::APIGateway::Model::AccessLogSettings::DestinationArnHasBeenSet ( ) const
inline

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

Definition at line 120 of file AccessLogSettings.h.

◆ FormatHasBeenSet()

bool Aws::APIGateway::Model::AccessLogSettings::FormatHasBeenSet ( ) const
inline

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

Definition at line 55 of file AccessLogSettings.h.

◆ GetDestinationArn()

const Aws::String& Aws::APIGateway::Model::AccessLogSettings::GetDestinationArn ( ) const
inline

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

Definition at line 112 of file AccessLogSettings.h.

◆ GetFormat()

const Aws::String& Aws::APIGateway::Model::AccessLogSettings::GetFormat ( ) const
inline

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

Definition at line 47 of file AccessLogSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::AccessLogSettings::Jsonize ( ) const

◆ operator=()

AccessLogSettings& Aws::APIGateway::Model::AccessLogSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDestinationArn() [1/3]

void Aws::APIGateway::Model::AccessLogSettings::SetDestinationArn ( const Aws::String value)
inline

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

Definition at line 128 of file AccessLogSettings.h.

◆ SetDestinationArn() [2/3]

void Aws::APIGateway::Model::AccessLogSettings::SetDestinationArn ( Aws::String &&  value)
inline

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

Definition at line 136 of file AccessLogSettings.h.

◆ SetDestinationArn() [3/3]

void Aws::APIGateway::Model::AccessLogSettings::SetDestinationArn ( const char *  value)
inline

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

Definition at line 144 of file AccessLogSettings.h.

◆ SetFormat() [1/3]

void Aws::APIGateway::Model::AccessLogSettings::SetFormat ( const Aws::String value)
inline

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

Definition at line 63 of file AccessLogSettings.h.

◆ SetFormat() [2/3]

void Aws::APIGateway::Model::AccessLogSettings::SetFormat ( Aws::String &&  value)
inline

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

Definition at line 71 of file AccessLogSettings.h.

◆ SetFormat() [3/3]

void Aws::APIGateway::Model::AccessLogSettings::SetFormat ( const char *  value)
inline

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

Definition at line 79 of file AccessLogSettings.h.

◆ WithDestinationArn() [1/3]

AccessLogSettings& Aws::APIGateway::Model::AccessLogSettings::WithDestinationArn ( const Aws::String value)
inline

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

Definition at line 152 of file AccessLogSettings.h.

◆ WithDestinationArn() [2/3]

AccessLogSettings& Aws::APIGateway::Model::AccessLogSettings::WithDestinationArn ( Aws::String &&  value)
inline

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

Definition at line 160 of file AccessLogSettings.h.

◆ WithDestinationArn() [3/3]

AccessLogSettings& Aws::APIGateway::Model::AccessLogSettings::WithDestinationArn ( const char *  value)
inline

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

Definition at line 168 of file AccessLogSettings.h.

◆ WithFormat() [1/3]

AccessLogSettings& Aws::APIGateway::Model::AccessLogSettings::WithFormat ( const Aws::String value)
inline

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

Definition at line 87 of file AccessLogSettings.h.

◆ WithFormat() [2/3]

AccessLogSettings& Aws::APIGateway::Model::AccessLogSettings::WithFormat ( Aws::String &&  value)
inline

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

Definition at line 95 of file AccessLogSettings.h.

◆ WithFormat() [3/3]

AccessLogSettings& Aws::APIGateway::Model::AccessLogSettings::WithFormat ( const char *  value)
inline

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

Definition at line 103 of file AccessLogSettings.h.


The documentation for this class was generated from the following file: