diff --git a/API.md b/API.md
index 0ff08df4..54757394 100644
--- a/API.md
+++ b/API.md
@@ -657,9 +657,9 @@ Check whether the given construct is a Resource.
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
-| arn | string | *No description.* |
-| name | string | *No description.* |
-| type | FlowType | *No description.* |
+| arn | string | The ARN of the flow. |
+| name | string | The name of the flow. |
+| type | FlowType | The type of the flow. |
---
@@ -714,6 +714,8 @@ public readonly arn: string;
- *Type:* string
+The ARN of the flow.
+
---
##### `name`Required
@@ -724,6 +726,8 @@ public readonly name: string;
- *Type:* string
+The name of the flow.
+
---
##### `type`Required
@@ -734,6 +738,8 @@ public readonly type: FlowType;
- *Type:* FlowType
+The type of the flow.
+
---
@@ -1766,9 +1772,9 @@ Check whether the given construct is a Resource.
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
-| arn | string | *No description.* |
-| name | string | *No description.* |
-| type | FlowType | *No description.* |
+| arn | string | The ARN of the flow. |
+| name | string | The name of the flow. |
+| type | FlowType | The type of the flow. |
---
@@ -1823,6 +1829,8 @@ public readonly arn: string;
- *Type:* string
+The ARN of the flow.
+
---
##### `name`Required
@@ -1833,6 +1841,8 @@ public readonly name: string;
- *Type:* string
+The name of the flow.
+
---
##### `type`Required
@@ -1843,6 +1853,8 @@ public readonly type: FlowType;
- *Type:* FlowType
+The type of the flow.
+
---
@@ -2085,9 +2097,9 @@ Check whether the given construct is a Resource.
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
-| arn | string | *No description.* |
-| name | string | *No description.* |
-| type | FlowType | *No description.* |
+| arn | string | The ARN of the flow. |
+| name | string | The name of the flow. |
+| type | FlowType | The type of the flow. |
---
@@ -2142,6 +2154,8 @@ public readonly arn: string;
- *Type:* string
+The ARN of the flow.
+
---
##### `name`Required
@@ -2152,6 +2166,8 @@ public readonly name: string;
- *Type:* string
+The name of the flow.
+
---
##### `type`Required
@@ -2162,6 +2178,8 @@ public readonly type: FlowType;
- *Type:* FlowType
+The type of the flow.
+
---
@@ -2385,9 +2403,9 @@ Check whether the given construct is a Resource.
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
-| arn | string | *No description.* |
-| name | string | *No description.* |
-| type | FlowType | *No description.* |
+| arn | string | The ARN of the flow. |
+| name | string | The name of the flow. |
+| type | FlowType | The type of the flow. |
---
@@ -2442,6 +2460,8 @@ public readonly arn: string;
- *Type:* string
+The ARN of the flow.
+
---
##### `name`Required
@@ -2452,6 +2472,8 @@ public readonly name: string;
- *Type:* string
+The name of the flow.
+
---
##### `type`Required
@@ -2462,6 +2484,8 @@ public readonly type: FlowType;
- *Type:* FlowType
+The type of the flow.
+
---
@@ -4125,12 +4149,14 @@ public readonly credentials: ISecret;
- *Implements:* IFlow
+A base class for triggered flows.
+
#### Initializers
```typescript
import { TriggeredFlowBase } from '@cdklabs/cdk-appflow'
-new TriggeredFlowBase(scope: Construct, id: string, props: FlowBaseProps, autoActivate?: boolean)
+new TriggeredFlowBase(scope: Construct, id: string, props: FlowBaseProps)
```
| **Name** | **Type** | **Description** |
@@ -4138,7 +4164,6 @@ new TriggeredFlowBase(scope: Construct, id: string, props: FlowBaseProps, autoAc
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | FlowBaseProps | *No description.* |
-| autoActivate | boolean | *No description.* |
---
@@ -4160,12 +4185,6 @@ new TriggeredFlowBase(scope: Construct, id: string, props: FlowBaseProps, autoAc
---
-##### `autoActivate`Optional
-
-- *Type:* boolean
-
----
-
#### Methods
| **Name** | **Description** |
@@ -4348,9 +4367,9 @@ Check whether the given construct is a Resource.
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
-| arn | string | *No description.* |
-| name | string | *No description.* |
-| type | FlowType | *No description.* |
+| arn | string | The ARN of the flow. |
+| name | string | The name of the flow. |
+| type | FlowType | The type of the flow. |
---
@@ -4405,6 +4424,8 @@ public readonly arn: string;
- *Type:* string
+The ARN of the flow.
+
---
##### `name`Required
@@ -4415,6 +4436,8 @@ public readonly name: string;
- *Type:* string
+The name of the flow.
+
---
##### `type`Required
@@ -4425,6 +4448,8 @@ public readonly type: FlowType;
- *Type:* FlowType
+The type of the flow.
+
---
@@ -6100,7 +6125,7 @@ const onEventFlowProps: OnEventFlowProps = { ... }
| transforms | ITransform[] | *No description.* |
| validations | IValidation[] | *No description.* |
| autoActivate | boolean | *No description.* |
-| status | FlowStatus | *No description.* |
+| status | FlowStatus | The status to set on the flow. |
---
@@ -6196,7 +6221,7 @@ public readonly validations: IValidation[];
##### ~~`autoActivate`~~Optional
-- *Deprecated:* . Use active instead
+- *Deprecated:* . This property is deprecated and will be removed in a future release. Use {@link status} instead
```typescript
public readonly autoActivate: boolean;
@@ -6214,6 +6239,10 @@ public readonly status: FlowStatus;
- *Type:* FlowStatus
+The status to set on the flow.
+
+Use this over {@link autoActivate}.
+
---
### OnScheduleFlowProps
@@ -6240,7 +6269,7 @@ const onScheduleFlowProps: OnScheduleFlowProps = { ... }
| transforms | ITransform[] | *No description.* |
| validations | IValidation[] | *No description.* |
| autoActivate | boolean | *No description.* |
-| status | FlowStatus | *No description.* |
+| status | FlowStatus | The status to set on the flow. |
| pullConfig | DataPullConfig | *No description.* |
| schedule | aws-cdk-lib.aws_events.Schedule | *No description.* |
| scheduleProperties | ScheduleProperties | *No description.* |
@@ -6339,7 +6368,7 @@ public readonly validations: IValidation[];
##### ~~`autoActivate`~~Optional
-- *Deprecated:* . Use active instead
+- *Deprecated:* . This property is deprecated and will be removed in a future release. Use {@link status} instead
```typescript
public readonly autoActivate: boolean;
@@ -6357,6 +6386,10 @@ public readonly status: FlowStatus;
- *Type:* FlowStatus
+The status to set on the flow.
+
+Use this over {@link autoActivate}.
+
---
##### `pullConfig`Required
@@ -8538,7 +8571,7 @@ const triggeredFlowBaseProps: TriggeredFlowBaseProps = { ... }
| transforms | ITransform[] | *No description.* |
| validations | IValidation[] | *No description.* |
| autoActivate | boolean | *No description.* |
-| status | FlowStatus | *No description.* |
+| status | FlowStatus | The status to set on the flow. |
---
@@ -8634,7 +8667,7 @@ public readonly validations: IValidation[];
##### ~~`autoActivate`~~Optional
-- *Deprecated:* . Use active instead
+- *Deprecated:* . This property is deprecated and will be removed in a future release. Use {@link status} instead
```typescript
public readonly autoActivate: boolean;
@@ -8652,6 +8685,10 @@ public readonly status: FlowStatus;
- *Type:* FlowStatus
+The status to set on the flow.
+
+Use this over {@link autoActivate}.
+
---
### TriggerProperties
@@ -12063,9 +12100,9 @@ public onRunStarted(id: string, options?: OnEventOptions): Rule
| node | constructs.Node | The tree node. |
| env | aws-cdk-lib.ResourceEnvironment | The environment this resource belongs to. |
| stack | aws-cdk-lib.Stack | The stack in which this resource is defined. |
-| arn | string | *No description.* |
-| name | string | *No description.* |
-| type | FlowType | *No description.* |
+| arn | string | The ARN of the flow. |
+| name | string | The name of the flow. |
+| type | FlowType | The type of the flow. |
---
@@ -12120,6 +12157,8 @@ public readonly arn: string;
- *Type:* string
+The ARN of the flow.
+
---
##### `name`Required
@@ -12130,6 +12169,8 @@ public readonly name: string;
- *Type:* string
+The name of the flow.
+
---
##### `type`Required
@@ -12140,6 +12181,8 @@ public readonly type: FlowType;
- *Type:* FlowType
+The type of the flow.
+
---
### IMapping