kinesisfirehose-deliverystream :: outdated documentation

[ttais2017]

Describe the bug

Taken from: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-s3destinationconfiguration.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration-compressionformat

The cdk api-documentation does not show the current state of cloud formation params. Currently the documentation shows that the configuration param (processor type) in delivery stream has only one value possible : "Lambda"

Expected Behavior

ParameterName
The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds. The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.

Required: Yes

Type: String

Allowed values: BufferIntervalInSeconds | BufferSizeInMBs | Delimiter | JsonParsingEngine | LambdaArn | MetadataExtractionQuery | NumberOfRetries | RoleArn | SubRecordType

Current Behavior

`
/**
* Sets the value of {@link ProcessorProperty#getType}
* @param type The type of processor. This parameter is required.
* Valid values: Lambda .
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder type(java.lang.String type) {
this.type = type;
return this;
}

`

Reproduction Steps

.

Possible Solution

pls fix the documentation

Additional Information/Context

No response

CDK CLI Version

aws-cli/2.11.14 Python/3.11.3 Windows/10 exe/AMD64 prompt/off

Framework Version

No response

Node.js Version

9.5.1

OS

Windows

Language

Java

Language Version

No response

Other information

No response

[pahud]

I am afraid the doc link you provided is incorrect. Are you mentioning the ParameterName?

As I can't find the error in the doc, would you please show me the link where you see the error?

[ttais2017]

Hi,
I'm so sorry. I copied the wrong link.
Here the info what I meant:

https://docs.aws.amazon.com/firehose/latest/APIReference/API_ProcessorParameter.html

where,

Valid Values are also: LambdaArn | NumberOfRetries | MetadataExtractionQuery | JsonParsingEngine | RoleArn | BufferSizeInMBs | BufferIntervalInSeconds | SubRecordType | Delimiter

und here a screen-shot of the wrong Javadoc:

Kind Regads,

[msambol]

@ttais2017 / @pahud I did research on this. The Kinesis Firehose API docs have the following for valid values:

• [1] Processor Type: RecordDeAggregation | Lambda | MetadataExtraction | AppendDelimiterToRecord
• [2] ProcessorParameter ParameterName: BufferIntervalInSeconds | BufferSizeInMBs | Delimiter | JsonParsingEngine | LambdaArn | MetadataExtractionQuery | NumberOfRetries | RoleArn | SubRecordType

I think the issue is in the CFN docs [3] resulting in wrong information in this file. The CFN docs have both The type of processor. Valid values: Lambda. and Allowed values: AppendDelimiterToRecord | Lambda | MetadataExtraction | RecordDeAggregation for the Processor Type property (# 1 above).

@pahud It looks like cfn-docs.json is automatically updated? I submitted a feedback request for the CFN docs in [3].

[1] https://docs.aws.amazon.com/firehose/latest/APIReference/API_Processor.html
[2] https://docs.aws.amazon.com/firehose/latest/APIReference/API_ProcessorParameter.html
[3] https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-processor.html#aws-properties-kinesisfirehose-deliverystream-processor-properties