Skip to content

Commit c85a5aa

Browse files
authored
docs(glue-alpha): fix inconsistent structures in README (#35340)
### Reason for this change There are inconsistencies in the README structure. Fixed them into unified structure. ### Description of changes - I made Spark Jobs as subheader as they provide examples and core part of L2 construct. I kept triggers as numbered list as they do not provide any examples and no need to highlight them. ### 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*
1 parent 4779cdf commit c85a5aa

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

packages/@aws-cdk/aws-glue-alpha/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ for more granular details.
6868

6969
### Spark Jobs
7070

71-
1. **ETL Jobs**
71+
#### ETL Jobs
7272

7373
ETL jobs support pySpark and Scala languages, for which there are separate but
7474
similar constructors. ETL jobs default to the G2 worker type, but you can
@@ -130,7 +130,7 @@ new glue.PySparkEtlJob(stack, 'PySparkETLJob', {
130130
});
131131
```
132132

133-
**Streaming Jobs**
133+
#### Streaming Jobs
134134

135135
Streaming jobs are similar to ETL jobs, except that they perform ETL on data
136136
streams using the Apache Spark Structured Streaming framework. Some Spark
@@ -186,7 +186,7 @@ new glue.PySparkStreamingJob(stack, 'PySparkStreamingJob', {
186186
});
187187
```
188188

189-
**Flex Jobs**
189+
#### Flex Jobs
190190

191191
The flexible execution class is appropriate for non-urgent jobs such as
192192
pre-production jobs, testing, and one-time data loads. Flexible jobs default
@@ -419,14 +419,14 @@ override it if you prefer for your trigger not to start on creation.
419419
Reference the workflow-triggers.test.ts unit tests for examples of creating
420420
workflows and triggers.
421421

422-
1. **On-Demand Triggers**
422+
#### **1. On-Demand Triggers**
423423

424424
On-demand triggers can start glue jobs or crawlers. This construct provides
425425
convenience functions to create on-demand crawler or job triggers. The constructor
426426
takes an optional description parameter, but abstracts the requirement of an
427427
actions list using the job or crawler objects using conditional types.
428428

429-
1. **Scheduled Triggers**
429+
#### **2. Scheduled Triggers**
430430

431431
You can create scheduled triggers using cron expressions. This construct
432432
provides daily, weekly, and monthly convenience functions,
@@ -454,13 +454,13 @@ The trigger actions are executed when the predicateCondition is true.
454454
A `Connection` allows Glue jobs, crawlers and development endpoints to access
455455
certain types of data stores.
456456

457-
***Secrets Management
458-
**You must specify JDBC connection credentials in Secrets Manager and
457+
* **Secrets Management**
458+
You must specify JDBC connection credentials in Secrets Manager and
459459
provide the Secrets Manager Key name as a property to the job connection.
460460

461461
* **Networking - the CDK determines the best fit subnet for Glue connection
462-
configuration
463-
**The prior version of the glue-alpha-module requires the developer to
462+
configuration**
463+
The prior version of the glue-alpha-module requires the developer to
464464
specify the subnet of the Connection when it’s defined. Now, you can still
465465
specify the specific subnet you want to use, but are no longer required
466466
to. You are only required to provide a VPC and either a public or private

0 commit comments

Comments
 (0)