software.amazon.awscdk.services.apigateway

Interface CfnDeployment.AccessLogSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeployment.AccessLogSettingProperty.Jsii$Proxy

Enclosing class:

CfnDeployment

@Stability(value=Stable)
public static interface CfnDeployment.AccessLogSettingProperty
extends software.amazon.jsii.JsiiSerializable

The `AccessLogSetting` property type specifies settings for logging access in this stage.

AccessLogSetting is a property of the StageDescription property type.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 AccessLogSettingProperty accessLogSettingProperty = AccessLogSettingProperty.builder()
         .destinationArn("destinationArn")
         .format("format")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDeployment.AccessLogSettingProperty.Builder A builder for CfnDeployment.AccessLogSettingProperty
static class	CfnDeployment.AccessLogSettingProperty.Jsii$Proxy An implementation for CfnDeployment.AccessLogSettingProperty

Method Summary

Modifier and Type	Method and Description
static CfnDeployment.AccessLogSettingProperty.Builder	builder()
default String	getDestinationArn() The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.
default String	getFormat() A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference) .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDestinationArn

@Stability(value=Stable)
 @Nullable
default String getDestinationArn()

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

getFormat

@Stability(value=Stable)
 @Nullable
default String getFormat()

A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference) . The format must include at least `$context.requestId` .

builder

@Stability(value=Stable)
static CfnDeployment.AccessLogSettingProperty.Builder builder()

Returns:

a CfnDeployment.AccessLogSettingProperty.Builder of CfnDeployment.AccessLogSettingProperty