software.amazon.awscdk.services.apigateway

Class CfnStage.AccessLogSettingProperty.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnStage.AccessLogSettingProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStage.AccessLogSettingProperty>

Enclosing interface:

CfnStage.AccessLogSettingProperty

@Stability(value=Stable)
public static final class CfnStage.AccessLogSettingProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStage.AccessLogSettingProperty>

A builder for CfnStage.AccessLogSettingProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnStage.AccessLogSettingProperty	build() Builds the configured instance.
CfnStage.AccessLogSettingProperty.Builder	destinationArn(String destinationArn) Sets the value of CfnStage.AccessLogSettingProperty.getDestinationArn()
CfnStage.AccessLogSettingProperty.Builder	format(String format) Sets the value of CfnStage.AccessLogSettingProperty.getFormat()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

destinationArn

@Stability(value=Stable)
public CfnStage.AccessLogSettingProperty.Builder destinationArn(String destinationArn)

Sets the value of CfnStage.AccessLogSettingProperty.getDestinationArn()

Parameters:

destinationArn - 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.

Returns:

this

format

@Stability(value=Stable)
public CfnStage.AccessLogSettingProperty.Builder format(String format)

Sets the value of CfnStage.AccessLogSettingProperty.getFormat()

Parameters:

format - A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference) . The format must include at least `$context.requestId` . This parameter is required to enable access logging.

Returns:

this

build

@Stability(value=Stable)
public CfnStage.AccessLogSettingProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnStage.AccessLogSettingProperty>

Returns:

a new instance of CfnStage.AccessLogSettingProperty

Throws:

NullPointerException - if any required attribute was not provided