aws / aws-cdk

The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
https://aws.amazon.com/cdk
Apache License 2.0
11.37k stars 3.77k forks source link

(docs) ImageBuilder docs don't provide schema for distribution configurations #20148

Open ghost opened 2 years ago

ghost commented 2 years ago

Describe the issue

The docs for amiDistributionConfiguration and the containerDistributionConfiguration properties reference an example schema on the same page. (It says below, but it's actually above, though that's incidental.) However the schemas for these properties are not documented in that example.

I believe that what's wanted is CfnDistributionConfiguration but this is not clear at all from the example code.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_imagebuilder.CfnDistributionConfiguration.DistributionProperty.html#amidistributionconfiguration

skinny85 commented 2 years ago

I believe this text actually comes straight from the CloudFormation docs about these properties (example: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-containerdistributionconfiguration), which we copy verbatim to our generated L1 resources.

Given that, I doubt there's much we can do here.

peterwoodworth commented 2 years ago

Could patch this out potentially? Doubt it will change in Cfn docs given they have an actual example to go with the description