refactor(glue): change physical name to optional #23221
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
github-actions
bot
added
the
valued-contributor
comcalvi
previously requested changes
Dec 5, 2022
Comment on lines
+94
to
+96
| Lazy.string({ | ||
| produce: () => Names.uniqueResourceName(this, {}).toLowerCase(), | ||
| }), |
There was a problem hiding this comment.
Do we have to use toLowerCase()?
There was a problem hiding this comment.
why use a
Lazyhere?
Because physicalName should set in the super. However, when we call the super, we can't use this for Names so we should use a Lazy. Also we can looks this pattern in a other packages (e.g aws-stepfunctions/Activity)
constructor(scope: Construct, id: string, props: ActivityProps = {}) {
super(scope, id, {
physicalName: props.activityName ||
Lazy.string({ produce: () => this.generateName() }),
});Do we have to use
toLowerCase()?
Yes, AWS::Glue::Database.DatabaseInput.Name and AWS::Glue::Table.TableInput.Name must be lowercase.
- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html
- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html
When I use uppercase, I got the error.
mergify
bot
dismissed
comcalvi’s stale review
Pull request has been modified.
|
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). |
|
@Mergifyio requeue |
☑️ This pull request is already queued |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
brennanho
pushed a commit
to brennanho/aws-cdk
that referenced
this pull request
Dec 9, 2022
Currently, we must set the physical name in the Glue L2 Constructs. This is not abide by the [CDK Best Practices](https://docs.aws.amazon.com/cdk/v2/guide/best-practices.html#best-practices-apps-names). So, this mean also customer can not abide by the best practices too. example ```ts const myDatabase = new glue.Database(this, "MyDatabase", { databaseName: "my-database", // need }) new glue.Table(this, "MyTable", { tableName: "my-tabel", // need database: myDatabase, columns: [...] }) ``` This PR fix physicalName in props to optonal and when not privided physicalName then generate physicalName by CDK. Then customers can abide by the best practices and no more coding while worrying about physical name conflicts. example after fixed ```ts const myDatabase = new glue.Database(this, "MyDatabase") new glue.Table(this, "MyTable", { database: myDatabase, columns: [...] }) ``` Also fixd the documents. ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Construct Runtime Dependencies: * [ ] This PR adds new construct runtime dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-construct-runtime-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
brennanho
pushed a commit
to brennanho/aws-cdk
that referenced
this pull request
Jan 20, 2023
Currently, we must set the physical name in the Glue L2 Constructs. This is not abide by the [CDK Best Practices](https://docs.aws.amazon.com/cdk/v2/guide/best-practices.html#best-practices-apps-names). So, this mean also customer can not abide by the best practices too. example ```ts const myDatabase = new glue.Database(this, "MyDatabase", { databaseName: "my-database", // need }) new glue.Table(this, "MyTable", { tableName: "my-tabel", // need database: myDatabase, columns: [...] }) ``` This PR fix physicalName in props to optonal and when not privided physicalName then generate physicalName by CDK. Then customers can abide by the best practices and no more coding while worrying about physical name conflicts. example after fixed ```ts const myDatabase = new glue.Database(this, "MyDatabase") new glue.Table(this, "MyTable", { database: myDatabase, columns: [...] }) ``` Also fixd the documents. ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Construct Runtime Dependencies: * [ ] This PR adds new construct runtime dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-construct-runtime-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
brennanho
pushed a commit
to brennanho/aws-cdk
that referenced
this pull request
Feb 22, 2023
Currently, we must set the physical name in the Glue L2 Constructs. This is not abide by the [CDK Best Practices](https://docs.aws.amazon.com/cdk/v2/guide/best-practices.html#best-practices-apps-names). So, this mean also customer can not abide by the best practices too. example ```ts const myDatabase = new glue.Database(this, "MyDatabase", { databaseName: "my-database", // need }) new glue.Table(this, "MyTable", { tableName: "my-tabel", // need database: myDatabase, columns: [...] }) ``` This PR fix physicalName in props to optonal and when not privided physicalName then generate physicalName by CDK. Then customers can abide by the best practices and no more coding while worrying about physical name conflicts. example after fixed ```ts const myDatabase = new glue.Database(this, "MyDatabase") new glue.Table(this, "MyTable", { database: myDatabase, columns: [...] }) ``` Also fixd the documents. ---- ### All Submissions: * [x] Have you followed the guidelines in our [Contributing guide?](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) ### Adding new Construct Runtime Dependencies: * [ ] This PR adds new construct runtime dependencies following the process described [here](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md/#adding-construct-runtime-dependencies) ### New Features * [ ] Have you added the new feature to an [integration test](https://github.com/aws/aws-cdk/blob/main/INTEGRATION_TESTS.md)? * [ ] Did you use `yarn integ` to deploy the infrastructure and generate the snapshot (i.e. `yarn integ` without `--dry-run`)? *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, we must set the physical name in the Glue L2 Constructs. This is not abide by the CDK Best Practices.
So, this mean also customer can not abide by the best practices too.
example
This PR fix physicalName in props to optonal and when not privided physicalName then generate physicalName by CDK.
Then customers can abide by the best practices and no more coding while worrying about physical name conflicts.
example after fixed
Also fixd the documents.
All Submissions:
Adding new Construct Runtime Dependencies:
New Features
yarn integto deploy the infrastructure and generate the snapshot (i.e.yarn integwithout--dry-run)?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license