Package software.amazon.awscdk.mixins.preview.services.apigateway.mixins

Interface CfnDeploymentPropsMixin.AccessLogSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeploymentPropsMixin.AccessLogSettingProperty.Jsii$Proxy

Enclosing class:

CfnDeploymentPropsMixin

@Stability(Stable)
public static interface CfnDeploymentPropsMixin.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.mixins.preview.services.apigateway.mixins.*;
 AccessLogSettingProperty accessLogSettingProperty = AccessLogSettingProperty.builder()
         .destinationArn("destinationArn")
         .format("format")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

See Also:

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-format

builder

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

Returns:

a CfnDeploymentPropsMixin.AccessLogSettingProperty.Builder of CfnDeploymentPropsMixin.AccessLogSettingProperty