interface AccessLogSettingsProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.ApiGatewayV2.Mixins.CfnStagePropsMixin.AccessLogSettingsProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigatewayv2/mixins#CfnStagePropsMixin_AccessLogSettingsProperty
Java	software.amazon.awscdk.mixins.preview.services.apigatewayv2.mixins.CfnStagePropsMixin.AccessLogSettingsProperty
Python	aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnStagePropsMixin.AccessLogSettingsProperty
TypeScript	@aws-cdk/mixins-preview » aws_apigatewayv2 » mixins » CfnStagePropsMixin » AccessLogSettingsProperty

Settings for logging access in a stage.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apigatewayv2_mixins } from '@aws-cdk/mixins-preview/aws-apigatewayv2';
const accessLogSettingsProperty: apigatewayv2_mixins.CfnStagePropsMixin.AccessLogSettingsProperty = {
  destinationArn: 'destinationArn',
  format: 'format',
};

Properties

Name	Type	Description
destinationArn?	string	The ARN of the CloudWatch Logs log group to receive access logs.
format?	string	A single line format of the access logs of data, as specified by selected $context variables.

---

destinationArn?

Type: string (optional)

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

---

format?

Type: string (optional)

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