@gradientedge/cdk-utils-aws 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/README.md +31 -0
  2. package/dist/src/common/construct.d.ts +2 -2
  3. package/dist/src/common/construct.js +2 -2
  4. package/dist/src/common/resource-name-formatter.d.ts +1 -0
  5. package/dist/src/common/resource-name-formatter.js +1 -0
  6. package/dist/src/common/stack.d.ts +2 -1
  7. package/dist/src/common/stack.js +2 -1
  8. package/dist/src/common/types.d.ts +2 -0
  9. package/dist/src/construct/api-to-any-target/main.d.ts +2 -1
  10. package/dist/src/construct/api-to-any-target/main.js +2 -1
  11. package/dist/src/construct/api-to-any-target/target.d.ts +1 -0
  12. package/dist/src/construct/api-to-any-target/target.js +1 -0
  13. package/dist/src/construct/api-to-any-target/types.d.ts +4 -0
  14. package/dist/src/construct/api-to-eventbridge-target/api.d.ts +2 -1
  15. package/dist/src/construct/api-to-eventbridge-target/api.js +2 -1
  16. package/dist/src/construct/api-to-eventbridge-target/event.d.ts +2 -1
  17. package/dist/src/construct/api-to-eventbridge-target/event.js +2 -1
  18. package/dist/src/construct/api-to-eventbridge-target/main.d.ts +3 -2
  19. package/dist/src/construct/api-to-eventbridge-target/main.js +3 -2
  20. package/dist/src/construct/api-to-eventbridge-target/types.d.ts +8 -3
  21. package/dist/src/construct/api-to-eventbridge-target-with-sns/api-destined-lambda.d.ts +2 -1
  22. package/dist/src/construct/api-to-eventbridge-target-with-sns/api-destined-lambda.js +2 -1
  23. package/dist/src/construct/api-to-eventbridge-target-with-sns/main.d.ts +3 -2
  24. package/dist/src/construct/api-to-eventbridge-target-with-sns/main.js +3 -2
  25. package/dist/src/construct/api-to-eventbridge-target-with-sns/types.d.ts +2 -0
  26. package/dist/src/construct/api-to-lambda-target/api.d.ts +2 -1
  27. package/dist/src/construct/api-to-lambda-target/api.js +2 -1
  28. package/dist/src/construct/api-to-lambda-target/main.d.ts +1 -0
  29. package/dist/src/construct/api-to-lambda-target/main.js +1 -0
  30. package/dist/src/construct/api-to-lambda-target/types.d.ts +3 -0
  31. package/dist/src/construct/application-configuration/main.d.ts +1 -0
  32. package/dist/src/construct/application-configuration/main.js +1 -0
  33. package/dist/src/construct/application-configuration/types.d.ts +1 -0
  34. package/dist/src/construct/event-handler/handler.d.ts +1 -0
  35. package/dist/src/construct/event-handler/handler.js +1 -0
  36. package/dist/src/construct/event-handler/main.d.ts +2 -1
  37. package/dist/src/construct/event-handler/main.js +2 -1
  38. package/dist/src/construct/event-handler/types.d.ts +2 -0
  39. package/dist/src/construct/lambda-with-iam-access/main.d.ts +2 -1
  40. package/dist/src/construct/lambda-with-iam-access/main.js +2 -1
  41. package/dist/src/construct/lambda-with-iam-access/types.d.ts +2 -0
  42. package/dist/src/construct/piped-event-handler/main.d.ts +2 -1
  43. package/dist/src/construct/piped-event-handler/main.js +2 -1
  44. package/dist/src/construct/piped-event-handler/types.d.ts +1 -0
  45. package/dist/src/construct/rest-api-lambda/main.d.ts +3 -2
  46. package/dist/src/construct/rest-api-lambda/main.js +3 -2
  47. package/dist/src/construct/rest-api-lambda/types.d.ts +2 -0
  48. package/dist/src/construct/rest-api-lambda-with-cache/main.d.ts +3 -2
  49. package/dist/src/construct/rest-api-lambda-with-cache/main.js +3 -2
  50. package/dist/src/construct/rest-api-lambda-with-cache/types.d.ts +1 -0
  51. package/dist/src/construct/site-with-ecs-backend/constants.d.ts +1 -0
  52. package/dist/src/construct/site-with-ecs-backend/constants.js +1 -0
  53. package/dist/src/construct/site-with-ecs-backend/main.d.ts +2 -1
  54. package/dist/src/construct/site-with-ecs-backend/main.js +2 -1
  55. package/dist/src/construct/site-with-ecs-backend/types.d.ts +5 -0
  56. package/dist/src/construct/site-with-lambda-backend/constants.d.ts +2 -0
  57. package/dist/src/construct/site-with-lambda-backend/constants.js +2 -0
  58. package/dist/src/construct/site-with-lambda-backend/main.d.ts +2 -1
  59. package/dist/src/construct/site-with-lambda-backend/main.js +2 -1
  60. package/dist/src/construct/site-with-lambda-backend/types.d.ts +5 -0
  61. package/dist/src/construct/static-asset-deployment/main.d.ts +2 -1
  62. package/dist/src/construct/static-asset-deployment/main.js +2 -1
  63. package/dist/src/construct/static-asset-deployment/types.d.ts +3 -0
  64. package/dist/src/construct/static-site/main.d.ts +2 -1
  65. package/dist/src/construct/static-site/main.js +2 -1
  66. package/dist/src/construct/static-site/types.d.ts +1 -0
  67. package/dist/src/services/api-gateway/main.d.ts +2 -1
  68. package/dist/src/services/api-gateway/main.js +2 -1
  69. package/dist/src/services/api-gateway/types.d.ts +2 -0
  70. package/dist/src/services/appconfig/constants.d.ts +2 -0
  71. package/dist/src/services/appconfig/constants.js +2 -0
  72. package/dist/src/services/appconfig/main.d.ts +2 -1
  73. package/dist/src/services/appconfig/main.js +2 -1
  74. package/dist/src/services/appconfig/types.d.ts +2 -0
  75. package/dist/src/services/certificate-manager/main.d.ts +13 -11
  76. package/dist/src/services/certificate-manager/main.js +13 -11
  77. package/dist/src/services/certificate-manager/types.d.ts +1 -0
  78. package/dist/src/services/cloudfront/main.d.ts +2 -1
  79. package/dist/src/services/cloudfront/main.js +2 -1
  80. package/dist/src/services/cloudfront/types.d.ts +2 -0
  81. package/dist/src/services/cloudtrail/main.d.ts +2 -1
  82. package/dist/src/services/cloudtrail/main.js +2 -1
  83. package/dist/src/services/cloudtrail/types.d.ts +1 -0
  84. package/dist/src/services/cloudwatch/logs.d.ts +2 -1
  85. package/dist/src/services/cloudwatch/logs.js +2 -1
  86. package/dist/src/services/cloudwatch/main.d.ts +2 -1
  87. package/dist/src/services/cloudwatch/main.js +2 -1
  88. package/dist/src/services/cloudwatch/types.d.ts +11 -0
  89. package/dist/src/services/codebuild/main.d.ts +2 -1
  90. package/dist/src/services/codebuild/main.js +2 -1
  91. package/dist/src/services/constants.d.ts +1 -0
  92. package/dist/src/services/constants.js +1 -0
  93. package/dist/src/services/dynamodb/main.d.ts +2 -1
  94. package/dist/src/services/dynamodb/main.js +2 -1
  95. package/dist/src/services/dynamodb/types.d.ts +2 -0
  96. package/dist/src/services/elastic-container-registry/main.d.ts +2 -1
  97. package/dist/src/services/elastic-container-registry/main.js +2 -1
  98. package/dist/src/services/elastic-container-service/main.d.ts +2 -1
  99. package/dist/src/services/elastic-container-service/main.js +2 -1
  100. package/dist/src/services/elastic-container-service/types.d.ts +6 -0
  101. package/dist/src/services/elastic-file-system/main.d.ts +4 -1
  102. package/dist/src/services/elastic-file-system/main.js +4 -1
  103. package/dist/src/services/elastic-file-system/types.d.ts +2 -0
  104. package/dist/src/services/elastic-kubernetes-service/main.d.ts +2 -1
  105. package/dist/src/services/elastic-kubernetes-service/main.js +2 -1
  106. package/dist/src/services/elastic-kubernetes-service/types.d.ts +1 -0
  107. package/dist/src/services/elasticache/main.d.ts +1 -0
  108. package/dist/src/services/elasticache/main.js +1 -0
  109. package/dist/src/services/elasticache/types.d.ts +2 -0
  110. package/dist/src/services/eventbridge/main.d.ts +3 -2
  111. package/dist/src/services/eventbridge/main.js +3 -2
  112. package/dist/src/services/eventbridge/target.d.ts +4 -1
  113. package/dist/src/services/eventbridge/target.js +3 -1
  114. package/dist/src/services/eventbridge/types.d.ts +6 -0
  115. package/dist/src/services/evidently/main.d.ts +2 -1
  116. package/dist/src/services/evidently/main.js +2 -1
  117. package/dist/src/services/evidently/types.d.ts +5 -0
  118. package/dist/src/services/identity-access-management/main.d.ts +2 -1
  119. package/dist/src/services/identity-access-management/main.js +2 -1
  120. package/dist/src/services/key-management-service/main.d.ts +2 -1
  121. package/dist/src/services/key-management-service/main.js +2 -1
  122. package/dist/src/services/key-management-service/types.d.ts +1 -0
  123. package/dist/src/services/lambda/main.d.ts +2 -1
  124. package/dist/src/services/lambda/main.js +2 -1
  125. package/dist/src/services/lambda/types.d.ts +7 -0
  126. package/dist/src/services/route53/main.d.ts +2 -1
  127. package/dist/src/services/route53/main.js +2 -1
  128. package/dist/src/services/route53/types.d.ts +1 -0
  129. package/dist/src/services/secrets-manager/main.d.ts +2 -1
  130. package/dist/src/services/secrets-manager/main.js +2 -1
  131. package/dist/src/services/secrets-manager/types.d.ts +1 -0
  132. package/dist/src/services/simple-notification-service/main.d.ts +2 -1
  133. package/dist/src/services/simple-notification-service/main.js +2 -1
  134. package/dist/src/services/simple-notification-service/types.d.ts +1 -0
  135. package/dist/src/services/simple-queue-service/main.d.ts +2 -1
  136. package/dist/src/services/simple-queue-service/main.js +2 -1
  137. package/dist/src/services/simple-queue-service/types.d.ts +1 -0
  138. package/dist/src/services/simple-storage-service/main.d.ts +2 -1
  139. package/dist/src/services/simple-storage-service/main.js +2 -1
  140. package/dist/src/services/simple-storage-service/types.d.ts +3 -0
  141. package/dist/src/services/step-function/main.d.ts +2 -1
  142. package/dist/src/services/step-function/main.js +2 -1
  143. package/dist/src/services/step-function/types.d.ts +16 -0
  144. package/dist/src/services/systems-manager/main.d.ts +4 -2
  145. package/dist/src/services/systems-manager/main.js +4 -2
  146. package/dist/src/services/systems-manager/types.d.ts +2 -0
  147. package/dist/src/services/virtual-private-cloud/ipv6.d.ts +1 -0
  148. package/dist/src/services/virtual-private-cloud/ipv6.js +1 -0
  149. package/dist/src/services/virtual-private-cloud/main.d.ts +2 -1
  150. package/dist/src/services/virtual-private-cloud/main.js +2 -1
  151. package/dist/src/services/virtual-private-cloud/types.d.ts +1 -0
  152. package/dist/src/services/web-application-firewall/main.d.ts +2 -1
  153. package/dist/src/services/web-application-firewall/main.js +2 -1
  154. package/dist/src/services/web-application-firewall/types.d.ts +2 -0
  155. package/dist/src/types/index.d.ts +1 -0
  156. package/dist/src/utils/index.d.ts +4 -0
  157. package/dist/src/utils/index.js +4 -0
  158. package/package.json +17 -5
