software.amazon.awsconstructs.services.apigatewaykinesisstreams

Interface ApiGatewayToKinesisStreamsProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ApiGatewayToKinesisStreamsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-03-01T13:38:18.395Z")
public interface ApiGatewayToKinesisStreamsProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApiGatewayToKinesisStreamsProps.Builder A builder for ApiGatewayToKinesisStreamsProps
static class	ApiGatewayToKinesisStreamsProps.Jsii$Proxy An implementation for ApiGatewayToKinesisStreamsProps

Method Summary

Modifier and Type	Method and Description
static ApiGatewayToKinesisStreamsProps.Builder	builder()
default software.amazon.awscdk.services.apigateway.RestApiProps	getApiGatewayProps() Optional user-provided props to override the default props for the API Gateway.
default Boolean	getCreateCloudWatchAlarms() Whether to create recommended CloudWatch alarms.
default software.amazon.awscdk.services.kinesis.Stream	getExistingStreamObj() Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.
default software.amazon.awscdk.services.kinesis.StreamProps	getKinesisStreamProps() Optional user-provided props to override the default props for the Kinesis Data Stream.
default software.amazon.awscdk.services.logs.LogGroupProps	getLogGroupProps() User provided props to override the default props for the CloudWatchLogs LogGroup.
default software.amazon.awscdk.services.apigateway.ModelOptions	getPutRecordRequestModel() API Gateway request model for the PutRecord action.
default String	getPutRecordRequestTemplate() API Gateway request template for the PutRecord action.
default software.amazon.awscdk.services.apigateway.ModelOptions	getPutRecordsRequestModel() API Gateway request model for the PutRecords action.
default String	getPutRecordsRequestTemplate() API Gateway request template for the PutRecords action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getApiGatewayProps

@Nullable
default software.amazon.awscdk.services.apigateway.RestApiProps getApiGatewayProps()

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

Default: - Default properties are used.

getCreateCloudWatchAlarms

@Nullable
default Boolean getCreateCloudWatchAlarms()

Whether to create recommended CloudWatch alarms.

Default: - Alarms are created

getExistingStreamObj

@Nullable
default software.amazon.awscdk.services.kinesis.Stream getExistingStreamObj()

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

Default: - None

getKinesisStreamProps

@Nullable
default software.amazon.awscdk.services.kinesis.StreamProps getKinesisStreamProps()

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

Default: - Default properties are used.

getLogGroupProps

@Nullable
default software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()

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

Default: - Default props are used

getPutRecordRequestModel

@Nullable
default software.amazon.awscdk.services.apigateway.ModelOptions getPutRecordRequestModel()

API Gateway request model for the PutRecord action.

If not provided, a default one will be created.

Default: - {"$schema":"http://json-schema.org/draft-04/schema#","title":"PutRecord proxy single-record payload","type":"object", "required":["data","partitionKey"],"properties":{"data":{"type":"string"},"partitionKey":{"type":"string"}}}

getPutRecordRequestTemplate

@Nullable
default String getPutRecordRequestTemplate()

API Gateway request template for the PutRecord action.

If not provided, a default one will be used.

Default: - { "StreamName": "${this.kinesisStream.streamName}", "Data": "$util.base64Encode($input.json('$.data'))", "PartitionKey": "$input.path('$.partitionKey')" }

getPutRecordsRequestModel

@Nullable
default software.amazon.awscdk.services.apigateway.ModelOptions getPutRecordsRequestModel()

API Gateway request model for the PutRecords action.

If not provided, a default one will be created.

Default: - {"$schema":"http://json-schema.org/draft-04/schema#","title":"PutRecords proxy payload data","type":"object","required":["records"], "properties":{"records":{"type":"array","items":{"type":"object", "required":["data","partitionKey"],"properties":{"data":{"type":"string"},"partitionKey":{"type":"string"}}}}}}

getPutRecordsRequestTemplate

@Nullable
default String getPutRecordsRequestTemplate()

API Gateway request template for the PutRecords action.

If not provided, a default one will be used.

Default: - { "StreamName": "${this.kinesisStream.streamName}", "Records": [ #foreach($elem in $input.path('$.records')) { "Data": "$util.base64Encode($elem.data)", "PartitionKey": "$elem.partitionKey"}#if($foreach.hasNext),#end #end ] }

builder

static ApiGatewayToKinesisStreamsProps.Builder builder()

Returns:

a ApiGatewayToKinesisStreamsProps.Builder of ApiGatewayToKinesisStreamsProps