feat(cloudfront-origins): allow setting a user defined origin id

[corymhall]

This PR adds the ability to set a custom user defined origin identifier. The default identifier that is generated is not very descriptive and some users would like the ability to define a custom identifier.

Since ids have to be unique per distribution, I also added validation that will throw an error if it is not.

fixes #2756

---

All Submissions:

• Have you followed the guidelines in our Contributing guide?

Adding new Unconventional Dependencies:

• This PR adds new unconventional dependencies following the process described here

New Features

• Have you added the new feature to an integration test?
  • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[gitpod-io]

[aws-cdk-automation]

The Pull Request Linter fails with the following errors:

❌ Features must contain a change to a README file.

PRs must pass status checks before we can provide a meaningful review.

Pull Request updated. Dissmissing previous PRLinter Review.

[aws-cdk-automation]

The Pull Request Linter fails with the following errors:

❌ Features must contain a change to a README file.

PRs must pass status checks before we can provide a meaningful review.

Pull Request updated. Dissmissing previous PRLinter Review.

[aws-cdk-automation]

The Pull Request Linter fails with the following errors:

❌ Features must contain a change to a README file.

PRs must pass status checks before we can provide a meaningful review.

[TheRealAmazonKendra]

@Mergifyio update

[mergify]

update

✅ Branch has been successfully updated

[TheRealAmazonKendra]

@corymhall why integ exempt?

[corymhall]

@corymhall why integ exempt?

Our integ tests already set the id to some value that we generate. This change allows the user to define a different id. I don't think there is any behavior to test in this case. We would be testing that when you set the id CloudFormation does the right thing, which is not something integ tests should test.

I also don't think this needs a README update, but let me know if you disagree.

✅ Updated pull request passes all PRLinter validations. Dissmissing previous PRLinter review.

[kaizencc]

Approved with dnm for one minor nit comment. Feel free to resolve however you want.

[kaizencc]

Is this necessary? originBindConfig.originProperty.id === originId under our implementation of OriginBase.bind().

I suppose someone could write their own CustomOrigin extends IOrigin and implement bind where the given originId does not become the originBindConfig.originProperty.id, but is that what we are defending against here?

If so... fine. But these will 99% of the time be the same value.

[corymhall]

They will be different if the user provides their own ID.

For example.

const origin = new S3Origin(bucket, { originId: 'MyCustomOrigin' });

When we then call bind on line 358 we pass in the generated originId (from line 357. The change I made in bind is to take the originId passed in S3Origin first. So originBindConfig.originProperty.id will be MyCustomOrigin.

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 8ca142d
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).