Skip to content
This repository was archived by the owner on Jul 16, 2024. It is now read-only.

Commit 67f6f51

Browse files
Pasha IepimakhovPasha Iepimakhov
andauthored
fix: removed unneeded params in constructor docs (#154)
* fix: removed unneeded params in docstrings for Athena workgroup and Glue IAM role default setups * fix: removed AthenaDefaultSetupProps Co-authored-by: Pasha Iepimakhov <iepip@amazon.co.uk>
1 parent 0c9bea7 commit 67f6f51

File tree

4 files changed

+2
-24
lines changed

4 files changed

+2
-24
lines changed

core/API.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -528,18 +528,6 @@ the CrawlerStartWait [properties]{@link SynchronousCrawlerProps}.
528528

529529
## Structs <a name="Structs"></a>
530530

531-
### AthenaDefaultSetupProps <a name="aws-analytics-reference-architecture.AthenaDefaultSetupProps"></a>
532-
533-
The properties for AthenaDefaultSetup Construct.
534-
535-
#### Initializer <a name="[object Object].Initializer"></a>
536-
537-
```typescript
538-
import { AthenaDefaultSetupProps } from 'aws-analytics-reference-architecture'
539-
540-
const athenaDefaultSetupProps: AthenaDefaultSetupProps = { ... }
541-
```
542-
543531
### DataGeneratorProps <a name="aws-analytics-reference-architecture.DataGeneratorProps"></a>
544532

545533
The properties for DataGenerator Construct.

core/src/athena-default-setup.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,6 @@ import { Bucket } from '@aws-cdk/aws-s3';
66
import { Construct } from '@aws-cdk/core';
77
import { SingletonBucket } from './singleton-bucket';
88

9-
/**
10-
* The properties for AthenaDefaultSetup Construct.
11-
*/
12-
13-
export interface AthenaDefaultSetupProps {
14-
15-
}
16-
179
/**
1810
* AthenaDefaultSetup Construct to automatically setup a new Amazon Athena Workgroup with proper configuration for out-of-the-box usage
1911
*/
@@ -26,7 +18,6 @@ export class AthenaDefaultSetup extends Construct {
2618
* Constructs a new instance of the AthenaDefaultSetup class
2719
* @param {Construct} scope the Scope of the CDK Construct
2820
* @param {string} id the ID of the CDK Construct
29-
* @param {AthenaDefaultSetupProps} props the AthenaDefaultSetup [properties]{@link AthenaDefaultSetupProps}
3021
* @access public
3122
*/
3223

core/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ export { SynchronousAthenaQueryProps, SynchronousAthenaQuery } from './synchrono
1010
export { SingletonBucket } from './singleton-bucket';
1111
export { Ec2SsmRole } from './ec2-ssm-role';
1212
export { DataLakeCatalog } from './data-lake-catalog';
13-
export { AthenaDefaultSetup, AthenaDefaultSetupProps } from './athena-default-setup';
13+
export { AthenaDefaultSetup } from './athena-default-setup';
1414
export { SingletonGlueDefaultRole } from './singleton-glue-default-role';

core/src/singleton-glue-default-role.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ export class SingletonGlueDefaultRole extends Construct {
2424
* Constructs a new instance of the GlueDefaultRole class
2525
* @param {Construct} scope the Scope of the CDK Construct
2626
* @param {string} id the ID of the CDK Construct
27-
* @param {GlueDefaultRoleProps} props the GlueDefaultRole [properties]{@link GlueDefaultRoleProps}
28-
* @access public
27+
* @access private
2928
*/
3029

3130
private constructor(scope: Construct, id: string) {

0 commit comments

Comments
 (0)