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

Commit d9c6df8

Browse files
authored
chore: update doc with the right CDK version link (#290)
1 parent d9f06ff commit d9c6df8

File tree

6 files changed

+1339
-1283
lines changed

6 files changed

+1339
-1283
lines changed

core/.projen/deps.json

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

core/.projen/tasks.json

Lines changed: 6 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

core/API.md

Lines changed: 37 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1955,6 +1955,15 @@ Duplicate values are removed when stack is synthesized.
19551955

19561956
> [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html)
19571957
1958+
###### Example <a name="Example" id="aws-analytics-reference-architecture.NotebookPlatform.addTransform.example"></a>
1959+
1960+
```typescript
1961+
declare const stack: Stack;
1962+
1963+
stack.addTransform('AWS::Serverless-2016-10-31')
1964+
```
1965+
1966+
19581967
###### `transform`<sup>Required</sup> <a name="transform" id="aws-analytics-reference-architecture.NotebookPlatform.addTransform.parameter.transform"></a>
19591968

19601969
- *Type:* string
@@ -2713,6 +2722,15 @@ Adds a bucket notification event destination.
27132722

27142723
> [https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
27152724
2725+
###### Example <a name="Example" id="aws-analytics-reference-architecture.SingletonBucket.addEventNotification.example"></a>
2726+
2727+
```typescript
2728+
declare const myLambda: lambda.Function;
2729+
const bucket = new s3.Bucket(this, 'MyBucket');
2730+
bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.LambdaDestination(myLambda), {prefix: 'home/myusername/*'});
2731+
```
2732+
2733+
27162734
###### `event`<sup>Required</sup> <a name="event" id="aws-analytics-reference-architecture.SingletonBucket.addEventNotification.parameter.event"></a>
27172735

27182736
- *Type:* @aws-cdk/aws-s3.EventType
@@ -6195,6 +6213,10 @@ The web sale dataset part of 1GB retail datasets.
61956213

61966214
### IdpRelayState <a name="IdpRelayState" id="aws-analytics-reference-architecture.IdpRelayState"></a>
61976215

6216+
Enum to define the RelayState of different IdPs Used in EMR Studio Prop in the IAM_FEDERATED scenario.
6217+
6218+
#### Members <a name="Members" id="Members"></a>
6219+
61986220
| **Name** | **Description** |
61996221
| --- | --- |
62006222
| <code><a href="#aws-analytics-reference-architecture.IdpRelayState.MICROSOFT_AZURE">MICROSOFT_AZURE</a></code> | *No description.* |
@@ -6203,61 +6225,63 @@ The web sale dataset part of 1GB retail datasets.
62036225

62046226
---
62056227

6206-
Enum to define the RelayState of different IdPs Used in EMR Studio Prop in the IAM_FEDERATED scenario.
6207-
6208-
#### `MICROSOFT_AZURE` <a name="MICROSOFT_AZURE" id="aws-analytics-reference-architecture.IdpRelayState.MICROSOFT_AZURE"></a>
6228+
##### `MICROSOFT_AZURE` <a name="MICROSOFT_AZURE" id="aws-analytics-reference-architecture.IdpRelayState.MICROSOFT_AZURE"></a>
62096229

62106230
---
62116231

62126232

6213-
#### `PING_FEDERATE` <a name="PING_FEDERATE" id="aws-analytics-reference-architecture.IdpRelayState.PING_FEDERATE"></a>
6233+
##### `PING_FEDERATE` <a name="PING_FEDERATE" id="aws-analytics-reference-architecture.IdpRelayState.PING_FEDERATE"></a>
62146234

62156235
---
62166236

62176237

6218-
#### `PING_ONE` <a name="PING_ONE" id="aws-analytics-reference-architecture.IdpRelayState.PING_ONE"></a>
6238+
##### `PING_ONE` <a name="PING_ONE" id="aws-analytics-reference-architecture.IdpRelayState.PING_ONE"></a>
62196239

62206240
---
62216241

62226242

62236243
### SSOIdentityType <a name="SSOIdentityType" id="aws-analytics-reference-architecture.SSOIdentityType"></a>
62246244

6245+
Enum to define the type of identity Type in EMR studio.
6246+
6247+
#### Members <a name="Members" id="Members"></a>
6248+
62256249
| **Name** | **Description** |
62266250
| --- | --- |
62276251
| <code><a href="#aws-analytics-reference-architecture.SSOIdentityType.USER">USER</a></code> | *No description.* |
62286252
| <code><a href="#aws-analytics-reference-architecture.SSOIdentityType.GROUP">GROUP</a></code> | *No description.* |
62296253

62306254
---
62316255

6232-
Enum to define the type of identity Type in EMR studio.
6233-
6234-
#### `USER` <a name="USER" id="aws-analytics-reference-architecture.SSOIdentityType.USER"></a>
6256+
##### `USER` <a name="USER" id="aws-analytics-reference-architecture.SSOIdentityType.USER"></a>
62356257

62366258
---
62376259

62386260

6239-
#### `GROUP` <a name="GROUP" id="aws-analytics-reference-architecture.SSOIdentityType.GROUP"></a>
6261+
##### `GROUP` <a name="GROUP" id="aws-analytics-reference-architecture.SSOIdentityType.GROUP"></a>
62406262

62416263
---
62426264

62436265

62446266
### StudioAuthMode <a name="StudioAuthMode" id="aws-analytics-reference-architecture.StudioAuthMode"></a>
62456267

6268+
Enum to define authentication mode for Amazon EMR Studio.
6269+
6270+
#### Members <a name="Members" id="Members"></a>
6271+
62466272
| **Name** | **Description** |
62476273
| --- | --- |
62486274
| <code><a href="#aws-analytics-reference-architecture.StudioAuthMode.IAM">IAM</a></code> | *No description.* |
62496275
| <code><a href="#aws-analytics-reference-architecture.StudioAuthMode.SSO">SSO</a></code> | *No description.* |
62506276

62516277
---
62526278

6253-
Enum to define authentication mode for Amazon EMR Studio.
6254-
6255-
#### `IAM` <a name="IAM" id="aws-analytics-reference-architecture.StudioAuthMode.IAM"></a>
6279+
##### `IAM` <a name="IAM" id="aws-analytics-reference-architecture.StudioAuthMode.IAM"></a>
62566280

62576281
---
62586282

62596283

6260-
#### `SSO` <a name="SSO" id="aws-analytics-reference-architecture.StudioAuthMode.SSO"></a>
6284+
##### `SSO` <a name="SSO" id="aws-analytics-reference-architecture.StudioAuthMode.SSO"></a>
62616285

62626286
---
62636287

core/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This documentation explains how to get started with the core components of the A
2828
2. The core components can be deployed in any AWS region
2929
3. Install the following components with the specified version on the machine from which the deployment will be executed:
3030
1. Python [3.8-3.9.2] or Typescript
31-
2. AWS CDK v1: Please refer to the [Getting started](https://docs.aws.amazon.com/cdk/latest/guide/getting_started.html) guide.
31+
2. AWS CDK v1: Please refer to the [Getting started](https://docs.aws.amazon.com/cdk/v1/guide/getting_started.html) guide.
3232

3333

3434
### Initialization (in Python)

core/package.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)