feat(assertions): added getResourceId method to Template

[vdahlberg]

Reason for this change

Sometimes you want to correlate how cloudformation resources correlate to each other.
CDK synthesizes the template expectedly with Ref and Fn:GetAtt.

Currently you'll have to do something like this to verify that a bucketpolicy is attached to the correct bucket:

const resources = template.findResources('AWS::S3::Bucket', {
  Properties: {
    BucketName: 'my-bucket',
  }
})

const keys = Object.keys(resources)
if (keys.length === 0) {
    throw new Error('Resource not found.')
}
if (keys.length !== 1) {
    throw new Error('Resource is not unique.')
}
const bucket = keys[0]

template.hasResourceProperties('AWS::S3::BucketPolicy', {
  Bucket: {
    Ref: bucket,
  },
 // ....
})

Description of changes

Added method getResourceId on Template to retrieve a distinct match's resource id.

// throws AssertionError on none or multiple matches
const bucket = template.getResourceId('AWS::S3::Bucket', {
  Properties: {
    BucketName: 'my-bucket',
  }
})

template.hasResourceProperties('AWS::S3::BucketPolicy', {
  Bucket: {
    Ref: bucket,
  },
  // ....
})

Description of how you validated changes

Unit tests. Integration tests not applicable.

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]

(This review is outdated)

[aws-cdk-automation]

AWS CodeBuild CI Report

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

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

[vdahlberg]

Exemption Request

Only changes in assertions module

[GavinZZ]

Amazing, thank you!

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

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

[mergify]

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue