@gradientedge/cdk-utils 4.4.3 → 4.4.7

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 (205) hide show
  1. package/app/api-destined-function/node_modules/.yarn-integrity +2 -89
  2. package/app/api-destined-function/package.json +1 -5
  3. package/lerna.json +6 -0
  4. package/package.json +9 -9
  5. package/api-docs/AcmManager.html +0 -622
  6. package/api-docs/AcmProps.html +0 -238
  7. package/api-docs/AlarmProps.html +0 -238
  8. package/api-docs/AlarmStatusWidgetProps.html +0 -238
  9. package/api-docs/ApiDestinationEvent.html +0 -297
  10. package/api-docs/ApiDestinationEventType.html +0 -238
  11. package/api-docs/ApiDestinedLambda.html +0 -297
  12. package/api-docs/ApiDestinedLambdaEnvironment.html +0 -238
  13. package/api-docs/ApiDestinedLambdaType.html +0 -238
  14. package/api-docs/ApiDestinedRestApi.html +0 -297
  15. package/api-docs/ApiDestinedRestApiType.html +0 -238
  16. package/api-docs/ApiManager.html +0 -766
  17. package/api-docs/ApiToEventBridgeTarget.html +0 -1877
  18. package/api-docs/ApiToEventBridgeTarget.jpg +0 -0
  19. package/api-docs/ApiToEventBridgeTargetEventProps.html +0 -238
  20. package/api-docs/ApiToEventBridgeTargetLambdaProps.html +0 -238
  21. package/api-docs/ApiToEventBridgeTargetProps.html +0 -238
  22. package/api-docs/ApiToEventBridgeTargetRestApiProps.html +0 -238
  23. package/api-docs/AppConfigManager.html +0 -1203
  24. package/api-docs/AppConfigProps.html +0 -238
  25. package/api-docs/CloudFrontManager.html +0 -2402
  26. package/api-docs/CloudFrontProps.html +0 -238
  27. package/api-docs/CloudTrailManager.html +0 -637
  28. package/api-docs/CloudTrailProps.html +0 -238
  29. package/api-docs/CloudWatchManager.html +0 -2986
  30. package/api-docs/CloudfrontFunctionProps.html +0 -238
  31. package/api-docs/CodeBuildManager.html +0 -736
  32. package/api-docs/CommonConstruct.html +0 -1299
  33. package/api-docs/CommonStack.html +0 -813
  34. package/api-docs/CommonStackProps.html +0 -238
  35. package/api-docs/DashboardProps.html +0 -238
  36. package/api-docs/DistributionProps.html +0 -238
  37. package/api-docs/DynamodbManager.html +0 -530
  38. package/api-docs/EcrManager.html +0 -530
  39. package/api-docs/EcsClusterProps.html +0 -238
  40. package/api-docs/EcsManager.html +0 -880
  41. package/api-docs/EcsTaskProps.html +0 -238
  42. package/api-docs/EksClusterProps.html +0 -238
  43. package/api-docs/EksManager.html +0 -580
  44. package/api-docs/EventBusProps.html +0 -238
  45. package/api-docs/EventManager.html +0 -1454
  46. package/api-docs/EventRuleProps.html +0 -238
  47. package/api-docs/GraphQLApiLambda.html +0 -1671
  48. package/api-docs/GraphQLApiLambda.jpg +0 -0
  49. package/api-docs/GraphQlApiLambdaEnvironment.html +0 -238
  50. package/api-docs/GraphQlApiLambdaProps.html +0 -238
  51. package/api-docs/GraphWidgetProps.html +0 -238
  52. package/api-docs/HealthCheck.html +0 -238
  53. package/api-docs/IamManager.html +0 -3821
  54. package/api-docs/LambdaEdgeProps.html +0 -238
  55. package/api-docs/LambdaEnvironment.html +0 -238
  56. package/api-docs/LambdaManager.html +0 -2378
  57. package/api-docs/LambdaProps.html +0 -238
  58. package/api-docs/LifecycleRule.html +0 -238
  59. package/api-docs/LogManager.html +0 -955
  60. package/api-docs/LogProps.html +0 -238
  61. package/api-docs/LogQueryWidgetProps.html +0 -238
  62. package/api-docs/MetricFilterProps.html +0 -238
  63. package/api-docs/MetricProps.html +0 -238
  64. package/api-docs/NumericWidgetProps.html +0 -238
  65. package/api-docs/Route53Manager.html +0 -1460
  66. package/api-docs/Route53Props.html +0 -238
  67. package/api-docs/RuleProps.html +0 -238
  68. package/api-docs/S3BucketProps.html +0 -238
  69. package/api-docs/S3Manager.html +0 -1546
  70. package/api-docs/SSMParameterReader.html +0 -431
  71. package/api-docs/SSMParameterReaderProps.html +0 -238
  72. package/api-docs/SecretsManager.html +0 -1140
  73. package/api-docs/SiteWithEcsBackend.html +0 -2391
  74. package/api-docs/SiteWithEcsBackendProps.html +0 -238
  75. package/api-docs/SnsManager.html +0 -780
  76. package/api-docs/SsmManager.html +0 -955
  77. package/api-docs/StaticSite.html +0 -1358
  78. package/api-docs/StaticSiteProps.html +0 -238
  79. package/api-docs/SubscriptionProps.html +0 -238
  80. package/api-docs/TableProps.html +0 -238
  81. package/api-docs/TextWidgetProps.html +0 -238
  82. package/api-docs/VpcManager.html +0 -986
  83. package/api-docs/WafIPSetProps.html +0 -238
  84. package/api-docs/WafManager.html +0 -730
  85. package/api-docs/WafWebACLProps.html +0 -238
  86. package/api-docs/common_construct.ts.html +0 -279
  87. package/api-docs/common_stack.ts.html +0 -303
  88. package/api-docs/construct_api-to-eventbridge-target_api-destination-event.ts.html +0 -175
  89. package/api-docs/construct_api-to-eventbridge-target_api-destined-lambda.ts.html +0 -178
  90. package/api-docs/construct_api-to-eventbridge-target_api-destined-rest-api.ts.html +0 -190
  91. package/api-docs/construct_api-to-eventbridge-target_main.ts.html +0 -751
  92. package/api-docs/construct_graphql-api-lambda_main.ts.html +0 -408
  93. package/api-docs/construct_site-with-ecs-backend_main.ts.html +0 -544
  94. package/api-docs/construct_static-site_main.ts.html +0 -374
  95. package/api-docs/global.html +0 -1530
  96. package/api-docs/index.html +0 -208
  97. package/api-docs/logo.png +0 -0
  98. package/api-docs/manager_aws_acm-manager.ts.html +0 -236
  99. package/api-docs/manager_aws_api-manager.ts.html +0 -260
  100. package/api-docs/manager_aws_app-config-manager.ts.html +0 -310
  101. package/api-docs/manager_aws_cloudfront-manager.ts.html +0 -491
  102. package/api-docs/manager_aws_cloudtrail-manager.ts.html +0 -251
  103. package/api-docs/manager_aws_cloudwatch-manager.ts.html +0 -553
  104. package/api-docs/manager_aws_codebuild-manager.ts.html +0 -240
  105. package/api-docs/manager_aws_dynamodb-manager.ts.html +0 -219
  106. package/api-docs/manager_aws_ecr-manager.ts.html +0 -199
  107. package/api-docs/manager_aws_ecs-manager.ts.html +0 -259
  108. package/api-docs/manager_aws_eks-manager.ts.html +0 -260
  109. package/api-docs/manager_aws_event-manager.ts.html +0 -336
  110. package/api-docs/manager_aws_iam-manager.ts.html +0 -573
  111. package/api-docs/manager_aws_lambda-manager.ts.html +0 -400
  112. package/api-docs/manager_aws_log-manager.ts.html +0 -259
  113. package/api-docs/manager_aws_route53-manager.ts.html +0 -333
  114. package/api-docs/manager_aws_s3-manager.ts.html +0 -361
  115. package/api-docs/manager_aws_secrets-manager.ts.html +0 -274
  116. package/api-docs/manager_aws_sns-manager.ts.html +0 -246
  117. package/api-docs/manager_aws_ssm-manager.ts.html +0 -273
  118. package/api-docs/manager_aws_vpc-manager.ts.html +0 -244
  119. package/api-docs/manager_aws_waf-manager.ts.html +0 -232
  120. package/api-docs/scripts/app.min.js +0 -1
  121. package/api-docs/scripts/linenumber.js +0 -26
  122. package/api-docs/scripts/search.js +0 -39
  123. package/api-docs/styles/app.min.css +0 -1
  124. package/api-docs/styles/iframe.css +0 -13
  125. package/api-docs/styles/prettify-jsdoc.css +0 -111
  126. package/api-docs/styles/prettify-tomorrow.css +0 -132
  127. package/api-docs/styles/reset.css +0 -44
  128. package/api-docs/styles.css +0 -113
  129. package/api-docs/tutorial-Architecture.html +0 -151
  130. package/api-docs/tutorial-Build.html +0 -150
  131. package/api-docs/tutorial-CI-CD.html +0 -154
  132. package/api-docs/tutorial-Development.html +0 -227
  133. package/api-docs/types_aws_index.ts.html +0 -665
  134. package/api-docs/utils_aws_index.ts.html +0 -192
  135. package/api-docs/utils_index.ts.html +0 -227
  136. package/app/api-destined-function/node_modules/balanced-match/LICENSE.md +0 -21
  137. package/app/api-destined-function/node_modules/balanced-match/README.md +0 -97
  138. package/app/api-destined-function/node_modules/balanced-match/index.js +0 -62
  139. package/app/api-destined-function/node_modules/balanced-match/package.json +0 -48
  140. package/app/api-destined-function/node_modules/brace-expansion/LICENSE +0 -21
  141. package/app/api-destined-function/node_modules/brace-expansion/README.md +0 -129
  142. package/app/api-destined-function/node_modules/brace-expansion/index.js +0 -201
  143. package/app/api-destined-function/node_modules/brace-expansion/package.json +0 -47
  144. package/app/api-destined-function/node_modules/concat-map/.travis.yml +0 -4
  145. package/app/api-destined-function/node_modules/concat-map/LICENSE +0 -18
  146. package/app/api-destined-function/node_modules/concat-map/README.markdown +0 -62
  147. package/app/api-destined-function/node_modules/concat-map/example/map.js +0 -6
  148. package/app/api-destined-function/node_modules/concat-map/index.js +0 -13
  149. package/app/api-destined-function/node_modules/concat-map/package.json +0 -43
  150. package/app/api-destined-function/node_modules/fs.realpath/LICENSE +0 -43
  151. package/app/api-destined-function/node_modules/fs.realpath/README.md +0 -33
  152. package/app/api-destined-function/node_modules/fs.realpath/index.js +0 -66
  153. package/app/api-destined-function/node_modules/fs.realpath/old.js +0 -303
  154. package/app/api-destined-function/node_modules/fs.realpath/package.json +0 -26
  155. package/app/api-destined-function/node_modules/glob/LICENSE +0 -21
  156. package/app/api-destined-function/node_modules/glob/README.md +0 -378
  157. package/app/api-destined-function/node_modules/glob/common.js +0 -236
  158. package/app/api-destined-function/node_modules/glob/glob.js +0 -787
  159. package/app/api-destined-function/node_modules/glob/package.json +0 -52
  160. package/app/api-destined-function/node_modules/glob/sync.js +0 -483
  161. package/app/api-destined-function/node_modules/inflight/LICENSE +0 -15
  162. package/app/api-destined-function/node_modules/inflight/README.md +0 -37
  163. package/app/api-destined-function/node_modules/inflight/inflight.js +0 -54
  164. package/app/api-destined-function/node_modules/inflight/package.json +0 -29
  165. package/app/api-destined-function/node_modules/inherits/LICENSE +0 -16
  166. package/app/api-destined-function/node_modules/inherits/README.md +0 -42
  167. package/app/api-destined-function/node_modules/inherits/inherits.js +0 -9
  168. package/app/api-destined-function/node_modules/inherits/inherits_browser.js +0 -27
  169. package/app/api-destined-function/node_modules/inherits/package.json +0 -29
  170. package/app/api-destined-function/node_modules/minimatch/LICENSE +0 -15
  171. package/app/api-destined-function/node_modules/minimatch/README.md +0 -209
  172. package/app/api-destined-function/node_modules/minimatch/minimatch.js +0 -923
  173. package/app/api-destined-function/node_modules/minimatch/package.json +0 -30
  174. package/app/api-destined-function/node_modules/mkdirp/LICENSE +0 -21
  175. package/app/api-destined-function/node_modules/mkdirp/bin/cmd.js +0 -68
  176. package/app/api-destined-function/node_modules/mkdirp/index.js +0 -31
  177. package/app/api-destined-function/node_modules/mkdirp/lib/find-made.js +0 -29
  178. package/app/api-destined-function/node_modules/mkdirp/lib/mkdirp-manual.js +0 -64
  179. package/app/api-destined-function/node_modules/mkdirp/lib/mkdirp-native.js +0 -39
  180. package/app/api-destined-function/node_modules/mkdirp/lib/opts-arg.js +0 -23
  181. package/app/api-destined-function/node_modules/mkdirp/lib/path-arg.js +0 -29
  182. package/app/api-destined-function/node_modules/mkdirp/lib/use-native.js +0 -10
  183. package/app/api-destined-function/node_modules/mkdirp/package.json +0 -44
  184. package/app/api-destined-function/node_modules/mkdirp/readme.markdown +0 -266
  185. package/app/api-destined-function/node_modules/once/LICENSE +0 -15
  186. package/app/api-destined-function/node_modules/once/README.md +0 -79
  187. package/app/api-destined-function/node_modules/once/once.js +0 -42
  188. package/app/api-destined-function/node_modules/once/package.json +0 -33
  189. package/app/api-destined-function/node_modules/path-is-absolute/index.js +0 -20
  190. package/app/api-destined-function/node_modules/path-is-absolute/license +0 -21
  191. package/app/api-destined-function/node_modules/path-is-absolute/package.json +0 -43
  192. package/app/api-destined-function/node_modules/path-is-absolute/readme.md +0 -59
  193. package/app/api-destined-function/node_modules/rimraf/LICENSE +0 -15
  194. package/app/api-destined-function/node_modules/rimraf/README.md +0 -101
  195. package/app/api-destined-function/node_modules/rimraf/bin.js +0 -68
  196. package/app/api-destined-function/node_modules/rimraf/package.json +0 -32
  197. package/app/api-destined-function/node_modules/rimraf/rimraf.js +0 -360
  198. package/app/api-destined-function/node_modules/wrappy/LICENSE +0 -15
  199. package/app/api-destined-function/node_modules/wrappy/README.md +0 -36
  200. package/app/api-destined-function/node_modules/wrappy/package.json +0 -29
  201. package/app/api-destined-function/node_modules/wrappy/wrappy.js +0 -33
  202. package/img/ApiToEventBridgeTarget.jpg +0 -0
  203. package/img/GraphQLApiLambda.jpg +0 -0
  204. package/img/logo.png +0 -0
  205. package/theme/styles.css +0 -113
