interface AccessLogSettingProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins.CfnDeploymentPropsMixin.AccessLogSettingProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapigateway/mixins#CfnDeploymentPropsMixin_AccessLogSettingProperty |
 Java | software.amazon.awscdk.mixins.preview.services.apigateway.mixins.CfnDeploymentPropsMixin.AccessLogSettingProperty |
 Python | aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDeploymentPropsMixin.AccessLogSettingProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_apigateway » mixins » CfnDeploymentPropsMixin » AccessLogSettingProperty |
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 { mixins as apigateway_mixins } from '@aws-cdk/mixins-preview/aws-apigateway';
const accessLogSettingProperty: apigateway_mixins.CfnDeploymentPropsMixin.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. |
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- .
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 .