Skip to content

Conversation

@natalie-white-aws
Copy link
Collaborator

Issue # (if applicable)

N/A

Reason for this change

Updating README with RFC-aligned documentation

Description of changes

Description of how you validated changes

Checklist


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

natalie-white-aws and others added 30 commits February 23, 2024 06:04
…-glue-l2 to mjanardhan/aws-cdk-glue-l2 to resolve non-trivial merge situation
@natalie-white-aws
Copy link
Collaborator Author

Merging to bring up to date with aws-cdk core PR

@natalie-white-aws
Copy link
Collaborator Author

Submitted new PR: aws#32521

GavinZZ added a commit to aws/aws-cdk that referenced this pull request Jan 21, 2025
…#32521)

### Issue # (if applicable)

Implementation of [RFC
0497](https://github.com/aws/aws-cdk-rfcs/blob/main/text/0497-glue-l2-construct.md)

### Reason for this change

Refactored glue-alpha construct to enforce validations by contract and
interfaces, improve developer experience, and adhere to best practices.
[Related PR with merge conflicts and
history](mjanardhan#12)

### Description of changes

Refactored from a single Job class to a pattern of inheritance that
removes the need for synth-time validations and sets best practice
defaults. Allows for overriding language and Glue versions where
applicable, and other job-type specific parameters.

The existing Job and Job Executable monoliths have been decomposed into
Job Type and Language specific classes that implement and extend an
abstract Job parent class. Developers will be able to see mandatory and
optional parameters that apply just to their selected job type and
language, rather than having to reference documentation and examples or
find out during synth or deploy time that they've selected the wrong
configuration.

BREAKING CHANGE: Developers must refactor their existing Job
instantiation method calls to choose the right job type and language,
and use the new constants static values to define the associated Job
configuration settings. See the RFC and/or new README for examples.

### Description of how you validated changes

Increased unit test coverage to > 90%, consulted with Glue service team
on best practices and sane defaults, updated integration tests.

### Checklist
- [X] My code adheres to the [CONTRIBUTING
GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and
[DESIGN
GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

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

---------

Co-authored-by: Janardhan (Janny) Molumuri <[email protected]>
Co-authored-by: GZ <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
moelasmar pushed a commit to aws/aws-cdk that referenced this pull request Jan 24, 2025
…#32521)

### Issue # (if applicable)

Implementation of [RFC
0497](https://github.com/aws/aws-cdk-rfcs/blob/main/text/0497-glue-l2-construct.md)

### Reason for this change

Refactored glue-alpha construct to enforce validations by contract and
interfaces, improve developer experience, and adhere to best practices.
[Related PR with merge conflicts and
history](mjanardhan#12)

### Description of changes

Refactored from a single Job class to a pattern of inheritance that
removes the need for synth-time validations and sets best practice
defaults. Allows for overriding language and Glue versions where
applicable, and other job-type specific parameters.

The existing Job and Job Executable monoliths have been decomposed into
Job Type and Language specific classes that implement and extend an
abstract Job parent class. Developers will be able to see mandatory and
optional parameters that apply just to their selected job type and
language, rather than having to reference documentation and examples or
find out during synth or deploy time that they've selected the wrong
configuration.

BREAKING CHANGE: Developers must refactor their existing Job
instantiation method calls to choose the right job type and language,
and use the new constants static values to define the associated Job
configuration settings. See the RFC and/or new README for examples.

### Description of how you validated changes

Increased unit test coverage to > 90%, consulted with Glue service team
on best practices and sane defaults, updated integration tests.

### Checklist
- [X] My code adheres to the [CONTRIBUTING
GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and
[DESIGN
GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

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

---------

Co-authored-by: Janardhan (Janny) Molumuri <[email protected]>
Co-authored-by: GZ <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 1a18dc9)
moelasmar pushed a commit to aws/aws-cdk that referenced this pull request Jan 24, 2025
…#32521)

### Issue # (if applicable)

Implementation of [RFC
0497](https://github.com/aws/aws-cdk-rfcs/blob/main/text/0497-glue-l2-construct.md)

### Reason for this change

Refactored glue-alpha construct to enforce validations by contract and
interfaces, improve developer experience, and adhere to best practices.
[Related PR with merge conflicts and
history](mjanardhan#12)

### Description of changes

Refactored from a single Job class to a pattern of inheritance that
removes the need for synth-time validations and sets best practice
defaults. Allows for overriding language and Glue versions where
applicable, and other job-type specific parameters.

The existing Job and Job Executable monoliths have been decomposed into
Job Type and Language specific classes that implement and extend an
abstract Job parent class. Developers will be able to see mandatory and
optional parameters that apply just to their selected job type and
language, rather than having to reference documentation and examples or
find out during synth or deploy time that they've selected the wrong
configuration.

BREAKING CHANGE: Developers must refactor their existing Job
instantiation method calls to choose the right job type and language,
and use the new constants static values to define the associated Job
configuration settings. See the RFC and/or new README for examples.

### Description of how you validated changes

Increased unit test coverage to > 90%, consulted with Glue service team
on best practices and sane defaults, updated integration tests.

### Checklist
- [X] My code adheres to the [CONTRIBUTING
GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and
[DESIGN
GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

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

---------

Co-authored-by: Janardhan (Janny) Molumuri <[email protected]>
Co-authored-by: GZ <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 1a18dc9)
moelasmar pushed a commit to aws/aws-cdk that referenced this pull request Jan 24, 2025
…#32521)

### Issue # (if applicable)

Implementation of [RFC
0497](https://github.com/aws/aws-cdk-rfcs/blob/main/text/0497-glue-l2-construct.md)

### Reason for this change

Refactored glue-alpha construct to enforce validations by contract and
interfaces, improve developer experience, and adhere to best practices.
[Related PR with merge conflicts and
history](mjanardhan#12)

### Description of changes

Refactored from a single Job class to a pattern of inheritance that
removes the need for synth-time validations and sets best practice
defaults. Allows for overriding language and Glue versions where
applicable, and other job-type specific parameters.

The existing Job and Job Executable monoliths have been decomposed into
Job Type and Language specific classes that implement and extend an
abstract Job parent class. Developers will be able to see mandatory and
optional parameters that apply just to their selected job type and
language, rather than having to reference documentation and examples or
find out during synth or deploy time that they've selected the wrong
configuration.

BREAKING CHANGE: Developers must refactor their existing Job
instantiation method calls to choose the right job type and language,
and use the new constants static values to define the associated Job
configuration settings. See the RFC and/or new README for examples.

### Description of how you validated changes

Increased unit test coverage to > 90%, consulted with Glue service team
on best practices and sane defaults, updated integration tests.

### Checklist
- [X] My code adheres to the [CONTRIBUTING
GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and
[DESIGN
GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

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

---------

Co-authored-by: Janardhan (Janny) Molumuri <[email protected]>
Co-authored-by: GZ <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 1a18dc9)
moelasmar pushed a commit to aws/aws-cdk that referenced this pull request Jan 24, 2025
…#32521)

### Issue # (if applicable)

Implementation of [RFC
0497](https://github.com/aws/aws-cdk-rfcs/blob/main/text/0497-glue-l2-construct.md)

### Reason for this change

Refactored glue-alpha construct to enforce validations by contract and
interfaces, improve developer experience, and adhere to best practices.
[Related PR with merge conflicts and
history](mjanardhan#12)

### Description of changes

Refactored from a single Job class to a pattern of inheritance that
removes the need for synth-time validations and sets best practice
defaults. Allows for overriding language and Glue versions where
applicable, and other job-type specific parameters.

The existing Job and Job Executable monoliths have been decomposed into
Job Type and Language specific classes that implement and extend an
abstract Job parent class. Developers will be able to see mandatory and
optional parameters that apply just to their selected job type and
language, rather than having to reference documentation and examples or
find out during synth or deploy time that they've selected the wrong
configuration.

BREAKING CHANGE: Developers must refactor their existing Job
instantiation method calls to choose the right job type and language,
and use the new constants static values to define the associated Job
configuration settings. See the RFC and/or new README for examples.

### Description of how you validated changes

Increased unit test coverage to > 90%, consulted with Glue service team
on best practices and sane defaults, updated integration tests.

### Checklist
- [X] My code adheres to the [CONTRIBUTING
GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and
[DESIGN
GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

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

---------

Co-authored-by: Janardhan (Janny) Molumuri <[email protected]>
Co-authored-by: GZ <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 1a18dc9)
moelasmar pushed a commit to aws/aws-cdk that referenced this pull request Jan 24, 2025
…#32521)

### Issue # (if applicable)

Implementation of [RFC
0497](https://github.com/aws/aws-cdk-rfcs/blob/main/text/0497-glue-l2-construct.md)

### Reason for this change

Refactored glue-alpha construct to enforce validations by contract and
interfaces, improve developer experience, and adhere to best practices.
[Related PR with merge conflicts and
history](mjanardhan#12)

### Description of changes

Refactored from a single Job class to a pattern of inheritance that
removes the need for synth-time validations and sets best practice
defaults. Allows for overriding language and Glue versions where
applicable, and other job-type specific parameters.

The existing Job and Job Executable monoliths have been decomposed into
Job Type and Language specific classes that implement and extend an
abstract Job parent class. Developers will be able to see mandatory and
optional parameters that apply just to their selected job type and
language, rather than having to reference documentation and examples or
find out during synth or deploy time that they've selected the wrong
configuration.

BREAKING CHANGE: Developers must refactor their existing Job
instantiation method calls to choose the right job type and language,
and use the new constants static values to define the associated Job
configuration settings. See the RFC and/or new README for examples.

### Description of how you validated changes

Increased unit test coverage to > 90%, consulted with Glue service team
on best practices and sane defaults, updated integration tests.

### Checklist
- [X] My code adheres to the [CONTRIBUTING
GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and
[DESIGN
GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

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

---------

Co-authored-by: Janardhan (Janny) Molumuri <[email protected]>
Co-authored-by: GZ <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 1a18dc9)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants