aws-certificatemanager: DnsValidatedCertificate docs say that the default validation method is email

[plumdog]

Describe the issue

Documentation for the props forDnsValidatedCertificate say:

validation?

Type: CertificateValidation (optional, default: CertificateValidation.fromEmail())

How to validate this certificate.

which is obviously wrong, because its DNS validated.

I think this is just because interface DnsValidatedCertificateProps extends CertificateProps, and presumably this is a reasonable option in CertificateProps.

Solutions I can think of:

• use some Omit<> to remove validation from DnsValidatedCertificateProps
• set validation: never on DnsValidatedCertificateProps
• factor out some BaseCertificateProps from CertificateProps that doesn't include validation and have DnsValidatedCertificateProps extend that instead.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.DnsValidatedCertificate.html#validation

[peterwoodworth]

The documentation is generated from our codebase - the line which this is coming from is here

aws-cdk/packages/@aws-cdk/aws-certificatemanager/lib/certificate.ts

Line 77 in 4c11af6

* @default CertificateValidation.fromEmail()

As far as I can tell the validation prop isn't needed at all on DnsValidatedCertificate, it would be nice to not have props that do nothing. I think your third proposed solution would work well if it doesn't break anything 🙂

factor out some BaseCertificateProps from CertificateProps that doesn't include validation and have DnsValidatedCertificateProps extend that instead.

I am marking this issue as p2, which means that we are unable to work on this immediately.

We use +1s to help prioritize our work, and are happy to revaluate this issue based on community feedback. You can reach out to the cdk.dev community on Slack to solicit support for reprioritization.

Check out our contributing guide if you're interested in contributing yourself - there's a low chance the team will be able to address this soon but we'd be happy to review a PR 🙂

[plumdog]

@peterwoodworth have had a go at this in #22809

[madeline-k]

This has been addressed by #21982. Please open a new issue, if there is still documentation or features missing from the new construct: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager.Certificate.html

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.