@@ -1,259 +0,0 @@
1
-
2
-
3
- <!DOCTYPE html>
4
- <html lang="en">
5
-
6
- <head>
7
-
8
- <meta charset="utf-8">
9
- <meta name="viewport" content="width=device-width, initial-scale=1">
10
- <title>Gradient Edge CDK Utils manager/aws/log-manager.ts</title>
11
-
12
- <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
13
- <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
14
- <script src="./build/entry.js"></script>
15
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
16
- <!--[if lt IE 9]>
17
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
18
- <![endif]-->
19
- <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
20
- <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
21
- <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
22
- <link type="text/css" rel="stylesheet" href="styles/app.min.css">
23
- <link type="text/css" rel="stylesheet" href="styles/iframe.css">
24
- <link type="text/css" rel="stylesheet" href="styles.css">
25
- <script async defer src="https://buttons.github.io/buttons.js"></script>
26
-
27
-
28
- </head>
29
-
30
-
31
-
32
- <body class="layout small-header">
33
- <div id="stickyNavbarOverlay"></div>
34
-
35
-
36
- <div class="top-nav">
37
- <div class="inner">
38
- <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
39
- <span aria-hidden="true"></span>
40
- <span aria-hidden="true"></span>
41
- <span aria-hidden="true"></span>
42
- </a>
43
- <div class="logo">
44
-
45
- <a class="image" href="index.html">
46
- <img src="logo.png" alt="logo">
47
- </a>
48
-
49
-
50
- <a href="index.html">
51
- <h1 class="navbar-item">Gradient Edge CDK Utils Documentation</h1>
52
- </a>
53
-
54
- </div>
55
- <div class="menu">
56
-
57
- <div class="navigation">
58
- <a
59
- href="index.html"
60
- class="link"
61
- >
62
- API Documentation
63
- </a>
64
-
65
- <div class="dropdown is-hoverable is-right">
66
- <a class="dropdown-trigger link">
67
- Tutorials
68
- <i class="fas fa-chevron-down fa-xs"></i>
69
- </a>
70
- <div class="dropdown-menu">
71
- <div class="dropdown-content">
72
-
73
- <a class="dropdown-item" href="tutorial-Architecture.html">
74
- Architecture
75
- </a>
76
-
77
- <a class="dropdown-item" href="tutorial-Build.html">
78
- Build
79
- </a>
80
-
81
- <a class="dropdown-item" href="tutorial-CI-CD.html">
82
- CI-CD
83
- </a>
84
-
85
- <a class="dropdown-item" href="tutorial-Development.html">
86
- Development
87
- </a>
88
-
89
- </div>
90
- </div>
91
- </div>
92
-
93
-
94
-
95
- <a
96
- class="link user-link "
97
- href="https://github.com/gradientedge/cdk-utils"
98
- >
99
- Github
100
- </a>
101
-
102
-
103
-
104
- </div>
105
- </div>
106
- </div>
107
- </div>
108
- <div id="main">
109
- <div
110
- class="sidebar "
111
- id="sidebarNav"
112
- >
113
-
114
- <div class="search-wrapper">
115
- <input id="search" type="text" placeholder="Search docs..." class="input">
116
- </div>
117
-
118
- <nav>
119
-
120
- <h2><a href="index.html">Documentation</a></h2><div class="category"></div><div class="category"><h2>cdk-utils.acm-manager</h2><h3>Classes / Construct</h3><ul><li><a href="AcmManager.html">AcmManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AcmProps.html">AcmProps</a></li></ul></div><div class="category"><h2>cdk-utils.api-manager</h2><h3>Classes / Construct</h3><ul><li><a href="ApiManager.html">ApiManager</a></li></ul></div><div class="category"><h2>cdk-utils.api-to-eventbridge-target</h2><h3>Classes / member</h3><ul><li><a href="ApiDestinationEvent.html">ApiDestinationEvent</a></li><li><a href="ApiDestinedLambda.html">ApiDestinedLambda</a></li><li><a href="ApiDestinedRestApi.html">ApiDestinedRestApi</a></li></ul><h3>Classes / construct</h3><ul><li><a href="ApiToEventBridgeTarget.html">ApiToEventBridgeTarget</a></li></ul><h3>Interfaces / Types</h3><ul><li><a href="ApiDestinationEventType.html">ApiDestinationEventType</a></li><li><a href="ApiDestinedLambdaEnvironment.html">ApiDestinedLambdaEnvironment</a></li><li><a href="ApiDestinedLambdaType.html">ApiDestinedLambdaType</a></li><li><a href="ApiDestinedRestApiType.html">ApiDestinedRestApiType</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="ApiToEventBridgeTargetEventProps.html">ApiToEventBridgeTargetEventProps</a></li><li><a href="ApiToEventBridgeTargetLambdaProps.html">ApiToEventBridgeTargetLambdaProps</a></li><li><a href="ApiToEventBridgeTargetProps.html">ApiToEventBridgeTargetProps</a></li><li><a href="ApiToEventBridgeTargetRestApiProps.html">ApiToEventBridgeTargetRestApiProps</a></li></ul></div><div class="category"><h2>cdk-utils.app-config-manager</h2><h3>Classes / Construct</h3><ul><li><a href="AppConfigManager.html">AppConfigManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AppConfigProps.html">AppConfigProps</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ArnsByRegion">ArnsByRegion</a></li></ul></div><div class="category"><h2>cdk-utils.cloudfront-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudFrontManager.html">CloudFrontManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="CloudfrontFunctionProps.html">CloudfrontFunctionProps</a></li><li><a href="CloudFrontProps.html">CloudFrontProps</a></li><li><a href="DistributionProps.html">DistributionProps</a></li></ul></div><div class="category"><h2>cdk-utils.cloudtrail-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudTrailManager.html">CloudTrailManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="CloudTrailProps.html">CloudTrailProps</a></li></ul></div><div class="category"><h2>cdk-utils.cloudwatch-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudWatchManager.html">CloudWatchManager</a></li><li><a href="LogManager.html">LogManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AlarmProps.html">AlarmProps</a></li><li><a href="AlarmStatusWidgetProps.html">AlarmStatusWidgetProps</a></li><li><a href="DashboardProps.html">DashboardProps</a></li><li><a href="GraphWidgetProps.html">GraphWidgetProps</a></li><li><a href="LogProps.html">LogProps</a></li><li><a href="LogQueryWidgetProps.html">LogQueryWidgetProps</a></li><li><a href="MetricFilterProps.html">MetricFilterProps</a></li><li><a href="MetricProps.html">MetricProps</a></li><li><a href="NumericWidgetProps.html">NumericWidgetProps</a></li><li><a href="TextWidgetProps.html">TextWidgetProps</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CloudWatchWidgetType">CloudWatchWidgetType</a></li></ul></div><div class="category"><h2>cdk-utils.codebuild-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CodeBuildManager.html">CodeBuildManager</a></li></ul></div><div class="category"><h2>cdk-utils.common-construct</h2><h3>Classes / Construct</h3><ul><li><a href="CommonConstruct.html">CommonConstruct</a></li></ul></div><div class="category"><h2>cdk-utils.common-stack</h2><h3>Classes / Construct</h3><ul><li><a href="CommonStack.html">CommonStack</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="CommonStackProps.html">CommonStackProps</a></li></ul></div><div class="category"><h2>cdk-utils.dynamodb-manager</h2><h3>Classes / Construct</h3><ul><li><a href="DynamodbManager.html">DynamodbManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="TableProps.html">TableProps</a></li></ul></div><div class="category"><h2>cdk-utils.ecr-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EcrManager.html">EcrManager</a></li></ul></div><div class="category"><h2>cdk-utils.ecs-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EcsManager.html">EcsManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="EcsClusterProps.html">EcsClusterProps</a></li><li><a href="EcsTaskProps.html">EcsTaskProps</a></li></ul></div><div class="category"><h2>cdk-utils.eks-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EksManager.html">EksManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="EksClusterProps.html">EksClusterProps</a></li></ul></div><div class="category"><h2>cdk-utils.event-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EventManager.html">EventManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="EventBusProps.html">EventBusProps</a></li><li><a href="EventRuleProps.html">EventRuleProps</a></li><li><a href="RuleProps.html">RuleProps</a></li></ul></div><div class="category"><h2>cdk-utils.graphql-api-lambda</h2><h3>Classes / construct</h3><ul><li><a href="GraphQLApiLambda.html">GraphQLApiLambda</a></li></ul><h3>Interfaces / Types</h3><ul><li><a href="GraphQlApiLambdaEnvironment.html">GraphQlApiLambdaEnvironment</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="GraphQlApiLambdaProps.html">GraphQlApiLambdaProps</a></li></ul></div><div class="category"><h2>cdk-utils.iam-manager</h2><h3>Classes / Construct</h3><ul><li><a href="IamManager.html">IamManager</a></li></ul></div><div class="category"><h2>cdk-utils.lambda-manager</h2><h3>Classes / Construct</h3><ul><li><a href="LambdaManager.html">LambdaManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="LambdaEdgeProps.html">LambdaEdgeProps</a></li><li><a href="LambdaProps.html">LambdaProps</a></li></ul><h3>Interfaces / Types</h3><ul><li><a href="LambdaEnvironment.html">LambdaEnvironment</a></li></ul></div><div class="category"><h2>cdk-utils.route53-manager</h2><h3>Classes / Construct</h3><ul><li><a href="Route53Manager.html">Route53Manager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="Route53Props.html">Route53Props</a></li></ul></div><div class="category"><h2>cdk-utils.s3-manager</h2><h3>Classes / Construct</h3><ul><li><a href="S3Manager.html">S3Manager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="LifecycleRule.html">LifecycleRule</a></li><li><a href="S3BucketProps.html">S3BucketProps</a></li></ul></div><div class="category"><h2>cdk-utils.secrets-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SecretsManager.html">SecretsManager</a></li></ul></div><div class="category"><h2>cdk-utils.site-with-ecs-backend</h2><h3>Classes / construct</h3><ul><li><a href="SiteWithEcsBackend.html">SiteWithEcsBackend</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="HealthCheck.html">HealthCheck</a></li><li><a href="SiteWithEcsBackendProps.html">SiteWithEcsBackendProps</a></li></ul></div><div class="category"><h2>cdk-utils.sns-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SnsManager.html">SnsManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="SubscriptionProps.html">SubscriptionProps</a></li></ul></div><div class="category"><h2>cdk-utils.ssm-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SsmManager.html">SsmManager</a></li><li><a href="SSMParameterReader.html">SSMParameterReader</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="SSMParameterReaderProps.html">SSMParameterReaderProps</a></li></ul></div><div class="category"><h2>cdk-utils.static-site</h2><h3>Classes / construct</h3><ul><li><a href="StaticSite.html">StaticSite</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="StaticSiteProps.html">StaticSiteProps</a></li></ul></div><div class="category"><h2>cdk-utils.utils</h2><h3>Global</h3><ul><li><a href="global.html#createCfnOutput">createCfnOutput</a></li><li><a href="global.html#defaultResponseObject">defaultResponseObject</a></li><li><a href="global.html#isDevStage">isDevStage</a></li><li><a href="global.html#isPrdStage">isPrdStage</a></li><li><a href="global.html#isTestStage">isTestStage</a></li><li><a href="global.html#isUatStage">isUatStage</a></li><li><a href="global.html#LogLevel">LogLevel</a></li><li><a href="global.html#redirectError">redirectError</a></li><li><a href="global.html#redirectSuccess">redirectSuccess</a></li></ul></div><div class="category"><h2>cdk-utils.vpc-manager</h2><h3>Classes / Construct</h3><ul><li><a href="VpcManager.html">VpcManager</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CommonVpcIdentifier">CommonVpcIdentifier</a></li></ul></div><div class="category"><h2>cdk-utils.waf-manager</h2><h3>Classes / Construct</h3><ul><li><a href="WafManager.html">WafManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="WafIPSetProps.html">WafIPSetProps</a></li><li><a href="WafWebACLProps.html">WafWebACLProps</a></li></ul></div>
121
-
122
- </nav>
123
- </div>
124
- <div class="core" id="main-content-wrapper">
125
- <div class="content">
126
- <header class="page-title">
127
- <p>Source</p>
128
- <h1>manager/aws/log-manager.ts</h1>
129
- </header>
130
-
131
-
132
-
133
-
134
-
135
- <section>
136
- <article>
137
- <pre class="prettyprint source linenums"><code>import * as cdk from 'aws-cdk-lib'
138
- import * as logs from 'aws-cdk-lib/aws-logs'
139
- import * as common from '../../common'
140
- import * as types from '../../types'
141
- import * as utils from '../../utils'
142
-
143
- /**
144
- * @stability stable
145
- * @category cdk-utils.cloudwatch-manager
146
- * @subcategory Construct
147
- * @classdesc Provides operations on AWS CloudWatch.
148
- * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
149
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
150
- * @example
151
- * import * as common from '@gradientedge/cdk-utils'
152
- *
153
- * class CustomConstruct extends common.common.CommonConstruct {
154
- * constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
155
- * super(parent, id, props)
156
- * this.props = props
157
- * this.logsManager.createMetricFilter('MyMetricFilter', this, logGroup)
158
- * }
159
- * }
160
- *
161
- * @see [CDK CloudWatch Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs-readme.html}
162
- */
163
- export class LogManager {
164
- /**
165
- * @summary Method to create a cloudwatch metric filter
166
- * @param {string} id scoped id of the resource
167
- * @param {common.CommonConstruct} scope scope in which this resource is defined
168
- * @param {types.MetricFilterProps} props
169
- * @param {logs.ILogGroup} logGroup
170
- */
171
- public createMetricFilter(
172
- id: string,
173
- scope: common.CommonConstruct,
174
- props: types.MetricFilterProps,
175
- logGroup: logs.ILogGroup
176
- ) {
177
- if (!props) throw `MetricFilter props undefined`
178
-
179
- const metricFilter = new logs.MetricFilter(scope, `${id}`, {
180
- logGroup: logGroup,
181
- metricName: props.metricName,
182
- metricNamespace: props.metricNamespace,
183
- metricValue: props.metricValue,
184
- defaultValue: props.defaultValue,
185
- filterPattern: props.filterPattern,
186
- })
187
-
188
- const metric = props.options
189
- ? metricFilter.metric({
190
- dimensionsMap: props.options.dimensionsMap,
191
- statistic: props.options.statistic,
192
- period: props.periodInSecs ? cdk.Duration.seconds(props.periodInSecs) : cdk.Duration.minutes(5),
193
- })
194
- : metricFilter.metric()
195
-
196
- return { metricFilter, metric }
197
- }
198
-
199
- /**
200
- * @summary Method to create a cloudwatch log group (cfn)
201
- * @param {string} id scoped id of the resource
202
- * @param {common.CommonConstruct} scope scope in which this resource is defined
203
- * @param {types.LogProps} props
204
- */
205
- public createCfnLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps) {
206
- if (!props) throw `Logs props undefined`
207
-
208
- const logGroup = new logs.CfnLogGroup(scope, `${id}`, {
209
- logGroupName: `${props.logGroupName}-${scope.props.stage}`,
210
- retentionInDays: props.retention,
211
- })
212
-
213
- utils.createCfnOutput(`${id}-logGroupArn`, scope, logGroup.attrArn)
214
-
215
- return logGroup
216
- }
217
-
218
- /**
219
- * @summary Method to create a cloudwatch log group
220
- * @param {string} id scoped id of the resource
221
- * @param {common.CommonConstruct} scope scope in which this resource is defined
222
- * @param {types.LogProps} props
223
- */
224
- public createLogGroup(id: string, scope: common.CommonConstruct, props: types.LogProps) {
225
- if (!props) throw `Logs props undefined`
226
-
227
- const logGroup = new logs.LogGroup(scope, `${id}`, {
228
- logGroupName: `${props.logGroupName}-${scope.props.stage}`,
229
- retention: props.retention,
230
- removalPolicy: props.removalPolicy ?? cdk.RemovalPolicy.DESTROY,
231
- })
232
-
233
- utils.createCfnOutput(`${id}-logGroupArn`, scope, logGroup.logGroupArn)
234
-
235
- return logGroup
236
- }
237
- }
238
- </code></pre>
239
- </article>
240
- </section>
241
-
242
-
243
-
244
-
245
- </div>
246
-
247
- </div>
248
- <div id="side-nav" class="side-nav">
249
- </div>
250
- </div>
251
- <script src="scripts/app.min.js"></script>
252
- <script>PR.prettyPrint();</script>
253
- <script src="scripts/linenumber.js"> </script>
254
-
255
- <script src="scripts/search.js"> </script>
256
-
257
-
258
- </body>
259
- </html>
@@ -1,333 +0,0 @@
1
-
2
-
3
- <!DOCTYPE html>
4
- <html lang="en">
5
-
6
- <head>
7
-
8
- <meta charset="utf-8">
9
- <meta name="viewport" content="width=device-width, initial-scale=1">
10
- <title>Gradient Edge CDK Utils manager/aws/route53-manager.ts</title>
11
-
12
- <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
13
- <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
14
- <script src="./build/entry.js"></script>
15
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
16
- <!--[if lt IE 9]>
17
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
18
- <![endif]-->
19
- <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
20
- <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
21
- <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
22
- <link type="text/css" rel="stylesheet" href="styles/app.min.css">
23
- <link type="text/css" rel="stylesheet" href="styles/iframe.css">
24
- <link type="text/css" rel="stylesheet" href="styles.css">
25
- <script async defer src="https://buttons.github.io/buttons.js"></script>
26
-
27
-
28
- </head>
29
-
30
-
31
-
32
- <body class="layout small-header">
33
- <div id="stickyNavbarOverlay"></div>
34
-
35
-
36
- <div class="top-nav">
37
- <div class="inner">
38
- <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
39
- <span aria-hidden="true"></span>
40
- <span aria-hidden="true"></span>
41
- <span aria-hidden="true"></span>
42
- </a>
43
- <div class="logo">
44
-
45
- <a class="image" href="index.html">
46
- <img src="logo.png" alt="logo">
47
- </a>
48
-
49
-
50
- <a href="index.html">
51
- <h1 class="navbar-item">Gradient Edge CDK Utils Documentation</h1>
52
- </a>
53
-
54
- </div>
55
- <div class="menu">
56
-
57
- <div class="navigation">
58
- <a
59
- href="index.html"
60
- class="link"
61
- >
62
- API Documentation
63
- </a>
64
-
65
- <div class="dropdown is-hoverable is-right">
66
- <a class="dropdown-trigger link">
67
- Tutorials
68
- <i class="fas fa-chevron-down fa-xs"></i>
69
- </a>
70
- <div class="dropdown-menu">
71
- <div class="dropdown-content">
72
-
73
- <a class="dropdown-item" href="tutorial-Architecture.html">
74
- Architecture
75
- </a>
76
-
77
- <a class="dropdown-item" href="tutorial-Build.html">
78
- Build
79
- </a>
80
-
81
- <a class="dropdown-item" href="tutorial-CI-CD.html">
82
- CI-CD
83
- </a>
84
-
85
- <a class="dropdown-item" href="tutorial-Development.html">
86
- Development
87
- </a>
88
-
89
- </div>
90
- </div>
91
- </div>
92
-
93
-
94
-
95
- <a
96
- class="link user-link "
97
- href="https://github.com/gradientedge/cdk-utils"
98
- >
99
- Github
100
- </a>
101
-
102
-
103
-
104
- </div>
105
- </div>
106
- </div>
107
- </div>
108
- <div id="main">
109
- <div
110
- class="sidebar "
111
- id="sidebarNav"
112
- >
113
-
114
- <div class="search-wrapper">
115
- <input id="search" type="text" placeholder="Search docs..." class="input">
116
- </div>
117
-
118
- <nav>
119
-
120
- <h2><a href="index.html">Documentation</a></h2><div class="category"></div><div class="category"><h2>cdk-utils.acm-manager</h2><h3>Classes / Construct</h3><ul><li><a href="AcmManager.html">AcmManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AcmProps.html">AcmProps</a></li></ul></div><div class="category"><h2>cdk-utils.api-manager</h2><h3>Classes / Construct</h3><ul><li><a href="ApiManager.html">ApiManager</a></li></ul></div><div class="category"><h2>cdk-utils.api-to-eventbridge-target</h2><h3>Classes / member</h3><ul><li><a href="ApiDestinationEvent.html">ApiDestinationEvent</a></li><li><a href="ApiDestinedLambda.html">ApiDestinedLambda</a></li><li><a href="ApiDestinedRestApi.html">ApiDestinedRestApi</a></li></ul><h3>Classes / construct</h3><ul><li><a href="ApiToEventBridgeTarget.html">ApiToEventBridgeTarget</a></li></ul><h3>Interfaces / Types</h3><ul><li><a href="ApiDestinationEventType.html">ApiDestinationEventType</a></li><li><a href="ApiDestinedLambdaEnvironment.html">ApiDestinedLambdaEnvironment</a></li><li><a href="ApiDestinedLambdaType.html">ApiDestinedLambdaType</a></li><li><a href="ApiDestinedRestApiType.html">ApiDestinedRestApiType</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="ApiToEventBridgeTargetEventProps.html">ApiToEventBridgeTargetEventProps</a></li><li><a href="ApiToEventBridgeTargetLambdaProps.html">ApiToEventBridgeTargetLambdaProps</a></li><li><a href="ApiToEventBridgeTargetProps.html">ApiToEventBridgeTargetProps</a></li><li><a href="ApiToEventBridgeTargetRestApiProps.html">ApiToEventBridgeTargetRestApiProps</a></li></ul></div><div class="category"><h2>cdk-utils.app-config-manager</h2><h3>Classes / Construct</h3><ul><li><a href="AppConfigManager.html">AppConfigManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AppConfigProps.html">AppConfigProps</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ArnsByRegion">ArnsByRegion</a></li></ul></div><div class="category"><h2>cdk-utils.cloudfront-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudFrontManager.html">CloudFrontManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="CloudfrontFunctionProps.html">CloudfrontFunctionProps</a></li><li><a href="CloudFrontProps.html">CloudFrontProps</a></li><li><a href="DistributionProps.html">DistributionProps</a></li></ul></div><div class="category"><h2>cdk-utils.cloudtrail-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudTrailManager.html">CloudTrailManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="CloudTrailProps.html">CloudTrailProps</a></li></ul></div><div class="category"><h2>cdk-utils.cloudwatch-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CloudWatchManager.html">CloudWatchManager</a></li><li><a href="LogManager.html">LogManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="AlarmProps.html">AlarmProps</a></li><li><a href="AlarmStatusWidgetProps.html">AlarmStatusWidgetProps</a></li><li><a href="DashboardProps.html">DashboardProps</a></li><li><a href="GraphWidgetProps.html">GraphWidgetProps</a></li><li><a href="LogProps.html">LogProps</a></li><li><a href="LogQueryWidgetProps.html">LogQueryWidgetProps</a></li><li><a href="MetricFilterProps.html">MetricFilterProps</a></li><li><a href="MetricProps.html">MetricProps</a></li><li><a href="NumericWidgetProps.html">NumericWidgetProps</a></li><li><a href="TextWidgetProps.html">TextWidgetProps</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CloudWatchWidgetType">CloudWatchWidgetType</a></li></ul></div><div class="category"><h2>cdk-utils.codebuild-manager</h2><h3>Classes / Construct</h3><ul><li><a href="CodeBuildManager.html">CodeBuildManager</a></li></ul></div><div class="category"><h2>cdk-utils.common-construct</h2><h3>Classes / Construct</h3><ul><li><a href="CommonConstruct.html">CommonConstruct</a></li></ul></div><div class="category"><h2>cdk-utils.common-stack</h2><h3>Classes / Construct</h3><ul><li><a href="CommonStack.html">CommonStack</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="CommonStackProps.html">CommonStackProps</a></li></ul></div><div class="category"><h2>cdk-utils.dynamodb-manager</h2><h3>Classes / Construct</h3><ul><li><a href="DynamodbManager.html">DynamodbManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="TableProps.html">TableProps</a></li></ul></div><div class="category"><h2>cdk-utils.ecr-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EcrManager.html">EcrManager</a></li></ul></div><div class="category"><h2>cdk-utils.ecs-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EcsManager.html">EcsManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="EcsClusterProps.html">EcsClusterProps</a></li><li><a href="EcsTaskProps.html">EcsTaskProps</a></li></ul></div><div class="category"><h2>cdk-utils.eks-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EksManager.html">EksManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="EksClusterProps.html">EksClusterProps</a></li></ul></div><div class="category"><h2>cdk-utils.event-manager</h2><h3>Classes / Construct</h3><ul><li><a href="EventManager.html">EventManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="EventBusProps.html">EventBusProps</a></li><li><a href="EventRuleProps.html">EventRuleProps</a></li><li><a href="RuleProps.html">RuleProps</a></li></ul></div><div class="category"><h2>cdk-utils.graphql-api-lambda</h2><h3>Classes / construct</h3><ul><li><a href="GraphQLApiLambda.html">GraphQLApiLambda</a></li></ul><h3>Interfaces / Types</h3><ul><li><a href="GraphQlApiLambdaEnvironment.html">GraphQlApiLambdaEnvironment</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="GraphQlApiLambdaProps.html">GraphQlApiLambdaProps</a></li></ul></div><div class="category"><h2>cdk-utils.iam-manager</h2><h3>Classes / Construct</h3><ul><li><a href="IamManager.html">IamManager</a></li></ul></div><div class="category"><h2>cdk-utils.lambda-manager</h2><h3>Classes / Construct</h3><ul><li><a href="LambdaManager.html">LambdaManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="LambdaEdgeProps.html">LambdaEdgeProps</a></li><li><a href="LambdaProps.html">LambdaProps</a></li></ul><h3>Interfaces / Types</h3><ul><li><a href="LambdaEnvironment.html">LambdaEnvironment</a></li></ul></div><div class="category"><h2>cdk-utils.route53-manager</h2><h3>Classes / Construct</h3><ul><li><a href="Route53Manager.html">Route53Manager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="Route53Props.html">Route53Props</a></li></ul></div><div class="category"><h2>cdk-utils.s3-manager</h2><h3>Classes / Construct</h3><ul><li><a href="S3Manager.html">S3Manager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="LifecycleRule.html">LifecycleRule</a></li><li><a href="S3BucketProps.html">S3BucketProps</a></li></ul></div><div class="category"><h2>cdk-utils.secrets-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SecretsManager.html">SecretsManager</a></li></ul></div><div class="category"><h2>cdk-utils.site-with-ecs-backend</h2><h3>Classes / construct</h3><ul><li><a href="SiteWithEcsBackend.html">SiteWithEcsBackend</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="HealthCheck.html">HealthCheck</a></li><li><a href="SiteWithEcsBackendProps.html">SiteWithEcsBackendProps</a></li></ul></div><div class="category"><h2>cdk-utils.sns-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SnsManager.html">SnsManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="SubscriptionProps.html">SubscriptionProps</a></li></ul></div><div class="category"><h2>cdk-utils.ssm-manager</h2><h3>Classes / Construct</h3><ul><li><a href="SsmManager.html">SsmManager</a></li><li><a href="SSMParameterReader.html">SSMParameterReader</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="SSMParameterReaderProps.html">SSMParameterReaderProps</a></li></ul></div><div class="category"><h2>cdk-utils.static-site</h2><h3>Classes / construct</h3><ul><li><a href="StaticSite.html">StaticSite</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="StaticSiteProps.html">StaticSiteProps</a></li></ul></div><div class="category"><h2>cdk-utils.utils</h2><h3>Global</h3><ul><li><a href="global.html#createCfnOutput">createCfnOutput</a></li><li><a href="global.html#defaultResponseObject">defaultResponseObject</a></li><li><a href="global.html#isDevStage">isDevStage</a></li><li><a href="global.html#isPrdStage">isPrdStage</a></li><li><a href="global.html#isTestStage">isTestStage</a></li><li><a href="global.html#isUatStage">isUatStage</a></li><li><a href="global.html#LogLevel">LogLevel</a></li><li><a href="global.html#redirectError">redirectError</a></li><li><a href="global.html#redirectSuccess">redirectSuccess</a></li></ul></div><div class="category"><h2>cdk-utils.vpc-manager</h2><h3>Classes / Construct</h3><ul><li><a href="VpcManager.html">VpcManager</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CommonVpcIdentifier">CommonVpcIdentifier</a></li></ul></div><div class="category"><h2>cdk-utils.waf-manager</h2><h3>Classes / Construct</h3><ul><li><a href="WafManager.html">WafManager</a></li></ul><h3>Interfaces / Properties</h3><ul><li><a href="WafIPSetProps.html">WafIPSetProps</a></li><li><a href="WafWebACLProps.html">WafWebACLProps</a></li></ul></div>
121
-
122
- </nav>
123
- </div>
124
- <div class="core" id="main-content-wrapper">
125
- <div class="content">
126
- <header class="page-title">
127
- <p>Source</p>
128
- <h1>manager/aws/route53-manager.ts</h1>
129
- </header>
130
-
131
-
132
-
133
-
134
-
135
- <section>
136
- <article>
137
- <pre class="prettyprint source linenums"><code>import * as apig from 'aws-cdk-lib/aws-apigateway'
138
- import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
139
- import * as route53 from 'aws-cdk-lib/aws-route53'
140
- import * as route53Targets from 'aws-cdk-lib/aws-route53-targets'
141
- import * as common from '../../common'
142
- import * as types from '../../types'
143
- import * as utils from '../../utils'
144
-
145
- /**
146
- * @stability stable
147
- * @category cdk-utils.route53-manager
148
- * @subcategory Construct
149
- * @classdesc Provides operations on AWS Route53.
150
- * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
151
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
152
- * @example
153
- * import * as common from '@gradientedge/cdk-utils'
154
- *
155
- * class CustomConstruct extends common.common.CommonConstruct {
156
- * constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
157
- * super(parent, id, props)
158
- * this.props = props
159
- * this.route53Manager.createHostedZone('MyHostedZone', this)
160
- * }
161
- * }
162
- *
163
- * @see [CDK Route53 Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_route53-readme.html}
164
- */
165
- export class Route53Manager {
166
- /**
167
- * @summary Method to create a hosted zone
168
- * @param {string} id scoped id of the resource
169
- * @param {common.CommonConstruct} scope scope in which this resource is defined
170
- * @param {types.Route53Props} props
171
- */
172
- public createHostedZone(id: string, scope: common.CommonConstruct, props: types.Route53Props) {
173
- let hostedZone: route53.IHostedZone
174
-
175
- if (!props) throw `Route53 props undefined`
176
-
177
- if (props.useExistingHostedZone) {
178
- hostedZone = route53.HostedZone.fromLookup(scope, `${id}`, {
179
- domainName: scope.props.domainName,
180
- })
181
- } else {
182
- hostedZone = new route53.HostedZone(scope, `${id}`, {
183
- zoneName: scope.props.domainName,
184
- comment: `Hosted zone for ${scope.props.domainName}`,
185
- })
186
- }
187
-
188
- utils.createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
189
- utils.createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
190
-
191
- return hostedZone
192
- }
193
-
194
- /**
195
- * @summary Method to create/lookup a hosted zone
196
- * @param {string} id scoped id of the resource
197
- * @param {common.CommonConstruct} scope scope in which this resource is defined
198
- * @param useExistingHostedZone Flag to indicate whether to lookup vs create new hosted zone
199
- */
200
- public withHostedZoneFromFullyQualifiedDomainName(
201
- id: string,
202
- scope: common.CommonConstruct,
203
- useExistingHostedZone: boolean
204
- ) {
205
- let hostedZone: route53.IHostedZone
206
-
207
- if (useExistingHostedZone) {
208
- hostedZone = route53.HostedZone.fromLookup(scope, `${id}`, {
209
- domainName: scope.fullyQualifiedDomainName,
210
- })
211
- } else {
212
- hostedZone = new route53.HostedZone(scope, `${id}`, {
213
- zoneName: scope.fullyQualifiedDomainName,
214
- comment: `Hosted zone for ${scope.fullyQualifiedDomainName}`,
215
- })
216
- }
217
-
218
- utils.createCfnOutput(`${id}-hostedZoneId`, scope, hostedZone.hostedZoneId)
219
- utils.createCfnOutput(`${id}-hostedZoneArn`, scope, hostedZone.hostedZoneArn)
220
-
221
- return hostedZone
222
- }
223
-
224
- /**
225
- * @summary Method to create a-record for cloudfront target
226
- * @param {string} id scoped id of the resource
227
- * @param {common.CommonConstruct} scope scope in which this resource is defined
228
- * @param {cloudfront.IDistribution} distribution
229
- * @param {route53.IHostedZone} hostedZone
230
- * @param {string} recordName
231
- */
232
- public createCloudFrontTargetARecord(
233
- id: string,
234
- scope: common.CommonConstruct,
235
- distribution?: cloudfront.IDistribution,
236
- hostedZone?: route53.IHostedZone,
237
- recordName?: string
238
- ) {
239
- if (!distribution) throw `Distribution undefined`
240
- if (!hostedZone) throw `HostedZone undefined`
241
-
242
- const aRecord = new route53.ARecord(scope, `${id}`, {
243
- recordName: recordName &amp;&amp; scope.isProductionStage() ? `${recordName}` : `${recordName}-${scope.props.stage}`,
244
- target: route53.RecordTarget.fromAlias(new route53Targets.CloudFrontTarget(distribution)),
245
- zone: hostedZone,
246
- })
247
-
248
- utils.createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
249
-
250
- return aRecord
251
- }
252
-
253
- /**
254
- * @summary Method to create a-record for cloudfront target
255
- * @param {string} id scoped id of the resource
256
- * @param {common.CommonConstruct} scope scope in which this resource is defined
257
- * @param {cloudfront.IDistribution} distribution
258
- * @param {route53.IHostedZone} hostedZone
259
- * @param {string} recordName
260
- */
261
- public createCloudFrontTargetARecordV2(
262
- id: string,
263
- scope: common.CommonConstruct,
264
- distribution?: cloudfront.IDistribution,
265
- hostedZone?: route53.IHostedZone,
266
- recordName?: string
267
- ) {
268
- if (!distribution) throw `Distribution undefined`
269
- if (!hostedZone) throw `HostedZone undefined`
270
-
271
- const aRecord = new route53.ARecord(scope, `${id}`, {
272
- recordName: recordName,
273
- target: route53.RecordTarget.fromAlias(new route53Targets.CloudFrontTarget(distribution)),
274
- zone: hostedZone,
275
- })
276
-
277
- utils.createCfnOutput(`${id}-aRecordDomainName`, scope, aRecord.domainName)
278
-
279
- return aRecord
280
- }
281
-
282
- /**
283
- * @summary Method to create a-record for restApi gateway target
284
- * @param {string} id scoped id of the resource
285
- * @param {common.CommonConstruct} scope scope in which this resource is defined
286
- * @param recordName
287
- * @param apiDomain
288
- * @param hostedZone
289
- */
290
- public createApiGatewayARecord(
291
- id: string,
292
- scope: common.CommonConstruct,
293
- recordName: string,
294
- apiDomain: apig.DomainName,
295
- hostedZone: route53.IHostedZone
296
- ) {
297
- let apiRecordName = ''
298
- if (recordName &amp;&amp; recordName !== '')
299
- apiRecordName = scope.isProductionStage() ? `${recordName}` : `${recordName}-${scope.props.stage}`
300
-
301
- const apiARecord = new route53.ARecord(scope, `${id}`, {
302
- recordName: apiRecordName,
303
- target: route53.RecordTarget.fromAlias(new route53Targets.ApiGatewayDomain(apiDomain)),
304
- zone: hostedZone,
305
- })
306
-
307
- utils.createCfnOutput(`${id}-a-record-domain-name`, scope, apiARecord.domainName)
308
-
309
- return apiARecord
310
- }
311
- }
312
- </code></pre>
313
- </article>
314
- </section>
315
-
316
-
317
-
318
-
319
- </div>
320
-
321
- </div>
322
- <div id="side-nav" class="side-nav">
323
- </div>
324
- </div>
325
- <script src="scripts/app.min.js"></script>
326
- <script>PR.prettyPrint();</script>
327
- <script src="scripts/linenumber.js"> </script>
328
-
329
- <script src="scripts/search.js"> </script>
330
-
331
-
332
- </body>
333
- </html>