Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): overrideLogicalId: override IDs of CFN elements #1670

Merged
merged 22 commits into from
Feb 6, 2019

Conversation

eladb
Copy link
Contributor

@eladb eladb commented Feb 4, 2019

Allow users to explicitly override the logical ID of a CloudFormation
element (such as "Cfn" resources) by invoking overrideLogicalId
on the resource object.

For example:

const bucket = new s3.CfnBucket(this, 'MyBucket');
bucket.overrideLogicalId('YourBucket');

The resulting template will use YourBucket as the logical ID.

NOTE: the logicalId property will now return a stringified token
instead of a concrete value.

Fixes #1594


Pull Request Checklist

  • Testing
    • Unit test added
    • CLI change?: coordinate update of integration tests with team
    • cdk-init template change?: coordinated update of integration tests with team
  • Docs
    • jsdocs: All public APIs documented
    • README: README and/or documentation topic updated
  • Title and Description
    • Change type: title prefixed with fix, feat will appear in changelog
    • Title: use lower-case and doesn't end with a period
    • Breaking?: last paragraph: "BREAKING CHANGE: <describe what changed + link for details>"
    • Issues: Indicate issues fixed via: "Fixes #xxx" or "Closes #xxx"
  • Sensitive Modules (requires 2 PR approvers)
    • IAM Policy Document (in @aws-cdk/aws-iam)
    • EC2 Security Groups and ACLs (in @aws-cdk/aws-ec2)
    • Grant APIs (only if not based on official documentation with a reference)

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

Allow users to explicitly override the logical ID of a CloudFormation
element (such as "Cfn" resources) by invoking `overrideLogicalId`
on the resource object.

For example:

    const bucket = new s3.CfnBucket(this, 'MyBucket');
    bucket.overrideLogicalId('YourBucket');

The resulting template will use `YourBucket` as the logical ID.

NOTE: the `logicalId` property will now return a stringified token
instead of a concrete value.

Fixes #1594
@eladb eladb requested a review from rix0rrr February 4, 2019 21:48
@eladb eladb requested a review from a team as a code owner February 4, 2019 21:48
@eladb
Copy link
Contributor Author

eladb commented Feb 4, 2019

@Doug-AWS we should update the escape hatch topic to reflect this (instead of renames)

Elad Ben-Israel added 3 commits February 5, 2019 01:09
There is no good reason to be strict about token display names.
We can just replace any disallowed chars with "." and get it over with.
@@ -197,7 +201,7 @@ export class Resource extends Referenceable {
Type: this.resourceType,
Properties: ignoreEmpty(this, properties),
// Return a sorted set of dependencies to be consistent across tests
DependsOn: ignoreEmpty(this, sortedSet(this.dependsOn)),
DependsOn: ignoreEmpty(this, sortedSet(this.dependsOn).map(r => r.logicalId)),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The behavior of sortedSet(this.dependsOn) will be different now that it is a Set<Resource>.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will actually be fine, because it will be sorted by the token, which is good enough for our purposes, no?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The goal is to get dependencies into a stable order for purposes of comparisons.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So the tokens are okay for that purpose

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, you're doing sort(Resource) THEN map to ID.

So the sort order is not based on the token strings, but on opaque objects. No idea how JavaScript will sort those.

If anything, you should have done sort(resource.map(r => r.id))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

got it, you are right

@eladb eladb requested a review from skinny85 as a code owner February 5, 2019 14:49
@eladb eladb requested a review from SoManyHs as a code owner February 6, 2019 13:20
@eladb eladb merged commit 823a1e8 into master Feb 6, 2019
@eladb eladb deleted the benisrae/override-logical-id branch February 6, 2019 14:41
@NGL321 NGL321 added the contribution/core This is a PR that came from AWS. label Sep 23, 2019
@mergify
Copy link
Contributor

mergify bot commented Sep 23, 2019

Thanks so much for taking the time to contribute to the AWS CDK ❤️

We will shortly assign someone to review this pull request and help get it
merged. In the meantime, please take a minute to make sure you follow this
checklist
:

  • PR title type(scope): text
    • type: fix, feat, refactor go into CHANGELOG, chore is hidden
    • scope: name of module without aws- or cdk- prefix or postfix (e.g. s3 instead of aws-s3-deployment)
    • text: use all lower-case, do not end with a period, do not include issue refs
  • PR Description
    • Rationale: describe rationale of change and approach taken
    • Issues: indicate issues fixed via: fixes #xxx or closes #xxx
    • Breaking?: last paragraph: BREAKING CHANGE: <describe what changed + link for details>
  • Testing
    • Unit test added. Prefer to add a new test rather than modify existing tests
    • CLI or init templates change? Re-run/add CLI integration tests
  • Documentation
    • README: update module README to describe new features
    • API docs: public APIs must be documented. Copy from official AWS docs when possible
    • Design: for significant features, follow design process

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make it easier to explicitly control logical IDs
5 participants