software.amazon.awsconstructs.services.apigatewaykinesisstreams

Class ApiGatewayToKinesisStreamsProps.Builder

java.lang.Object

software.amazon.awsconstructs.services.apigatewaykinesisstreams.ApiGatewayToKinesisStreamsProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiGatewayToKinesisStreamsProps>

Enclosing interface:

ApiGatewayToKinesisStreamsProps

public static final class ApiGatewayToKinesisStreamsProps.Builder
extends Object
implements software.amazon.jsii.Builder<ApiGatewayToKinesisStreamsProps>

A builder for ApiGatewayToKinesisStreamsProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ApiGatewayToKinesisStreamsProps.Builder	apiGatewayProps(software.amazon.awscdk.services.apigateway.RestApiProps apiGatewayProps) Sets the value of ApiGatewayToKinesisStreamsProps.getApiGatewayProps()
ApiGatewayToKinesisStreamsProps	build() Builds the configured instance.
ApiGatewayToKinesisStreamsProps.Builder	createCloudWatchAlarms(Boolean createCloudWatchAlarms) Sets the value of ApiGatewayToKinesisStreamsProps.getCreateCloudWatchAlarms()
ApiGatewayToKinesisStreamsProps.Builder	existingStreamObj(software.amazon.awscdk.services.kinesis.Stream existingStreamObj) Sets the value of ApiGatewayToKinesisStreamsProps.getExistingStreamObj()
ApiGatewayToKinesisStreamsProps.Builder	kinesisStreamProps(software.amazon.awscdk.services.kinesis.StreamProps kinesisStreamProps) Sets the value of ApiGatewayToKinesisStreamsProps.getKinesisStreamProps()
ApiGatewayToKinesisStreamsProps.Builder	logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps) Sets the value of ApiGatewayToKinesisStreamsProps.getLogGroupProps()
ApiGatewayToKinesisStreamsProps.Builder	putRecordRequestModel(software.amazon.awscdk.services.apigateway.ModelOptions putRecordRequestModel) Sets the value of ApiGatewayToKinesisStreamsProps.getPutRecordRequestModel()
ApiGatewayToKinesisStreamsProps.Builder	putRecordRequestTemplate(String putRecordRequestTemplate) Sets the value of ApiGatewayToKinesisStreamsProps.getPutRecordRequestTemplate()
ApiGatewayToKinesisStreamsProps.Builder	putRecordsRequestModel(software.amazon.awscdk.services.apigateway.ModelOptions putRecordsRequestModel) Sets the value of ApiGatewayToKinesisStreamsProps.getPutRecordsRequestModel()
ApiGatewayToKinesisStreamsProps.Builder	putRecordsRequestTemplate(String putRecordsRequestTemplate) Sets the value of ApiGatewayToKinesisStreamsProps.getPutRecordsRequestTemplate()

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

apiGatewayProps

public ApiGatewayToKinesisStreamsProps.Builder apiGatewayProps(software.amazon.awscdk.services.apigateway.RestApiProps apiGatewayProps)

Sets the value of ApiGatewayToKinesisStreamsProps.getApiGatewayProps()

Parameters:

apiGatewayProps - Optional user-provided props to override the default props for the API Gateway.

Returns:

this

createCloudWatchAlarms

public ApiGatewayToKinesisStreamsProps.Builder createCloudWatchAlarms(Boolean createCloudWatchAlarms)

Sets the value of ApiGatewayToKinesisStreamsProps.getCreateCloudWatchAlarms()

Parameters:

createCloudWatchAlarms - Whether to create recommended CloudWatch alarms.

Returns:

this

existingStreamObj

public ApiGatewayToKinesisStreamsProps.Builder existingStreamObj(software.amazon.awscdk.services.kinesis.Stream existingStreamObj)

Sets the value of ApiGatewayToKinesisStreamsProps.getExistingStreamObj()

Parameters:

existingStreamObj - Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.

Returns:

this

kinesisStreamProps

public ApiGatewayToKinesisStreamsProps.Builder kinesisStreamProps(software.amazon.awscdk.services.kinesis.StreamProps kinesisStreamProps)

Sets the value of ApiGatewayToKinesisStreamsProps.getKinesisStreamProps()

Parameters:

kinesisStreamProps - Optional user-provided props to override the default props for the Kinesis Data Stream.

Returns:

this

logGroupProps

public ApiGatewayToKinesisStreamsProps.Builder logGroupProps(software.amazon.awscdk.services.logs.LogGroupProps logGroupProps)

Sets the value of ApiGatewayToKinesisStreamsProps.getLogGroupProps()

Parameters:

logGroupProps - User provided props to override the default props for the CloudWatchLogs LogGroup.

Returns:

this

putRecordRequestModel

public ApiGatewayToKinesisStreamsProps.Builder putRecordRequestModel(software.amazon.awscdk.services.apigateway.ModelOptions putRecordRequestModel)

Sets the value of ApiGatewayToKinesisStreamsProps.getPutRecordRequestModel()

Parameters:

putRecordRequestModel - API Gateway request model for the PutRecord action. If not provided, a default one will be created.

Returns:

this

putRecordRequestTemplate

public ApiGatewayToKinesisStreamsProps.Builder putRecordRequestTemplate(String putRecordRequestTemplate)

Sets the value of ApiGatewayToKinesisStreamsProps.getPutRecordRequestTemplate()

Parameters:

putRecordRequestTemplate - API Gateway request template for the PutRecord action. If not provided, a default one will be used.

Returns:

this

putRecordsRequestModel

public ApiGatewayToKinesisStreamsProps.Builder putRecordsRequestModel(software.amazon.awscdk.services.apigateway.ModelOptions putRecordsRequestModel)

Sets the value of ApiGatewayToKinesisStreamsProps.getPutRecordsRequestModel()

Parameters:

putRecordsRequestModel - API Gateway request model for the PutRecords action. If not provided, a default one will be created.

Returns:

this

putRecordsRequestTemplate

public ApiGatewayToKinesisStreamsProps.Builder putRecordsRequestTemplate(String putRecordsRequestTemplate)

Sets the value of ApiGatewayToKinesisStreamsProps.getPutRecordsRequestTemplate()

Parameters:

putRecordsRequestTemplate - API Gateway request template for the PutRecords action. If not provided, a default one will be used.

Returns:

this

build

public ApiGatewayToKinesisStreamsProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ApiGatewayToKinesisStreamsProps>

Returns:

a new instance of ApiGatewayToKinesisStreamsProps

Throws:

NullPointerException - if any required attribute was not provided