Interface CfnStage.AccessLogSettingProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnStage.AccessLogSettingProperty extends
The AccessLogSetting property type specifies settings for logging access in this stage.

AccessLogSetting is a property of the AWS::ApiGateway::Stage resource.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 AccessLogSettingProperty accessLogSettingProperty = AccessLogSettingProperty.builder()
  • 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- . This parameter is required to enable access logging.

    • 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 . This parameter is required to enable access logging.
    • builder

      @Stability(Stable) static CfnStage.AccessLogSettingProperty.Builder builder()
      a CfnStage.AccessLogSettingProperty.Builder of CfnStage.AccessLogSettingProperty