Package 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.94.0 (build b380f01)", date="2024-01-09T15:59:33.124Z") public interface ApiGatewayToKinesisStreamsProps extends software.amazon.jsii.JsiiSerializable

  • Method Details

    • getAdditionalPutRecordRequestTemplates

      @Nullable default Map<String,String> getAdditionalPutRecordRequestTemplates()
      Optional PutRecord Request Templates for content-types other than application/json.

      Use the putRecordRequestTemplate property to set the request template for the application/json content-type.

      Default: - None

    • getAdditionalPutRecordsRequestTemplates

      @Nullable default Map<String,String> getAdditionalPutRecordsRequestTemplates()
      Optional PutRecords Request Templates for content-types other than application/json.

      Use the putRecordsRequestTemplate property to set the request template for the application/json content-type.

      Default: - None

    • 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

    • getPutRecordIntegrationResponses

      @Nullable default List<software.amazon.awscdk.services.apigateway.IntegrationResponse> getPutRecordIntegrationResponses()
      Optional, custom API Gateway Integration Response for the PutRecord action.

      Default: - [{statusCode:"200"},{statusCode:"500",responseTemplates:{"text/html":"Error"},selectionPattern:"500"}]

    • 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')" }

    • getPutRecordsIntegrationResponses

      @Nullable default List<software.amazon.awscdk.services.apigateway.IntegrationResponse> getPutRecordsIntegrationResponses()
      Optional, custom API Gateway Integration Response for the PutRecord action.

      Default: - [{statusCode:"200"},{statusCode:"500",responseTemplates:{"text/html":"Error"},selectionPattern:"500"}]

    • 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 for the default application/json content-type.

      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