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

core: prefix all "DOM" (L1) CloudFormation classes with "Cfn" #1462

Closed
eladb opened this issue Jan 1, 2019 · 0 comments · Fixed by #1960 · May be fixed by MechanicalRock/account-reaper#6
Closed

core: prefix all "DOM" (L1) CloudFormation classes with "Cfn" #1462

eladb opened this issue Jan 1, 2019 · 0 comments · Fixed by #1960 · May be fixed by MechanicalRock/account-reaper#6
Labels
@aws-cdk/core Related to core CDK functionality effort/medium Medium work item – several days of effort pr/breaking-change This PR is a breaking change. It needs to be modified to be allowed in the current major version.

Comments

@eladb
Copy link
Contributor

eladb commented Jan 1, 2019

For consistency with L1 resources, let's add a prefix to all L1 classes that represent "pure" CloudFormation elements with the "Cfn" prefix: CfnResource, StackElement => CfnElement (#288), CfnParameter, CfnCondition, CfnOutput, etc.

Copy: @rix0rrr @RomainMuller

@eladb eladb added the pr/breaking-change This PR is a breaking change. It needs to be modified to be allowed in the current major version. label Jan 1, 2019
@rix0rrr rix0rrr added the effort/medium Medium work item – several days of effort label Feb 11, 2019
@eladb eladb added the @aws-cdk/core Related to core CDK functionality label Mar 4, 2019
@skinny85 skinny85 self-assigned this Mar 5, 2019
skinny85 added a commit that referenced this issue Mar 14, 2019
To better align with our L1 layer that is closely tied to CloudFormation, add the Cfn prefix to classes from the @aws-cdk/cdk package.

BREAKING CHANGE: rename Output to CfnOutput.
BREAKING CHANGE: rename Condition to CfnCondition.
BREAKING CHANGE: rename StackElement to CfnElement.
BREAKING CHANGE: rename Parameter to CfnParameter.
BREAKING CHANGE: rename Resource to CfnResource.
BREAKING CHANGE: rename Rule to CfnRule.
BREAKING CHANGE: rename Mapping to CfnMapping.
BREAKING CHANGE: rename Referenceable to CfnRefElement.
BREAKING CHANGE: rename IConditionExpression to ICfnConditionExpression.
BREAKING CHANGE: rename CfnReference to Reference.

Fixes #1462
Fixes #288
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/core Related to core CDK functionality effort/medium Medium work item – several days of effort pr/breaking-change This PR is a breaking change. It needs to be modified to be allowed in the current major version.
Projects
None yet
3 participants