kinesisfirehose-deliverystream :: outdated documentation
- Dominant language
- TypeScript
- Stars
- 12.9k
- Forks
- 4.6k
- Avg merge
- 2d 3h
- Merged PRs (30d)
- 83
Description
### 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_
Contributor guide
Research direction
Start with the ProcessorProperty#getType API documentation and the linked CloudFormation delivery stream specification. Confirm the currently supported processor types, then update the CDK documentation so it no longer lists only Lambda. Done means the generated Java documentation reflects the authoritative allowed values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, java, typescript
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100