aws-cdk-lib.aws_apigateway.CfnDeployment.AccessLogSettingProperty

interface AccessLogSettingProperty

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.CfnDeployment.AccessLogSettingProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDeployment_AccessLogSettingProperty
Javasoftware.amazon.awscdk.services.apigateway.CfnDeployment.AccessLogSettingProperty
Pythonaws_cdk.aws_apigateway.CfnDeployment.AccessLogSettingProperty
TypeScript aws-cdk-lib » aws_apigateway » CfnDeployment » 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 { aws_apigateway as apigateway } from 'aws-cdk-lib';
const accessLogSettingProperty: apigateway.CfnDeployment.AccessLogSettingProperty = {
  destinationArn: 'destinationArn',
  format: 'format',
};

Properties

NameTypeDescription
destinationArn?stringThe Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs.
format?stringA 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 .