Package software.amazon.awscdk.services.apigateway

Interface CfnStage.AccessLogSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStage.AccessLogSettingProperty.Jsii$Proxy

Enclosing class:

CfnStage

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

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

AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStage.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 .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationArn

@Stability(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- . This parameter is required to enable access logging.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-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-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-format

builder

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

Returns:

a CfnStage.AccessLogSettingProperty.Builder of CfnStage.AccessLogSettingProperty