@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
@@ -11,7 +11,7 @@ import { CommonConstruct } from '../../common/index.js';
11
11
  import { LambdaEdgeProps } from '../lambda/index.js';
12
12
  import { CloudfrontFunctionProps, DistributionProps } from './types.js';
13
13
  /**
14
- * @classdesc Provides operations on AWS
14
+ * Provides operations on AWS
15
15
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
16
16
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
17
17
  * @example
@@ -32,6 +32,7 @@ import { CloudfrontFunctionProps, DistributionProps } from './types.js';
32
32
  * }
33
33
  * }
34
34
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
35
+ * @category Service
35
36
  */
36
37
  export declare class CloudFrontManager {
37
38
  createOriginAccessIdentity(id: string, scope: CommonConstruct, accessBucket?: IBucket): cf.OriginAccessIdentity;
@@ -8,7 +8,7 @@ import _ from 'lodash';
8
8
  import { CommonStack } from '../../common/index.js';
9
9
  import { createCfnOutput } from '../../utils/index.js';
10
10
  /**
11
- * @classdesc Provides operations on AWS
11
+ * Provides operations on AWS
12
12
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
13
13
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
14
14
  * @example
@@ -29,6 +29,7 @@ import { createCfnOutput } from '../../utils/index.js';
29
29
  * }
30
30
  * }
31
31
  * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
32
+ * @category Service
32
33
  */
33
34
  export class CloudFrontManager {
34
35
  createOriginAccessIdentity(id, scope, accessBucket) {
@@ -2,11 +2,13 @@ import { DistributionProps as CfDistributionProps, FunctionProps } from 'aws-cdk
2
2
  import { TagProps } from '../../types/index.js';
3
3
  /**
4
4
  */
5
+ /** @category Interface */
5
6
  export interface DistributionProps extends CfDistributionProps {
6
7
  tags?: TagProps[];
7
8
  }
8
9
  /**
9
10
  */
11
+ /** @category Interface */
10
12
  export interface CloudfrontFunctionProps extends FunctionProps {
11
13
  eventType: string;
12
14
  functionFilePath: string;
@@ -4,7 +4,7 @@ import { CfnBucketPolicy, IBucket } from 'aws-cdk-lib/aws-s3';
4
4
  import { CommonConstruct } from '../../common/index.js';
5
5
  import { CloudTrailProps } from './types.js';
6
6
  /**
7
- * @classdesc Provides operations on AWS CloudTrail.
7
+ * Provides operations on AWS CloudTrail.
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
@@ -25,6 +25,7 @@ import { CloudTrailProps } from './types.js';
25
25
  * }
26
26
  * }
27
27
  * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudtrail-readme.html}
28
+ * @category Service
28
29
  */
29
30
  export declare class CloudTrailManager {
30
31
  /**
@@ -1,7 +1,7 @@
1
1
  import { CfnTrail } from 'aws-cdk-lib/aws-cloudtrail';
2
2
  import { createCfnOutput } from '../../utils/index.js';
3
3
  /**
4
- * @classdesc Provides operations on AWS CloudTrail.
4
+ * Provides operations on AWS CloudTrail.
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
@@ -22,6 +22,7 @@ import { createCfnOutput } from '../../utils/index.js';
22
22
  * }
23
23
  * }
24
24
  * @see [CDK CloudTrail Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudtrail-readme.html}
25
+ * @category Service
25
26
  */
26
27
  export class CloudTrailManager {
27
28
  /**
@@ -1,5 +1,6 @@
1
1
  import { CfnTrailProps } from 'aws-cdk-lib/aws-cloudtrail';
2
2
  /**
3
3
  */
4
+ /** @category Interface */
4
5
  export interface CloudTrailProps extends CfnTrailProps {
5
6
  }
@@ -3,7 +3,7 @@ import * as logs from 'aws-cdk-lib/aws-logs';
3
3
  import { CommonConstruct } from '../../common/index.js';
4
4
  import { LogProps, MetricFilterProps } from './types.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS CloudWatch.
6
+ * Provides operations on AWS CloudWatch.
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 { LogProps, MetricFilterProps } from './types.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export declare class LogManager {
22
23
  /**
@@ -3,7 +3,7 @@ import * as logs from 'aws-cdk-lib/aws-logs';
3
3
  import _ from 'lodash';
4
4
  import * as utils from '../../utils/index.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS CloudWatch.
6
+ * Provides operations on AWS CloudWatch.
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 * as utils from '../../utils/index.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export class LogManager {
22
23
  /**
@@ -4,7 +4,7 @@ import { IMetric } from 'aws-cdk-lib/aws-cloudwatch';
4
4
  import { CommonConstruct } from '../../common/index.js';
5
5
  import { AlarmProps, AlarmStatusWidgetProps, DashboardProps, GraphWidgetProps, GuageWidgetProps, LogQueryWidgetProps, NumericWidgetProps, TextWidgetProps } from './types.js';
6
6
  /**
7
- * @classdesc Provides operations on AWS CloudWatch.
7
+ * Provides operations on AWS CloudWatch.
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 { AlarmProps, AlarmStatusWidgetProps, DashboardProps, GraphWidgetProps, G
18
18
  * }
19
19
  * }
20
20
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html}
21
+ * @category Service
21
22
  */
22
23
  export declare class CloudWatchManager {
23
24
  /**
@@ -14,7 +14,7 @@ var CloudWatchWidgetType;
14
14
  CloudWatchWidgetType["LogQuery"] = "LogQuery";
15
15
  })(CloudWatchWidgetType || (CloudWatchWidgetType = {}));
16
16
  /**
17
- * @classdesc Provides operations on AWS CloudWatch.
17
+ * Provides operations on AWS CloudWatch.
18
18
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
19
19
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
20
20
  * @example
@@ -28,6 +28,7 @@ var CloudWatchWidgetType;
28
28
  * }
29
29
  * }
30
30
  * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch-readme.html}
31
+ * @category Service
31
32
  */
32
33
  export class CloudWatchManager {
33
34
  /**
@@ -3,6 +3,7 @@ import * as logs from 'aws-cdk-lib/aws-logs';
3
3
  import { TagProps } from '../../types/index.js';
4
4
  /**
5
5
  */
6
+ /** @category Interface */
6
7
  export interface AlarmProps extends watch.AlarmProps {
7
8
  expression?: string;
8
9
  metricProps?: MetricProps[];
@@ -10,10 +11,12 @@ export interface AlarmProps extends watch.AlarmProps {
10
11
  }
11
12
  /**
12
13
  */
14
+ /** @category Interface */
13
15
  export interface DashboardProps extends watch.DashboardProps {
14
16
  }
15
17
  /**
16
18
  */
19
+ /** @category Interface */
17
20
  export interface MetricProps extends watch.MetricProps {
18
21
  apiName?: string;
19
22
  cacheClusterId?: string;
@@ -32,6 +35,7 @@ export interface MetricProps extends watch.MetricProps {
32
35
  }
33
36
  /**
34
37
  */
38
+ /** @category Interface */
35
39
  export interface TextWidgetProps extends watch.TextWidgetProps {
36
40
  positionX: number;
37
41
  positionY: number;
@@ -39,6 +43,7 @@ export interface TextWidgetProps extends watch.TextWidgetProps {
39
43
  }
40
44
  /**
41
45
  */
46
+ /** @category Interface */
42
47
  export interface NumericWidgetProps extends watch.SingleValueWidgetProps {
43
48
  metricProps: watch.MetricProps[];
44
49
  positionX: number;
@@ -47,6 +52,7 @@ export interface NumericWidgetProps extends watch.SingleValueWidgetProps {
47
52
  }
48
53
  /**
49
54
  */
55
+ /** @category Interface */
50
56
  export interface GuageWidgetProps extends watch.GaugeWidgetProps {
51
57
  metricProps: watch.MetricProps[];
52
58
  positionX: number;
@@ -55,6 +61,7 @@ export interface GuageWidgetProps extends watch.GaugeWidgetProps {
55
61
  }
56
62
  /**
57
63
  */
64
+ /** @category Interface */
58
65
  export interface GraphWidgetProps extends watch.GraphWidgetProps {
59
66
  metricProps: MetricProps[];
60
67
  positionX: number;
@@ -63,6 +70,7 @@ export interface GraphWidgetProps extends watch.GraphWidgetProps {
63
70
  }
64
71
  /**
65
72
  */
73
+ /** @category Interface */
66
74
  export interface AlarmStatusWidgetProps extends watch.AlarmStatusWidgetProps {
67
75
  alarmProps: watch.AlarmProps[];
68
76
  positionX: number;
@@ -71,6 +79,7 @@ export interface AlarmStatusWidgetProps extends watch.AlarmStatusWidgetProps {
71
79
  }
72
80
  /**
73
81
  */
82
+ /** @category Interface */
74
83
  export interface LogQueryWidgetProps extends watch.LogQueryWidgetProps {
75
84
  positionX: number;
76
85
  positionY: number;
@@ -78,12 +87,14 @@ export interface LogQueryWidgetProps extends watch.LogQueryWidgetProps {
78
87
  }
79
88
  /**
80
89
  */
90
+ /** @category Interface */
81
91
  export interface MetricFilterProps extends logs.MetricFilterProps {
82
92
  options: watch.MetricOptions;
83
93
  periodInSecs: number;
84
94
  }
85
95
  /**
86
96
  */
97
+ /** @category Interface */
87
98
  export interface LogProps extends logs.LogGroupProps {
88
99
  tags?: TagProps[];
89
100
  }
@@ -1,7 +1,7 @@
1
1
  import { Project } from 'aws-cdk-lib/aws-codebuild';
2
2
  import { CommonConstruct } from '../../common/index.js';
3
3
  /**
4
- * @classdesc Provides operations on AWS Code Build.
4
+ * Provides operations on AWS Code Build.
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 { CommonConstruct } from '../../common/index.js';
15
15
  * }
16
16
  * }
17
17
  * @see [CDK Codebuild Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild-readme.html}
18
+ * @category Service
18
19
  */
19
20
  export declare class CodeBuildManager {
20
21
  /**
@@ -1,7 +1,7 @@
1
1
  import { Duration } from 'aws-cdk-lib';
2
2
  import { BuildSpec, ComputeType, LinuxBuildImage, Project } from 'aws-cdk-lib/aws-codebuild';
3
3
  /**
4
- * @classdesc Provides operations on AWS Code Build.
4
+ * Provides operations on AWS Code Build.
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 { BuildSpec, ComputeType, LinuxBuildImage, Project } from 'aws-cdk-lib/aw
15
15
  * }
16
16
  * }
17
17
  * @see [CDK Codebuild Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild-readme.html}
18
+ * @category Service
18
19
  */
19
20
  export class CodeBuildManager {
20
21
  /**
@@ -1,3 +1,4 @@
1
+ /** @category Enum */
1
2
  export declare enum Architecture {
2
3
  ARM_64 = "ARM_64",
3
4
  X86_64 = "X86_64"
@@ -1,3 +1,4 @@
1
+ /** @category Enum */
1
2
  export var Architecture;
2
3
  (function (Architecture) {
3
4
  Architecture["ARM_64"] = "ARM_64";
@@ -2,7 +2,7 @@ import { Table, TableV2 } from 'aws-cdk-lib/aws-dynamodb';
2
2
  import { CommonConstruct } from '../../common/index.js';
3
3
  import { TableProps, TablePropsV2 } from './types.js';
4
4
  /**
5
- * @classdesc Provides operations on AWS DynamoDB
5
+ * Provides operations on AWS DynamoDB
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 { TableProps, TablePropsV2 } from './types.js';
16
16
  * }
17
17
  * }
18
18
  * @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
19
+ * @category Service
19
20
  */
20
21
  export declare class DynamodbManager {
21
22
  /**
@@ -3,7 +3,7 @@ import { BillingMode, Table, TableV2, TableEncryption } from 'aws-cdk-lib/aws-dy
3
3
  import _ from 'lodash';
4
4
  import { createCfnOutput } from '../../utils/index.js';
5
5
  /**
6
- * @classdesc Provides operations on AWS DynamoDB
6
+ * Provides operations on AWS DynamoDB
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 Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_dynamodb-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export class DynamodbManager {
22
23
  /**
@@ -2,9 +2,11 @@ import * as dynamodb from 'aws-cdk-lib/aws-dynamodb';
2
2
  import { TagProps } from '../../types/index.js';
3
3
  /**
4
4
  */
5
+ /** @category Interface */
5
6
  export interface TableProps extends dynamodb.TableProps {
6
7
  tags?: TagProps[];
7
8
  }
9
+ /** @category Interface */
8
10
  export interface TablePropsV2 extends dynamodb.TablePropsV2 {
9
11
  tags?: TagProps[];
10
12
  }
@@ -1,7 +1,7 @@
1
1
  import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
2
2
  import { CommonConstruct } from '../../common/index.js';
3
3
  /**
4
- * @classdesc Provides operations on AWS Elastic Container Registry.
4
+ * Provides operations on AWS Elastic Container Registry.
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 { CommonConstruct } from '../../common/index.js';
15
15
  * }
16
16
  * }
17
17
  * @see [CDK ECR Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr-readme.html}
18
+ * @category Service
18
19
  */
19
20
  export declare class EcrManager {
20
21
  /**
@@ -1,7 +1,7 @@
1
1
  import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';
2
2
  import { createCfnOutput } from '../../utils/index.js';
3
3
  /**
4
- * @classdesc Provides operations on AWS Elastic Container Registry.
4
+ * Provides operations on AWS Elastic Container Registry.
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 ECR Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecr-readme.html}
18
+ * @category Service
18
19
  */
19
20
  export class EcrManager {
20
21
  /**
@@ -6,7 +6,7 @@ import { ILogGroup } from 'aws-cdk-lib/aws-logs';
6
6
  import { CommonConstruct } from '../../common/index.js';
7
7
  import { EcsApplicationLoadBalancedFargateServiceProps, EcsClusterProps, EcsTaskProps } from './types.js';
8
8
  /**
9
- * @classdesc Provides operations on AWS Elastic Container Service.
9
+ * Provides operations on AWS Elastic Container Service.
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 { EcsApplicationLoadBalancedFargateServiceProps, EcsClusterProps, EcsTask
20
20
  * }
21
21
  * }
22
22
  * @see [CDK ECS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs-readme.html}
23
+ * @category Service
23
24
  */
24
25
  export declare class EcsManager {
25
26
  /**
@@ -4,7 +4,7 @@ import { ApplicationLoadBalancedFargateService } from 'aws-cdk-lib/aws-ecs-patte
4
4
  import _ from 'lodash';
5
5
  import { createCfnOutput } from '../../utils/index.js';
6
6
  /**
7
- * @classdesc Provides operations on AWS Elastic Container Service.
7
+ * Provides operations on AWS Elastic Container Service.
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 { createCfnOutput } from '../../utils/index.js';
18
18
  * }
19
19
  * }
20
20
  * @see [CDK ECS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs-readme.html}
21
+ * @category Service
21
22
  */
22
23
  export class EcsManager {
23
24
  /**
@@ -5,15 +5,18 @@ import { HealthCheck as ElbHealthCheck } from 'aws-cdk-lib/aws-elasticloadbalanc
5
5
  import { TagProps } from '../../types/index.js';
6
6
  /**
7
7
  */
8
+ /** @category Interface */
8
9
  export interface EcsClusterProps extends ClusterProps {
9
10
  tags?: TagProps[];
10
11
  }
11
12
  /**
12
13
  */
14
+ /** @category Interface */
13
15
  export interface EcsTaskProps extends TaskDefinitionProps {
14
16
  logging?: AwsLogDriverProps;
15
17
  tags?: TagProps[];
16
18
  }
19
+ /** @category Interface */
17
20
  export interface EcsScalingProps {
18
21
  maxCapacity?: number;
19
22
  minCapacity?: number;
@@ -24,6 +27,7 @@ export interface EcsScalingProps {
24
27
  }
25
28
  /**
26
29
  */
30
+ /** @category Interface */
27
31
  export interface HealthCheck extends ElbHealthCheck {
28
32
  intervalInSecs: number;
29
33
  timeoutInSecs: number;
@@ -31,12 +35,14 @@ export interface HealthCheck extends ElbHealthCheck {
31
35
  /**
32
36
  *
33
37
  */
38
+ /** @category Interface */
34
39
  export interface EcsApplicationLoadBalancedFargateServiceHealthCheck extends FargateHealthCheck {
35
40
  intervalInSecs: number;
36
41
  timeoutInSecs: number;
37
42
  }
38
43
  /**
39
44
  */
45
+ /** @category Interface */
40
46
  export interface EcsApplicationLoadBalancedFargateServiceProps extends ApplicationLoadBalancedFargateServiceProps {
41
47
  healthCheck?: EcsApplicationLoadBalancedFargateServiceHealthCheck;
42
48
  logging?: AwsLogDriverProps;
@@ -2,17 +2,19 @@ import { ISecurityGroup, IVpc, SubnetSelection } from 'aws-cdk-lib/aws-ec2';
2
2
  import { FileSystem } from 'aws-cdk-lib/aws-efs';
3
3
  import { CommonConstruct } from '../../common/index.js';
4
4
  import { EfsAccessPointOptions, EfsFileSystemProps } from './types.js';
5
+ /** @category Constant */
5
6
  export declare const DEFAULT_CREATE_ACL: {
6
7
  ownerGid: string;
7
8
  ownerUid: string;
8
9
  permissions: string;
9
10
  };
11
+ /** @category Constant */
10
12
  export declare const DEFAULT_POSIX_USER: {
11
13
  gid: string;
12
14
  uid: string;
13
15
  };
14
16
  /**
15
- * @classdesc Provides operations on AWS Elastic File System.
17
+ * Provides operations on AWS Elastic File System.
16
18
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
17
19
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
18
20
  * @example
@@ -26,6 +28,7 @@ export declare const DEFAULT_POSIX_USER: {
26
28
  * }
27
29
  * }
28
30
  * @see [CDK EFS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_efs-readme.html}
31
+ * @category Service
29
32
  */
30
33
  export declare class EfsManager {
31
34
  /**
@@ -2,17 +2,19 @@ import { RemovalPolicy } from 'aws-cdk-lib';
2
2
  import { FileSystem, LifecyclePolicy, OutOfInfrequentAccessPolicy, PerformanceMode } from 'aws-cdk-lib/aws-efs';
3
3
  import _ from 'lodash';
4
4
  import { createCfnOutput } from '../../utils/index.js';
5
+ /** @category Constant */
5
6
  export const DEFAULT_CREATE_ACL = {
6
7
  ownerGid: '1000',
7
8
  ownerUid: '1000',
8
9
  permissions: '755',
9
10
  };
11
+ /** @category Constant */
10
12
  export const DEFAULT_POSIX_USER = {
11
13
  gid: '1000',
12
14
  uid: '1000',
13
15
  };
14
16
  /**
15
- * @classdesc Provides operations on AWS Elastic File System.
17
+ * Provides operations on AWS Elastic File System.
16
18
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
17
19
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
18
20
  * @example
@@ -26,6 +28,7 @@ export const DEFAULT_POSIX_USER = {
26
28
  * }
27
29
  * }
28
30
  * @see [CDK EFS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_efs-readme.html}
31
+ * @category Service
29
32
  */
30
33
  export class EfsManager {
31
34
  /**
@@ -2,6 +2,7 @@ import { AuthorizationConfig } from 'aws-cdk-lib/aws-ecs';
2
2
  import { AccessPointOptions, FileSystemProps } from 'aws-cdk-lib/aws-efs';
3
3
  /**
4
4
  */
5
+ /** @category Interface */
5
6
  export interface EfsFileSystemProps extends FileSystemProps {
6
7
  authorizationConfig?: AuthorizationConfig;
7
8
  provisionNewOnDeployment?: boolean;
@@ -11,5 +12,6 @@ export interface EfsFileSystemProps extends FileSystemProps {
11
12
  }
12
13
  /**
13
14
  */
15
+ /** @category Interface */
14
16
  export interface EfsAccessPointOptions extends AccessPointOptions {
15
17
  }
@@ -4,7 +4,7 @@ import { Cluster } from 'aws-cdk-lib/aws-eks';
4
4
  import { CommonConstruct } from '../../common/index.js';
5
5
  import { EksClusterProps } from './types.js';
6
6
  /**
7
- * @classdesc Provides operations on AWS Elastic Kubernetes Service.
7
+ * Provides operations on AWS Elastic Kubernetes Service.
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 { EksClusterProps } from './types.js';
18
18
  * }
19
19
  * }
20
20
  * @see [CDK EKS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_eks-readme.html}
21
+ * @category Service
21
22
  */
22
23
  export declare class EksManager {
23
24
  /**
@@ -2,7 +2,7 @@ import { InstanceClass, InstanceSize, InstanceType } from 'aws-cdk-lib/aws-ec2';
2
2
  import { Cluster, KubernetesVersion } from 'aws-cdk-lib/aws-eks';
3
3
  import { createCfnOutput } from '../../utils/index.js';
4
4
  /**
5
- * @classdesc Provides operations on AWS Elastic Kubernetes Service.
5
+ * Provides operations on AWS Elastic Kubernetes Service.
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 EKS Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_eks-readme.html}
19
+ * @category Service
19
20
  */
20
21
  export class EksManager {
21
22
  /**
@@ -1,6 +1,7 @@
1
1
  import { ClusterProps } from 'aws-cdk-lib/aws-eks';
2
2
  /**
3
3
  */
4
+ /** @category Interface */
4
5
  export interface EksClusterProps extends ClusterProps {
5
6
  appCapacity: number;
6
7
  appContainerPort: number;
@@ -16,6 +16,7 @@ import { ElastiCacheProps, ReplicatedElastiCacheProps } from './types.js';
16
16
  * }
17
17
  * }
18
18
  * @see [CDK ElastiCache Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache-readme.html}
19
+ * @category Service
19
20
  */
20
21
  export declare class ElastiCacheManager {
21
22
  /**
@@ -17,6 +17,7 @@ import { createCfnOutput } from '../../utils/index.js';
17
17
  * }
18
18
  * }
19
19
  * @see [CDK ElastiCache Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_elasticache-readme.html}
20
+ * @category Service
20
21
  */
21
22
  export class ElastiCacheManager {
22
23
  /**
@@ -1,9 +1,11 @@
1
1
  import { CfnCacheClusterProps, CfnReplicationGroupProps } from 'aws-cdk-lib/aws-elasticache';
2
2
  /**
3
3
  */
4
+ /** @category Interface */
4
5
  export interface ElastiCacheProps extends CfnCacheClusterProps {
5
6
  }
6
7
  /**
7
8
  */
9
+ /** @category Interface */
8
10
  export interface ReplicatedElastiCacheProps extends CfnReplicationGroupProps {
9
11
  }
@@ -8,7 +8,7 @@ import { IStateMachine } from 'aws-cdk-lib/aws-stepfunctions';
8
8
  import { CommonConstruct } from '../../common/index.js';
9
9
  import { DynamoDbToLambdaPipeProps, EventBusProps, EventRuleProps, RuleProps, SqsToLambdaPipeProps, SqsToSfnPipeProps } from './types.js';
10
10
  /**
11
- * @classdesc Provides operations on AWS EventBridge.
11
+ * Provides operations on AWS EventBridge.
12
12
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
13
13
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
14
14
  * @example
@@ -22,6 +22,7 @@ import { DynamoDbToLambdaPipeProps, EventBusProps, EventRuleProps, RuleProps, Sq
22
22
  * }
23
23
  * }
24
24
  * @see [CDK EventBridge Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_events-readme.html}
25
+ * @category Service
25
26
  */
26
27
  export declare class EventManager {
27
28
  /**
@@ -86,7 +87,7 @@ export declare class EventManager {
86
87
  * @param id scoped id of the resource
87
88
  * @param scope scope in which this resource is defined
88
89
  * @param props the props for the pipe
89
- * @param dynamoDbStream the source dynamoDb stream
90
+ * @param sourceDynamoDbStreamArn the source dynamoDb stream
90
91
  * @param targetLambdaFunction the target lambda function
91
92
  */
92
93
  createDynamoDbToLambdaCfnPipe(id: string, scope: CommonConstruct, props: DynamoDbToLambdaPipeProps, sourceDynamoDbStreamArn: string, targetLambdaFunction: IFunction): CfnPipe;