interface AccessLogSettingProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.APIGateway.CfnStage.AccessLogSettingProperty |
 Java | software.amazon.awscdk.services.apigateway.CfnStage.AccessLogSettingProperty |
 Python | aws_cdk.aws_apigateway.CfnStage.AccessLogSettingProperty |
 TypeScript | @aws-cdk/aws-apigateway » CfnStage » AccessLogSettingProperty |
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 * as apigateway from '@aws-cdk/aws-apigateway';
const accessLogSettingProperty: apigateway.CfnStage.AccessLogSettingProperty = {
destinationArn: 'destinationArn',
format: 'format',
};
Properties
| Name | Type | Description |
|---|---|---|
| destination | string | The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. |
| format? | string | 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. |
destinationArn?
Type:
string
(optional)
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.
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.