feat(cloudfront): distribution ARN property by nmussy · Pull Request #32531 · aws/aws-cdk

nmussy · 2024-12-15T18:41:59Z

Issue # (if applicable)

Closes #32530

Reason for this change

Give the user access to a distribution's ARN via the existing distributionId value.

Description of changes

Implemented by proxying the existing formatDistributionArn function via a getter method.

Description of how you validated changes

Unit tests were added for both created and imported distributions.

Additionally, missing coverage for Distribution.fromDistributionAttributes was added, by copying the existing unit test for CloudFrontWebDistribution.fromDistributionAttributes.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

nmussy · 2024-12-15T18:50:02Z

Exemption Request:

A unit test should be sufficient, given there is no real added feature, just a getter method that uses an already relied upon function.
The generated documentation should also be sufficient, adding an example on how to access a property would add needless noise

codecov · 2024-12-15T18:55:03Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.80%. Comparing base (d1bb1ca) to head (0833411).

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #32531   +/-   ##
=======================================
  Coverage   78.80%   78.80%           
=======================================
  Files         108      108           
  Lines        7159     7159           
  Branches     1319     1319           
=======================================
  Hits         5642     5642           
  Misses       1332     1332           
  Partials      185      185

Flag	Coverage Δ
suite.unit	`78.80% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`78.80% <ø> (ø)`

tmokmss

Nice, thanks! 😄

tmokmss · 2024-12-16T06:42:57Z

I found a typo in the PR title btw (cloudfornt)

nmussy · 2024-12-16T06:54:45Z

I found a typo in the PR title btw (cloudfornt)

Whoops, thanks. I thought the PR linter checked for existing packages?

EDIT: Must have confused it with this rule:

aws-cdk/tools/@aws-cdk/prlint/lint.ts

Lines 720 to 742 in bf026bd

    
           /** 
        
            * Check that the PR title uses the typical convention for package names. 
        
            * 
        
            * For example, "fix(s3)" is preferred over "fix(aws-s3)". 
        
            */ 
        
           function validateTitleScope(pr: GitHubPr): TestResult { 
        
             const result = new TestResult(); 
        
             const scopesExemptFromThisRule = ['aws-cdk-lib']; 
        
             // Specific commit types are handled by `validateTitlePrefix`. This just checks whether 
        
             // the scope includes an `aws-` prefix or not. 
        
             // Group 1: Scope with parens - "(aws-<name>)" 
        
             // Group 2: Scope name - "aws-<name>" 
        
             // Group 3: Preferred scope name - "<name>" 
        
             const titleRe = /^\w+(\((aws-([\w_-]+))\))?: /; 
        
             const m = titleRe.exec(pr.title); 
        
             if (m && !scopesExemptFromThisRule.includes(m[2])) { 
        
               result.assessFailure( 
        
                 !!(m[2] && m[3]), 
        
                 `The title of the pull request should omit 'aws-' from the name of modified packages. Use '${m[3]}' instead of '${m[2]}'.`, 
        
               ); 
        
             } 
        
             return result; 
        
           }

godwingrs22

LGTM. Thanks @nmussy for the contribution.

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

mergify · 2024-12-16T20:52:52Z

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 · 2024-12-16T21:25:11Z

AWS CodeBuild CI Report

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

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

mergify · 2024-12-16T21:25:14Z

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).

github-actions · 2024-12-16T21:25:27Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

feat(cloudfornt): distribution ARN property

13ceeed

github-actions bot added feature-request A feature should be added or improved. p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Dec 15, 2024

aws-cdk-automation requested a review from a team December 15, 2024 18:43

aws-cdk-automation previously requested changes Dec 15, 2024

View reviewed changes

aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Dec 15, 2024

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Dec 15, 2024

tmokmss approved these changes Dec 16, 2024

View reviewed changes

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Dec 16, 2024

nmussy changed the title ~~feat(cloudfornt): distribution ARN property~~ feat(cloudfront): distribution ARN property Dec 16, 2024

ashishdhingra mentioned this pull request Dec 16, 2024

cloudfront: expose ARN for Distribution #32530

Closed

2 tasks

godwingrs22 self-assigned this Dec 16, 2024

godwingrs22 self-requested a review December 16, 2024 20:29

godwingrs22 removed their assignment Dec 16, 2024

godwingrs22 approved these changes Dec 16, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 16, 2024

godwingrs22 added pr-linter/exempt-integ-test The PR linter will not require integ test changes pr-linter/exempt-readme The PR linter will not require README changes labels Dec 16, 2024

Merge branch 'main' into feat-cloudfront-distribution-arn-prop

0833411

mergify bot merged commit b7e6141 into aws:main Dec 16, 2024

github-actions bot locked as resolved and limited conversation to collaborators Dec 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cloudfront): distribution ARN property#32531

feat(cloudfront): distribution ARN property#32531
mergify[bot] merged 2 commits intoaws:mainfrom
nmussy:feat-cloudfront-distribution-arn-prop

nmussy commented Dec 15, 2024

Uh oh!

aws-cdk-automation left a comment

Uh oh!

nmussy commented Dec 15, 2024

Uh oh!

codecov bot commented Dec 15, 2024 •

edited

Loading

Uh oh!

tmokmss left a comment

Uh oh!

tmokmss commented Dec 16, 2024

Uh oh!

nmussy commented Dec 16, 2024 •

edited

Loading

Uh oh!

godwingrs22 left a comment

Uh oh!

mergify bot commented Dec 16, 2024

Uh oh!

aws-cdk-automation commented Dec 16, 2024

Uh oh!

mergify bot commented Dec 16, 2024

Uh oh!

github-actions bot commented Dec 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

nmussy commented Dec 15, 2024

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Uh oh!

nmussy commented Dec 15, 2024

Uh oh!

codecov bot commented Dec 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tmokmss left a comment

Choose a reason for hiding this comment

Uh oh!

tmokmss commented Dec 16, 2024

Uh oh!

nmussy commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

godwingrs22 left a comment

Choose a reason for hiding this comment

Uh oh!

mergify bot commented Dec 16, 2024

Uh oh!

aws-cdk-automation commented Dec 16, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Dec 16, 2024

Uh oh!

github-actions bot commented Dec 16, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov bot commented Dec 15, 2024 •

edited

Loading

nmussy commented Dec 16, 2024 •

edited

Loading