@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)", date="2021-11-28T01:16:28.120Z") public interface ApiGatewayToKinesisStreamsProps extends software.amazon.jsii.JsiiSerializable
| Modifier and Type | Interface and Description |
|---|---|
static class |
ApiGatewayToKinesisStreamsProps.Builder
A builder for
ApiGatewayToKinesisStreamsProps |
static class |
ApiGatewayToKinesisStreamsProps.Jsii$Proxy
An implementation for
ApiGatewayToKinesisStreamsProps |
| 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.
|
@Nullable default software.amazon.awscdk.services.apigateway.RestApiProps getApiGatewayProps()
Default: - Default properties are used.
@Nullable default Boolean getCreateCloudWatchAlarms()
Default: - Alarms are created
@Nullable default software.amazon.awscdk.services.kinesis.Stream getExistingStreamObj()
Default: - None
@Nullable default software.amazon.awscdk.services.kinesis.StreamProps getKinesisStreamProps()
Default: - Default properties are used.
@Nullable default software.amazon.awscdk.services.logs.LogGroupProps getLogGroupProps()
Default: - Default props are used
@Nullable default software.amazon.awscdk.services.apigateway.ModelOptions getPutRecordRequestModel()
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"}}}
@Nullable default String getPutRecordRequestTemplate()
If not provided, a default one will be used.
Default: - { "StreamName": "${this.kinesisStream.streamName}", "Data": "$util.base64Encode($input.json('$.data'))", "PartitionKey": "$input.path('$.partitionKey')" }
@Nullable default software.amazon.awscdk.services.apigateway.ModelOptions getPutRecordsRequestModel()
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"}}}}}}
@Nullable default String getPutRecordsRequestTemplate()
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 ] }
static ApiGatewayToKinesisStreamsProps.Builder builder()
Copyright © 2021. All rights reserved.