-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
refactor(core): additional api cleanups #2972
Conversation
Additional minor API cleanups in the core module (see breaking changes list). Updated physical names linter rule to verify that physical name property name is `cfnTypeName` and that it's type is either `PhysicalName` in case the name is optional and `string` if the name is required (fixes #2971). Moved all internal files in @aws-cdk/cdk under "private" BREAKING CHANGE: The deprecated `app.run()` has been removed (use `app.synth()`). * **core:** `CfnElement.refAsString` renamed to `ref` of `string` type. The `IResolvable` version have been removed. * **core:** `Resource.physicalName` is now a `string` instead of `PhysicalName`. If a physical name should be generated during deployment (i.e. not supplied to L1), the string will synthesize to `undefined`. * **core:** `IStringValue` renamed to `IStringProducer` * **core:** `Include` renamed to `CfnInclude` * **core:** `Cfn` prefix was added to the following types: `CfnCreationPolicy`, `CfnResourceAutoScalingCreationPolicy`, `CfnResourceAutoScalingCreationPolicy`, `CfnDeletionPolicy`, `CfnUpdatePolicy`, `CfnAutoScalingRollingUpdate`, `CfnAutoScalingReplacingUpdate`, `CfnAutoScalingScheduledAction`, `CfnCodeDeployLambdaAliasUpdate`, `CfnTag` `CfnRuleAssertion`, `CfnDynamicReferenceProps` * **core:** `deepMerge` is no longer exported. * **core:** `CfnOutputProps.export` was renamed to `exportName`. * **core:** `CfnOutput` all properties are now private * **core:** `StringListCfnOutput` has been removed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. 2 doc comments.
packages/@aws-cdk/aws-codedeploy/lib/server/deployment-group.ts
Outdated
Show resolved
Hide resolved
/** | ||
* The ARN of the resource when referenced from the same stack. | ||
*/ | ||
readonly arn: string; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any thoughts on improving these names, like we talked about?
- arn -> attributeArn
- name -> attributeName
- arnComponents -> staticArnComponents
?
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
|
Additional minor API cleanups in the core module (see breaking changes list).
Updated physical names linter rule to verify that physical name property name is
cfnTypeName
and that it's type is eitherPhysicalName
in case the name isoptional and
string
if the name is required (fixes #2971).Moved all internal files in @aws-cdk/cdk under "private"
BREAKING CHANGE: The deprecated
app.run()
has been removed (useapp.synth()
).CfnElement.refAsString
renamed toref
ofstring
type. TheIResolvable
version have been removed.Resource.physicalName
is now astring
instead ofPhysicalName
. If a physical name should be generated during deployment (i.e. not supplied to L1), the string will synthesize toundefined
.IStringValue
renamed toIStringProducer
Include
renamed toCfnInclude
Cfn
prefix was added to the following types:CfnCreationPolicy
,CfnResourceAutoScalingCreationPolicy
,CfnResourceAutoScalingCreationPolicy
,CfnDeletionPolicy
,CfnUpdatePolicy
,CfnAutoScalingRollingUpdate
,CfnAutoScalingReplacingUpdate
,CfnAutoScalingScheduledAction
,CfnCodeDeployLambdaAliasUpdate
,CfnTag
CfnRuleAssertion
,CfnDynamicReferenceProps
deepMerge
is no longer exported.CfnOutputProps.export
was renamed toexportName
.CfnOutput
all properties are now privateStringListCfnOutput
has been removedPull Request Checklist
design
folderBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.