Package software.amazon.awscdk.services.apigatewayv2

Interface CfnStage.AccessLogSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStage.AccessLogSettingsProperty.Jsii$Proxy

Enclosing class:

CfnStage

@Stability(Stable)
public static interface CfnStage.AccessLogSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Settings for logging access in a stage.

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.apigatewayv2.*;
 AccessLogSettingsProperty accessLogSettingsProperty = AccessLogSettingsProperty.builder()
         .destinationArn("destinationArn")
         .format("format")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStage.AccessLogSettingsProperty.Builder	A builder for CfnStage.AccessLogSettingsProperty
static final class	CfnStage.AccessLogSettingsProperty.Jsii$Proxy	An implementation for CfnStage.AccessLogSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnStage.AccessLogSettingsProperty.Builder	builder()
default String	getDestinationArn()	The ARN of the CloudWatch Logs log group to receive access logs.
default String	getFormat()	A single line format of the access logs of data, as specified by selected $context variables.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationArn

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

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

This parameter is required to enable access logging.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-destinationarn

getFormat

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

A single line format of the access logs of data, as specified by selected $context variables.

The format must include at least $context.requestId. This parameter is required to enable access logging.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-format

builder

@Stability(Stable)
static CfnStage.AccessLogSettingsProperty.Builder builder()

Returns:

a CfnStage.AccessLogSettingsProperty.Builder of CfnStage.AccessLogSettingsProperty