@@ -6,7 +6,7 @@ import { CfnPipe } from 'aws-cdk-lib/aws-pipes';
6
6
  import _ from 'lodash';
7
7
  import { createCfnOutput } from '../../utils/index.js';
8
8
  /**
9
- * @classdesc Provides operations on AWS EventBridge.
9
+ * Provides operations on AWS EventBridge.
10
10
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
11
11
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
12
12
  * @example
@@ -20,6 +20,7 @@ import { createCfnOutput } from '../../utils/index.js';
20
20
  * }
21
21
  * }
22
22
  * @see [CDK EventBridge Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events-readme.html}
23
+ * @category Service
23
24
  */
24
25
  export class EventManager {
25
26
  /**
@@ -257,7 +258,7 @@ export class EventManager {
257
258
  * @param id scoped id of the resource
258
259
  * @param scope scope in which this resource is defined
259
260
  * @param props the props for the pipe
260
- * @param dynamoDbStream the source dynamoDb stream
261
+ * @param sourceDynamoDbStreamArn the source dynamoDb stream
261
262
  * @param targetLambdaFunction the target lambda function
262
263
  */
263
264
  createDynamoDbToLambdaCfnPipe(id, scope, props, sourceDynamoDbStreamArn, targetLambdaFunction) {
@@ -3,7 +3,7 @@ import { TargetBaseProps } from 'aws-cdk-lib/aws-events-targets';
3
3
  import { ILogGroup } from 'aws-cdk-lib/aws-logs';
4
4
  import { CommonConstruct } from '../../common/index.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS EventBridge Targets
6
+ * Provides operations on AWS EventBridge Targets
7
7
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
8
8
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
9
9
  * @example
@@ -17,6 +17,7 @@ import { CommonConstruct } from '../../common/index.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK EventBridge Target Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export declare class EventTargetManager {
22
23
  /**
@@ -32,6 +33,7 @@ export declare class EventTargetManager {
32
33
  /**
33
34
  * Customize the CloudWatch LogGroup Event Target
34
35
  */
36
+ /** @category Interface */
35
37
  export interface LogGroupNoPolicyProps extends TargetBaseProps {
36
38
  /**
37
39
  * The event to send to the CloudWatch LogGroup
@@ -43,6 +45,7 @@ export interface LogGroupNoPolicyProps extends TargetBaseProps {
43
45
  }
44
46
  /**
45
47
  * Use an AWS CloudWatch LogGroup as an event rule target, but don't apply a policy.
48
+ * @category Service
46
49
  */
47
50
  export declare class CloudWatchLogGroupNoPolicy implements IRuleTarget {
48
51
  private readonly logGroup;
@@ -1,7 +1,7 @@
1
1
  import { ArnFormat, Stack } from 'aws-cdk-lib';
2
2
  import { bindBaseTargetConfig } from 'aws-cdk-lib/aws-events-targets';
3
3
  /**
4
- * @classdesc Provides operations on AWS EventBridge Targets
4
+ * Provides operations on AWS EventBridge Targets
5
5
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
6
6
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
7
7
  * @example
@@ -15,6 +15,7 @@ import { bindBaseTargetConfig } from 'aws-cdk-lib/aws-events-targets';
15
15
  * }
16
16
  * }
17
17
  * @see [CDK EventBridge Target Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events_targets-readme.html}
18
+ * @category Service
18
19
  */
19
20
  export class EventTargetManager {
20
21
  /**
@@ -31,6 +32,7 @@ export class EventTargetManager {
31
32
  }
32
33
  /**
33
34
  * Use an AWS CloudWatch LogGroup as an event rule target, but don't apply a policy.
35
+ * @category Service
34
36
  */
35
37
  export class CloudWatchLogGroupNoPolicy {
36
38
  logGroup;
@@ -3,6 +3,7 @@ import { CfnPipeProps } from 'aws-cdk-lib/aws-pipes';
3
3
  import { TagProps } from '../../types/index.js';
4
4
  /**
5
5
  */
6
+ /** @category Interface */
6
7
  export interface SqsToSfnPipeProps extends CfnPipeProps {
7
8
  pipeFilterPattern?: any;
8
9
  sfnInputTemplate?: string;
@@ -12,6 +13,7 @@ export interface SqsToSfnPipeProps extends CfnPipeProps {
12
13
  }
13
14
  /**
14
15
  */
16
+ /** @category Interface */
15
17
  export interface SqsToLambdaPipeProps extends CfnPipeProps {
16
18
  pipeFilterPattern?: any;
17
19
  sqsBatchSize?: number;
@@ -20,22 +22,26 @@ export interface SqsToLambdaPipeProps extends CfnPipeProps {
20
22
  }
21
23
  /**
22
24
  */
25
+ /** @category Interface */
23
26
  export interface EventRuleProps extends EBRuleProps {
24
27
  tags?: TagProps[];
25
28
  }
26
29
  /**
27
30
  */
31
+ /** @category Interface */
28
32
  export interface RuleProps extends CfnRuleProps {
29
33
  input?: string;
30
34
  tags?: TagProps[];
31
35
  }
32
36
  /**
33
37
  */
38
+ /** @category Interface */
34
39
  export interface EventBusProps extends EBProps {
35
40
  }
36
41
  /**
37
42
  }
38
43
  */
44
+ /** @category Interface */
39
45
  export interface DynamoDbToLambdaPipeProps extends CfnPipeProps {
40
46
  pipeFilterPattern?: any;
41
47
  dynamoDbBatchSize?: number;
@@ -2,7 +2,7 @@ import { CfnExperiment, CfnFeature, CfnLaunch, CfnProject, CfnSegment } from 'aw
2
2
  import { CommonConstruct } from '../../common/index.js';
3
3
  import { EvidentlyExperimentProps, EvidentlyFeatureProps, EvidentlyLaunchProps, EvidentlyProjectProps, EvidentlySegmentProps } from './types.js';
4
4
  /**
5
- * @classdesc Provides operations on AWS Evidently
5
+ * Provides operations on AWS Evidently
6
6
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
7
7
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
8
8
  * @example
@@ -16,6 +16,7 @@ import { EvidentlyExperimentProps, EvidentlyFeatureProps, EvidentlyLaunchProps,
16
16
  * }
17
17
  * }
18
18
  * @see [CDK Evidently Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_evidently-readme.html}
19
+ * @category Service
19
20
  */
20
21
  export declare class EvidentlyManager {
21
22
  /**
@@ -1,7 +1,7 @@
1
1
  import { CfnExperiment, CfnFeature, CfnLaunch, CfnProject, CfnSegment } from 'aws-cdk-lib/aws-evidently';
2
2
  import { createCfnOutput } from '../../utils/index.js';
3
3
  /**
4
- * @classdesc Provides operations on AWS Evidently
4
+ * Provides operations on AWS Evidently
5
5
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
6
6
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
7
7
  * @example
@@ -15,6 +15,7 @@ import { createCfnOutput } from '../../utils/index.js';
15
15
  * }
16
16
  * }
17
17
  * @see [CDK Evidently Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_evidently-readme.html}
18
+ * @category Service
18
19
  */
19
20
  export class EvidentlyManager {
20
21
  /**
@@ -1,21 +1,26 @@
1
1
  import { CfnExperimentProps, CfnFeatureProps, CfnLaunchProps, CfnProjectProps, CfnSegmentProps } from 'aws-cdk-lib/aws-evidently';
2
2
  /**
3
3
  */
4
+ /** @category Interface */
4
5
  export interface EvidentlyProjectProps extends CfnProjectProps {
5
6
  }
6
7
  /**
7
8
  */
9
+ /** @category Interface */
8
10
  export interface EvidentlyFeatureProps extends CfnFeatureProps {
9
11
  }
10
12
  /**
11
13
  */
14
+ /** @category Interface */
12
15
  export interface EvidentlyLaunchProps extends CfnLaunchProps {
13
16
  }
14
17
  /**
15
18
  */
19
+ /** @category Interface */
16
20
  export interface EvidentlyExperimentProps extends CfnExperimentProps {
17
21
  }
18
22
  /**
19
23
  */
24
+ /** @category Interface */
20
25
  export interface EvidentlySegmentProps extends CfnSegmentProps {
21
26
  }
@@ -6,7 +6,7 @@ import { IBucket } from 'aws-cdk-lib/aws-s3';
6
6
  import { Queue } from 'aws-cdk-lib/aws-sqs';
7
7
  import { CommonConstruct } from '../../common/index.js';
8
8
  /**
9
- * @classdesc Provides operations on AWS
9
+ * Provides operations on AWS
10
10
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
11
11
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
12
12
  * @example
@@ -20,6 +20,7 @@ import { CommonConstruct } from '../../common/index.js';
20
20
  * }
21
21
  * }
22
22
  * @see [CDK IAM Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam-readme.html}
23
+ * @category Service
23
24
  */
24
25
  export declare class IamManager {
25
26
  /**
@@ -2,7 +2,7 @@ import { Stack } from 'aws-cdk-lib';
2
2
  import { CfnRole, Effect, ManagedPolicy, PolicyDocument, PolicyStatement, Role, ServicePrincipal, } from 'aws-cdk-lib/aws-iam';
3
3
  import { createCfnOutput } from '../../utils/index.js';
4
4
  /**
5
- * @classdesc Provides operations on AWS
5
+ * Provides operations on AWS
6
6
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
7
7
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
8
8
  * @example
@@ -16,6 +16,7 @@ import { createCfnOutput } from '../../utils/index.js';
16
16
  * }
17
17
  * }
18
18
  * @see [CDK IAM Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam-readme.html}
19
+ * @category Service
19
20
  */
20
21
  export class IamManager {
21
22
  /**
@@ -2,7 +2,7 @@ import { Key } from 'aws-cdk-lib/aws-kms';
2
2
  import { CommonConstruct } from '../../common/index.js';
3
3
  import { KmsKeyProps } from './types.js';
4
4
  /**
5
- * @classdesc Provides operations on AWS KMS.
5
+ * Provides operations on AWS KMS.
6
6
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
7
7
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
8
8
  * @example
@@ -16,6 +16,7 @@ import { KmsKeyProps } from './types.js';
16
16
  * }
17
17
  * }
18
18
  * @see [CDK KMS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms-readme.html}
19
+ * @category Service
19
20
  */
20
21
  export declare class KmsManager {
21
22
  /**
@@ -1,7 +1,7 @@
1
1
  import { Key } from 'aws-cdk-lib/aws-kms';
2
2
  import { createCfnOutput } from '../../utils/index.js';
3
3
  /**
4
- * @classdesc Provides operations on AWS KMS.
4
+ * Provides operations on AWS KMS.
5
5
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
6
6
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
7
7
  * @example
@@ -15,6 +15,7 @@ import { createCfnOutput } from '../../utils/index.js';
15
15
  * }
16
16
  * }
17
17
  * @see [CDK KMS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_kms-readme.html}
18
+ * @category Service
18
19
  */
19
20
  export class KmsManager {
20
21
  /**
@@ -1,5 +1,6 @@
1
1
  import { KeyProps } from 'aws-cdk-lib/aws-kms';
2
2
  /**
3
3
  */
4
+ /** @category Interface */
4
5
  export interface KmsKeyProps extends KeyProps {
5
6
  }
@@ -6,7 +6,7 @@ import { Alias, Architecture, AssetCode, DockerImageCode, DockerImageFunction, F
6
6
  import { CommonConstruct } from '../../common/index.js';
7
7
  import { LambdaAliasProps, LambdaEdgeProps, LambdaProps } from './types.js';
8
8
  /**
9
- * @classdesc Provides operations on AWS Lambda
9
+ * Provides operations on AWS Lambda
10
10
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
11
11
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
12
12
  * @example
@@ -20,6 +20,7 @@ import { LambdaAliasProps, LambdaEdgeProps, LambdaProps } from './types.js';
20
20
  * }
21
21
  * }
22
22
  * @see [CDK Lambda Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda-readme.html}
23
+ * @category Service
23
24
  */
24
25
  export declare class LambdaManager {
25
26
  /**
@@ -7,7 +7,7 @@ import { CommonStack } from '../../common/index.js';
7
7
  import { createCfnOutput } from '../../utils/index.js';
8
8
  import { CloudFrontManager } from '../cloudfront/index.js';
9
9
  /**
10
- * @classdesc Provides operations on AWS Lambda
10
+ * Provides operations on AWS Lambda
11
11
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
12
12
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
13
13
  * @example
@@ -21,6 +21,7 @@ import { CloudFrontManager } from '../cloudfront/index.js';
21
21
  * }
22
22
  * }
23
23
  * @see [CDK Lambda Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda-readme.html}
24
+ * @category Service
24
25
  */
25
26
  export class LambdaManager {
26
27
  /**
@@ -6,11 +6,13 @@ import { QueueProps } from '../simple-queue-service/index.js';
6
6
  * Props for Lambda@Edge function, matching aws-cdk-lib experimental EdgeFunctionProps.
7
7
  * Inlined because aws-cdk-lib does not export this subpath via its package exports map.
8
8
  */
9
+ /** @category Interface */
9
10
  export interface EdgeFunctionProps extends FunctionProps {
10
11
  readonly stackId?: string;
11
12
  }
12
13
  /**
13
14
  */
15
+ /** @category Interface */
14
16
  export interface ProvisionedConcurrencyProps {
15
17
  maxCapacity: number;
16
18
  minCapacity: number;
@@ -18,6 +20,7 @@ export interface ProvisionedConcurrencyProps {
18
20
  }
19
21
  /**
20
22
  */
23
+ /** @category Interface */
21
24
  export interface LambdaProps extends FunctionProps {
22
25
  dlq?: QueueProps;
23
26
  excludeLastModifiedTimestamp?: boolean;
@@ -30,18 +33,21 @@ export interface LambdaProps extends FunctionProps {
30
33
  }
31
34
  /**
32
35
  */
36
+ /** @category Interface */
33
37
  export interface LambdaAliasProps extends AliasProps {
34
38
  id?: string;
35
39
  provisionedConcurrency?: ProvisionedConcurrencyProps;
36
40
  }
37
41
  /**
38
42
  */
43
+ /** @category Interface */
39
44
  export interface LambdaEdgeProps extends EdgeFunctionProps {
40
45
  tags?: TagProps[];
41
46
  timeoutInSecs?: number;
42
47
  }
43
48
  /**
44
49
  */
50
+ /** @category Interface */
45
51
  export interface LambdaEnvironment {
46
52
  LOG_LEVEL: string;
47
53
  NODE_ENV: string;
@@ -49,6 +55,7 @@ export interface LambdaEnvironment {
49
55
  STAGE?: string;
50
56
  TZ: string;
51
57
  }
58
+ /** @category Interface */
52
59
  export interface SQSEventSourceProps extends SqsEventSourceProps {
53
60
  maxBatchingWindowInSecs: number;
54
61
  }
@@ -4,7 +4,7 @@ import { ARecord, IHostedZone } from 'aws-cdk-lib/aws-route53';
4
4
  import { CommonConstruct } from '../../common/index.js';
5
5
  import { Route53Props } from './types.js';
6
6
  /**
7
- * @classdesc Provides operations on AWS Route53
7
+ * Provides operations on AWS Route53
8
8
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
9
9
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
10
10
  * @example
@@ -18,6 +18,7 @@ import { Route53Props } from './types.js';
18
18
  * }
19
19
  * }
20
20
  * @see [CDK Route53 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53-readme.html}
21
+ * @category Service
21
22
  */
22
23
  export declare class Route53Manager {
23
24
  /**
@@ -2,7 +2,7 @@ import { ARecord, HostedZone, RecordTarget } from 'aws-cdk-lib/aws-route53';
2
2
  import { ApiGatewayDomain, CloudFrontTarget } from 'aws-cdk-lib/aws-route53-targets';
3
3
  import { createCfnOutput } from '../../utils/index.js';
4
4
  /**
5
- * @classdesc Provides operations on AWS Route53
5
+ * Provides operations on AWS Route53
6
6
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
7
7
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
8
8
  * @example
@@ -16,6 +16,7 @@ import { createCfnOutput } from '../../utils/index.js';
16
16
  * }
17
17
  * }
18
18
  * @see [CDK Route53 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53-readme.html}
19
+ * @category Service
19
20
  */
20
21
  export class Route53Manager {
21
22
  /**
@@ -1,6 +1,7 @@
1
1
  import { HostedZoneProps } from 'aws-cdk-lib/aws-route53';
2
2
  /**
3
3
  */
4
+ /** @category Interface */
4
5
  export interface Route53Props extends HostedZoneProps {
5
6
  useExistingHostedZone?: boolean;
6
7
  }
@@ -2,7 +2,7 @@ import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
2
2
  import { CommonConstruct } from '../../common/index.js';
3
3
  import { SecretBaseProps } from './types.js';
4
4
  /**
5
- * @classdesc Provides operations on AWS Secrets Manager.
5
+ * Provides operations on AWS Secrets Manager.
6
6
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
7
7
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
8
8
  * @example
@@ -16,6 +16,7 @@ import { SecretBaseProps } from './types.js';
16
16
  * }
17
17
  * }
18
18
  * @see [CDK Secrets Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager-readme.html}
19
+ * @category Service
19
20
  */
20
21
  export declare class SecretsManager {
21
22
  /**
@@ -3,7 +3,7 @@ import { Fn } from 'aws-cdk-lib';
3
3
  import { Secret } from 'aws-cdk-lib/aws-secretsmanager';
4
4
  import { createCfnOutput, determineCredentials } from '../../utils/index.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS Secrets Manager.
6
+ * Provides operations on AWS Secrets Manager.
7
7
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
8
8
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
9
9
  * @example
@@ -17,6 +17,7 @@ import { createCfnOutput, determineCredentials } from '../../utils/index.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK Secrets Manager Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_secretsmanager-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export class SecretsManager {
22
23
  /**
@@ -1,3 +1,4 @@
1
1
  import { SecretProps } from 'aws-cdk-lib/aws-secretsmanager';
2
+ /** @category Interface */
2
3
  export interface SecretBaseProps extends SecretProps {
3
4
  }
@@ -3,7 +3,7 @@ import { Topic } from 'aws-cdk-lib/aws-sns';
3
3
  import { CommonConstruct } from '../../common/index.js';
4
4
  import { SubscriptionProps } from './types.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS Simple Notification Service.
6
+ * Provides operations on AWS Simple Notification Service.
7
7
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
8
8
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
9
9
  * @example
@@ -17,6 +17,7 @@ import { SubscriptionProps } from './types.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK Simple Notification Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export declare class SnsManager {
22
23
  /**
@@ -3,7 +3,7 @@ import { EmailSubscription, LambdaSubscription } from 'aws-cdk-lib/aws-sns-subsc
3
3
  import _ from 'lodash';
4
4
  import { createCfnOutput } from '../../utils/index.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS Simple Notification Service.
6
+ * Provides operations on AWS Simple Notification Service.
7
7
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
8
8
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
9
9
  * @example
@@ -17,6 +17,7 @@ import { createCfnOutput } from '../../utils/index.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK Simple Notification Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sns-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export class SnsManager {
22
23
  /**
@@ -1,5 +1,6 @@
1
1
  import { TopicProps } from 'aws-cdk-lib/aws-sns';
2
2
  /**
3
3
  */
4
+ /** @category Interface */
4
5
  export interface SubscriptionProps extends TopicProps {
5
6
  }
@@ -3,7 +3,7 @@ import { CommonConstruct } from '../../common/index.js';
3
3
  import { LambdaProps } from '../lambda/index.js';
4
4
  import { QueueProps } from './types.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS Simple Queue Service.
6
+ * Provides operations on AWS Simple Queue Service.
7
7
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
8
8
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
9
9
  * @example
@@ -17,6 +17,7 @@ import { QueueProps } from './types.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK Simple Queue Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export declare class SqsManager {
22
23
  /**
@@ -3,7 +3,7 @@ import { Queue } from 'aws-cdk-lib/aws-sqs';
3
3
  import _ from 'lodash';
4
4
  import { createCfnOutput } from '../../utils/index.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS Simple Queue Service.
6
+ * Provides operations on AWS Simple Queue Service.
7
7
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
8
8
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
9
9
  * @example
@@ -17,6 +17,7 @@ import { createCfnOutput } from '../../utils/index.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK Simple Queue Service Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export class SqsManager {
22
23
  /**
@@ -2,6 +2,7 @@ import * as sqs from 'aws-cdk-lib/aws-sqs';
2
2
  import { TagProps } from '../../types/index.js';
3
3
  /**
4
4
  */
5
+ /** @category Interface */
5
6
  export interface QueueProps extends sqs.QueueProps {
6
7
  dataKeyReuseInSecs?: number;
7
8
  deliveryDelayInSecs?: number;
@@ -4,7 +4,7 @@ import { ISource } from 'aws-cdk-lib/aws-s3-deployment';
4
4
  import { CommonConstruct } from '../../common/index.js';
5
5
  import { LifecycleRule, S3BucketProps } from './types.js';
6
6
  /**
7
- * @classdesc Provides operations on AWS S3
7
+ * Provides operations on AWS S3
8
8
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
9
9
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
10
10
  * @example
@@ -18,6 +18,7 @@ import { LifecycleRule, S3BucketProps } from './types.js';
18
18
  * }
19
19
  * }
20
20
  * @see [CDK S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
21
+ * @category Service
21
22
  */
22
23
  export declare class S3Manager {
23
24
  /**
@@ -5,7 +5,7 @@ import { BucketDeployment, ServerSideEncryption, Source } from 'aws-cdk-lib/aws-
5
5
  import _ from 'lodash';
6
6
  import { createCfnOutput } from '../../utils/index.js';
7
7
  /**
8
- * @classdesc Provides operations on AWS S3
8
+ * Provides operations on AWS S3
9
9
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
10
10
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
11
11
  * @example
@@ -19,6 +19,7 @@ import { createCfnOutput } from '../../utils/index.js';
19
19
  * }
20
20
  * }
21
21
  * @see [CDK S3 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_s3-readme.html}
22
+ * @category Service
22
23
  */
23
24
  export class S3Manager {
24
25
  /**
@@ -3,18 +3,21 @@ import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment';
3
3
  import { TagProps } from '../../types/index.js';
4
4
  /**
5
5
  */
6
+ /** @category Interface */
6
7
  export interface LifecycleRule extends s3.LifecycleRule {
7
8
  expirationInDays?: number;
8
9
  noncurrentVersionExpirationInDays?: number;
9
10
  }
10
11
  /**
11
12
  */
13
+ /** @category Interface */
12
14
  export interface BucketDeploymentProps extends s3deploy.BucketDeploymentProps {
13
15
  expirationInDays?: number;
14
16
  noncurrentVersionExpirationInDays?: number;
15
17
  }
16
18
  /**
17
19
  */
20
+ /** @category Interface */
18
21
  export interface S3BucketProps extends s3.BucketProps {
19
22
  bucketName: string;
20
23
  enableEventBridge?: boolean;
@@ -9,7 +9,7 @@ import { CallApiGatewayRestApiEndpoint, DynamoAttributeValue, DynamoDeleteItem,
9
9
  import { CommonConstruct } from '../../common/index.js';
10
10
  import { SfnCallApiGatewayRestApiEndpointProps, SfnChoiceProps, SfnDynamoDeleteItemProps, SfnDynamoGetItemProps, SfnDynamoPutItemProps, SfnFailProps, SfnLambdaInvokeProps, SfnMapProps, SfnParallelProps, SfnPassProps, SfnSqsSendMessageProps, SfnStartExecutionProps, SfnStateMachineProps, SfnSucceedProps, SfnWaitProps } from './types.js';
11
11
  /**
12
- * @classdesc Provides operations on AWS Step Functions Service.
12
+ * Provides operations on AWS Step Functions Service.
13
13
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
14
14
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
15
15
  * @example
@@ -23,6 +23,7 @@ import { SfnCallApiGatewayRestApiEndpointProps, SfnChoiceProps, SfnDynamoDeleteI
23
23
  * }
24
24
  * }
25
25
  * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
26
+ * @category Service
26
27
  */
27
28
  export declare class SfnManager {
28
29
  /**
@@ -13,7 +13,7 @@ const DEFAULT_RETRY_CONFIG = [
13
13
  },
14
14
  ];
15
15
  /**
16
- * @classdesc Provides operations on AWS Step Functions Service.
16
+ * Provides operations on AWS Step Functions Service.
17
17
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
18
18
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
19
19
  * @example
@@ -27,6 +27,7 @@ const DEFAULT_RETRY_CONFIG = [
27
27
  * }
28
28
  * }
29
29
  * @see [CDK Step Functions Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions-readme.html}
30
+ * @category Service
30
31
  */
31
32
  export class SfnManager {
32
33
  /**