@gradientedge/cdk-utils 4.4.4 → 4.4.5

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 (136) hide show
  1. package/package.json +4 -5
  2. package/api-docs/AcmManager.html +0 -622
  3. package/api-docs/AcmProps.html +0 -238
  4. package/api-docs/AlarmProps.html +0 -238
  5. package/api-docs/AlarmStatusWidgetProps.html +0 -238
  6. package/api-docs/ApiDestinationEvent.html +0 -297
  7. package/api-docs/ApiDestinationEventType.html +0 -238
  8. package/api-docs/ApiDestinedLambda.html +0 -297
  9. package/api-docs/ApiDestinedLambdaEnvironment.html +0 -238
  10. package/api-docs/ApiDestinedLambdaType.html +0 -238
  11. package/api-docs/ApiDestinedRestApi.html +0 -297
  12. package/api-docs/ApiDestinedRestApiType.html +0 -238
  13. package/api-docs/ApiManager.html +0 -766
  14. package/api-docs/ApiToEventBridgeTarget.html +0 -1877
  15. package/api-docs/ApiToEventBridgeTarget.jpg +0 -0
  16. package/api-docs/ApiToEventBridgeTargetEventProps.html +0 -238
  17. package/api-docs/ApiToEventBridgeTargetLambdaProps.html +0 -238
  18. package/api-docs/ApiToEventBridgeTargetProps.html +0 -238
  19. package/api-docs/ApiToEventBridgeTargetRestApiProps.html +0 -238
  20. package/api-docs/AppConfigManager.html +0 -1203
  21. package/api-docs/AppConfigProps.html +0 -238
  22. package/api-docs/CloudFrontManager.html +0 -2402
  23. package/api-docs/CloudFrontProps.html +0 -238
  24. package/api-docs/CloudTrailManager.html +0 -637
  25. package/api-docs/CloudTrailProps.html +0 -238
  26. package/api-docs/CloudWatchManager.html +0 -2986
  27. package/api-docs/CloudfrontFunctionProps.html +0 -238
  28. package/api-docs/CodeBuildManager.html +0 -736
  29. package/api-docs/CommonConstruct.html +0 -1299
  30. package/api-docs/CommonStack.html +0 -813
  31. package/api-docs/CommonStackProps.html +0 -238
  32. package/api-docs/DashboardProps.html +0 -238
  33. package/api-docs/DistributionProps.html +0 -238
  34. package/api-docs/DynamodbManager.html +0 -530
  35. package/api-docs/EcrManager.html +0 -530
  36. package/api-docs/EcsClusterProps.html +0 -238
  37. package/api-docs/EcsManager.html +0 -880
  38. package/api-docs/EcsTaskProps.html +0 -238
  39. package/api-docs/EksClusterProps.html +0 -238
  40. package/api-docs/EksManager.html +0 -580
  41. package/api-docs/EventBusProps.html +0 -238
  42. package/api-docs/EventManager.html +0 -1454
  43. package/api-docs/EventRuleProps.html +0 -238
  44. package/api-docs/GraphQLApiLambda.html +0 -1671
  45. package/api-docs/GraphQLApiLambda.jpg +0 -0
  46. package/api-docs/GraphQlApiLambdaEnvironment.html +0 -238
  47. package/api-docs/GraphQlApiLambdaProps.html +0 -238
  48. package/api-docs/GraphWidgetProps.html +0 -238
  49. package/api-docs/HealthCheck.html +0 -238
  50. package/api-docs/IamManager.html +0 -3821
  51. package/api-docs/LambdaEdgeProps.html +0 -238
  52. package/api-docs/LambdaEnvironment.html +0 -238
  53. package/api-docs/LambdaManager.html +0 -2378
  54. package/api-docs/LambdaProps.html +0 -238
  55. package/api-docs/LifecycleRule.html +0 -238
  56. package/api-docs/LogManager.html +0 -955
  57. package/api-docs/LogProps.html +0 -238
  58. package/api-docs/LogQueryWidgetProps.html +0 -238
  59. package/api-docs/MetricFilterProps.html +0 -238
  60. package/api-docs/MetricProps.html +0 -238
  61. package/api-docs/NumericWidgetProps.html +0 -238
  62. package/api-docs/Route53Manager.html +0 -1460
  63. package/api-docs/Route53Props.html +0 -238
  64. package/api-docs/RuleProps.html +0 -238
  65. package/api-docs/S3BucketProps.html +0 -238
  66. package/api-docs/S3Manager.html +0 -1546
  67. package/api-docs/SSMParameterReader.html +0 -431
  68. package/api-docs/SSMParameterReaderProps.html +0 -238
  69. package/api-docs/SecretsManager.html +0 -1140
  70. package/api-docs/SiteWithEcsBackend.html +0 -2391
  71. package/api-docs/SiteWithEcsBackendProps.html +0 -238
  72. package/api-docs/SnsManager.html +0 -780
  73. package/api-docs/SsmManager.html +0 -955
  74. package/api-docs/StaticSite.html +0 -1358
  75. package/api-docs/StaticSiteProps.html +0 -238
  76. package/api-docs/SubscriptionProps.html +0 -238
  77. package/api-docs/TableProps.html +0 -238
  78. package/api-docs/TextWidgetProps.html +0 -238
  79. package/api-docs/VpcManager.html +0 -986
  80. package/api-docs/WafIPSetProps.html +0 -238
  81. package/api-docs/WafManager.html +0 -730
  82. package/api-docs/WafWebACLProps.html +0 -238
  83. package/api-docs/common_construct.ts.html +0 -279
  84. package/api-docs/common_stack.ts.html +0 -303
  85. package/api-docs/construct_api-to-eventbridge-target_api-destination-event.ts.html +0 -175
  86. package/api-docs/construct_api-to-eventbridge-target_api-destined-lambda.ts.html +0 -178
  87. package/api-docs/construct_api-to-eventbridge-target_api-destined-rest-api.ts.html +0 -190
  88. package/api-docs/construct_api-to-eventbridge-target_main.ts.html +0 -751
  89. package/api-docs/construct_graphql-api-lambda_main.ts.html +0 -408
  90. package/api-docs/construct_site-with-ecs-backend_main.ts.html +0 -544
  91. package/api-docs/construct_static-site_main.ts.html +0 -374
  92. package/api-docs/global.html +0 -1530
  93. package/api-docs/index.html +0 -208
  94. package/api-docs/logo.png +0 -0
  95. package/api-docs/manager_aws_acm-manager.ts.html +0 -236
  96. package/api-docs/manager_aws_api-manager.ts.html +0 -260
  97. package/api-docs/manager_aws_app-config-manager.ts.html +0 -310
  98. package/api-docs/manager_aws_cloudfront-manager.ts.html +0 -491
  99. package/api-docs/manager_aws_cloudtrail-manager.ts.html +0 -251
  100. package/api-docs/manager_aws_cloudwatch-manager.ts.html +0 -553
  101. package/api-docs/manager_aws_codebuild-manager.ts.html +0 -240
  102. package/api-docs/manager_aws_dynamodb-manager.ts.html +0 -219
  103. package/api-docs/manager_aws_ecr-manager.ts.html +0 -199
  104. package/api-docs/manager_aws_ecs-manager.ts.html +0 -259
  105. package/api-docs/manager_aws_eks-manager.ts.html +0 -260
  106. package/api-docs/manager_aws_event-manager.ts.html +0 -336
  107. package/api-docs/manager_aws_iam-manager.ts.html +0 -573
  108. package/api-docs/manager_aws_lambda-manager.ts.html +0 -400
  109. package/api-docs/manager_aws_log-manager.ts.html +0 -259
  110. package/api-docs/manager_aws_route53-manager.ts.html +0 -333
  111. package/api-docs/manager_aws_s3-manager.ts.html +0 -361
  112. package/api-docs/manager_aws_secrets-manager.ts.html +0 -274
  113. package/api-docs/manager_aws_sns-manager.ts.html +0 -246
  114. package/api-docs/manager_aws_ssm-manager.ts.html +0 -273
  115. package/api-docs/manager_aws_vpc-manager.ts.html +0 -244
  116. package/api-docs/manager_aws_waf-manager.ts.html +0 -232
  117. package/api-docs/scripts/app.min.js +0 -1
  118. package/api-docs/scripts/linenumber.js +0 -26
  119. package/api-docs/scripts/search.js +0 -39
  120. package/api-docs/styles/app.min.css +0 -1
  121. package/api-docs/styles/iframe.css +0 -13
  122. package/api-docs/styles/prettify-jsdoc.css +0 -111
  123. package/api-docs/styles/prettify-tomorrow.css +0 -132
  124. package/api-docs/styles/reset.css +0 -44
  125. package/api-docs/styles.css +0 -113
  126. package/api-docs/tutorial-Architecture.html +0 -151
  127. package/api-docs/tutorial-Build.html +0 -150
  128. package/api-docs/tutorial-CI-CD.html +0 -154
  129. package/api-docs/tutorial-Development.html +0 -227
  130. package/api-docs/types_aws_index.ts.html +0 -665
  131. package/api-docs/utils_aws_index.ts.html +0 -192
  132. package/api-docs/utils_index.ts.html +0 -227
  133. package/img/ApiToEventBridgeTarget.jpg +0 -0
  134. package/img/GraphQLApiLambda.jpg +0 -0
  135. package/img/logo.png +0 -0
  136. package/theme/styles.css +0 -113
@@ -1,1299 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
-
6
- <meta charset="utf-8">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <title>Gradient Edge CDK Utils CommonConstruct</title>
9
-
10
- <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
11
- <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
12
- <script src="./build/entry.js"></script>
13
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
14
- <!--[if lt IE 9]>
15
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
- <![endif]-->
17
- <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
18
- <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
19
- <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
20
- <link type="text/css" rel="stylesheet" href="styles/app.min.css">
21
- <link type="text/css" rel="stylesheet" href="styles/iframe.css">
22
- <link type="text/css" rel="stylesheet" href="styles.css">
23
- <script async defer src="https://buttons.github.io/buttons.js"></script>
24
-
25
-
26
- </head>
27
-
28
-
29
-
30
- <body class="layout small-header">
31
- <div id="stickyNavbarOverlay"></div>
32
-
33
-
34
- <div class="top-nav">
35
- <div class="inner">
36
- <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
37
- <span aria-hidden="true"></span>
38
- <span aria-hidden="true"></span>
39
- <span aria-hidden="true"></span>
40
- </a>
41
- <div class="logo">
42
-
43
- <a class="image" href="index.html">
44
- <img src="logo.png" alt="logo">
45
- </a>
46
-
47
-
48
- <a href="index.html">
49
- <h1 class="navbar-item">Gradient Edge CDK Utils Documentation</h1>
50
- </a>
51
-
52
- </div>
53
- <div class="menu">
54
-
55
- <div class="navigation">
56
- <a
57
- href="index.html"
58
- class="link"
59
- >
60
- API Documentation
61
- </a>
62
-
63
- <div class="dropdown is-hoverable is-right">
64
- <a class="dropdown-trigger link">
65
- Tutorials
66
- <i class="fas fa-chevron-down fa-xs"></i>
67
- </a>
68
- <div class="dropdown-menu">
69
- <div class="dropdown-content">
70
-
71
- <a class="dropdown-item" href="tutorial-Architecture.html">
72
- Architecture
73
- </a>
74
-
75
- <a class="dropdown-item" href="tutorial-Build.html">
76
- Build
77
- </a>
78
-
79
- <a class="dropdown-item" href="tutorial-CI-CD.html">
80
- CI-CD
81
- </a>
82
-
83
- <a class="dropdown-item" href="tutorial-Development.html">
84
- Development
85
- </a>
86
-
87
- </div>
88
- </div>
89
- </div>
90
-
91
-
92
-
93
- <a
94
- class="link user-link "
95
- href="https://github.com/gradientedge/cdk-utils"
96
- >
97
- Github
98
- </a>
99
-
100
-
101
-
102
- </div>
103
- </div>
104
- </div>
105
- </div>
106
- <div id="main">
107
- <div
108
- class="sidebar "
109
- id="sidebarNav"
110
- >
111
-
112
- <div class="search-wrapper">
113
- <input id="search" type="text" placeholder="Search docs..." class="input">
114
- </div>
115
-
116
- <nav>
117
-
118
- <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>
119
-
120
- </nav>
121
- </div>
122
- <div class="core" id="main-content-wrapper">
123
- <div class="content">
124
- <header class="page-title">
125
- <p>Class</p>
126
- <h1>CommonConstruct</h1>
127
- </header>
128
-
129
-
130
-
131
-
132
-
133
- <section>
134
-
135
- <header>
136
-
137
- <h2><span class="attribs"><span class="type-signature"></span></span>CommonConstruct<span class="signature">()</span><span class="type-signature"></span></h2>
138
-
139
- <div class="class-description"><p>Common construct to use as a base for all higher level constructs.</p></div>
140
-
141
-
142
- </header>
143
-
144
- <article>
145
- <div class="container-overview">
146
-
147
-
148
- <div class='vertical-section'>
149
- <div class="members">
150
- <div class="member">
151
- <div class=name>
152
- <span class="tag">Constructor</span>
153
- </div>
154
-
155
-
156
-
157
-
158
- <h4 class="name" id="CommonConstruct">
159
- <a class="href-link" href="#CommonConstruct">#</a>
160
-
161
- <span class="code-name">
162
-
163
- new CommonConstruct<span class="signature">()</span><span class="type-signature"></span>
164
-
165
- </span>
166
- </h4>
167
-
168
-
169
-
170
-
171
- <div class="description">
172
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
173
- </div>
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
- <dl class="details">
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
- <p class="tag-source">
221
- <a href="common_construct.ts.html" class="button">View Source</a>
222
- <span>
223
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line21">line 21</a>
224
- </span>
225
- </p>
226
-
227
- </dl>
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
- <h5>Example</h5>
250
-
251
-
252
- <pre class="prettyprint"><code>import { CommonConstruct } from '@gradientedge/cdk-utils';
253
-
254
- class CustomConstruct extends CommonConstruct {
255
- constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
256
- super(parent, id, props);
257
- this.props = props;
258
- };
259
- };</code></pre>
260
-
261
-
262
-
263
-
264
- </div>
265
- </div>
266
- </div>
267
-
268
-
269
- </div>
270
-
271
-
272
-
273
-
274
-
275
-
276
- <h3 class="subsection-title">Classes</h3>
277
-
278
- <dl>
279
- <dt><a href="CommonConstruct.html">CommonConstruct</a></dt>
280
- <dd></dd>
281
- </dl>
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
- <div class='vertical-section'>
292
- <h1>Members</h1>
293
- <div class="members">
294
-
295
- <div class="member">
296
-
297
- <h4 class="name" id="isDevelopmentStage">
298
- <a class="href-link" href="#isDevelopmentStage">#</a>
299
-
300
- <span class="code-name">
301
- isDevelopmentStage
302
- </span>
303
-
304
- </h4>
305
-
306
-
307
- <p class="summary"><p>Utility method to determine if the initialisation is in development (dev) stage
308
- This is determined by the stage property injected via cdk context</p></p>
309
-
310
-
311
-
312
- <div class="description">
313
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
314
- </div>
315
-
316
-
317
-
318
-
319
-
320
- <dl class="details">
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
-
352
- <p class="tag-source">
353
- <a href="common_construct.ts.html" class="button">View Source</a>
354
- <span>
355
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line95">line 95</a>
356
- </span>
357
- </p>
358
-
359
- </dl>
360
-
361
-
362
-
363
-
364
-
365
- </div>
366
-
367
- <div class="member">
368
-
369
- <h4 class="name" id="isDevelopmentStage">
370
- <a class="href-link" href="#isDevelopmentStage">#</a>
371
-
372
- <span class="code-name">
373
- isDevelopmentStage
374
- </span>
375
-
376
- </h4>
377
-
378
-
379
- <p class="summary"><p>Utility method to determine if the initialisation is in development (dev) stage
380
- This is determined by the stage property injected via cdk context</p></p>
381
-
382
-
383
-
384
- <div class="description">
385
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
386
- </div>
387
-
388
-
389
-
390
-
391
-
392
- <dl class="details">
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
-
423
-
424
- <p class="tag-source">
425
- <a href="common_construct.ts.html" class="button">View Source</a>
426
- <span>
427
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line141">line 141</a>
428
- </span>
429
- </p>
430
-
431
- </dl>
432
-
433
-
434
-
435
-
436
-
437
- </div>
438
-
439
- <div class="member">
440
-
441
- <h4 class="name" id="isProductionStage">
442
- <a class="href-link" href="#isProductionStage">#</a>
443
-
444
- <span class="code-name">
445
- isProductionStage
446
- </span>
447
-
448
- </h4>
449
-
450
-
451
- <p class="summary"><p>Utility method to determine if the initialisation is in production (prd) stage
452
- This is determined by the stage property injected via cdk context</p></p>
453
-
454
-
455
-
456
- <div class="description">
457
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
458
- </div>
459
-
460
-
461
-
462
-
463
-
464
- <dl class="details">
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
- <p class="tag-source">
497
- <a href="common_construct.ts.html" class="button">View Source</a>
498
- <span>
499
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line110">line 110</a>
500
- </span>
501
- </p>
502
-
503
- </dl>
504
-
505
-
506
-
507
-
508
-
509
- </div>
510
-
511
- <div class="member">
512
-
513
- <h4 class="name" id="isProductionStage">
514
- <a class="href-link" href="#isProductionStage">#</a>
515
-
516
- <span class="code-name">
517
- isProductionStage
518
- </span>
519
-
520
- </h4>
521
-
522
-
523
- <p class="summary"><p>Utility method to determine if the initialisation is in production (prd) stage
524
- This is determined by the stage property injected via cdk context</p></p>
525
-
526
-
527
-
528
- <div class="description">
529
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
530
- </div>
531
-
532
-
533
-
534
-
535
-
536
- <dl class="details">
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
-
564
-
565
-
566
-
567
-
568
- <p class="tag-source">
569
- <a href="common_construct.ts.html" class="button">View Source</a>
570
- <span>
571
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line159">line 159</a>
572
- </span>
573
- </p>
574
-
575
- </dl>
576
-
577
-
578
-
579
-
580
-
581
- </div>
582
-
583
- <div class="member">
584
-
585
- <h4 class="name" id="isTestStage">
586
- <a class="href-link" href="#isTestStage">#</a>
587
-
588
- <span class="code-name">
589
- isTestStage
590
- </span>
591
-
592
- </h4>
593
-
594
-
595
- <p class="summary"><p>Utility method to determine if the initialisation is in test (tst) stage
596
- This is determined by the stage property injected via cdk context</p></p>
597
-
598
-
599
-
600
- <div class="description">
601
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
602
- </div>
603
-
604
-
605
-
606
-
607
-
608
- <dl class="details">
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
- <p class="tag-source">
641
- <a href="common_construct.ts.html" class="button">View Source</a>
642
- <span>
643
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line100">line 100</a>
644
- </span>
645
- </p>
646
-
647
- </dl>
648
-
649
-
650
-
651
-
652
-
653
- </div>
654
-
655
- <div class="member">
656
-
657
- <h4 class="name" id="isTestStage">
658
- <a class="href-link" href="#isTestStage">#</a>
659
-
660
- <span class="code-name">
661
- isTestStage
662
- </span>
663
-
664
- </h4>
665
-
666
-
667
- <p class="summary"><p>Utility method to determine if the initialisation is in test (tst) stage
668
- This is determined by the stage property injected via cdk context</p></p>
669
-
670
-
671
-
672
- <div class="description">
673
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
674
- </div>
675
-
676
-
677
-
678
-
679
-
680
- <dl class="details">
681
-
682
-
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
-
709
-
710
-
711
-
712
- <p class="tag-source">
713
- <a href="common_construct.ts.html" class="button">View Source</a>
714
- <span>
715
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line147">line 147</a>
716
- </span>
717
- </p>
718
-
719
- </dl>
720
-
721
-
722
-
723
-
724
-
725
- </div>
726
-
727
- <div class="member">
728
-
729
- <h4 class="name" id="isUatStage">
730
- <a class="href-link" href="#isUatStage">#</a>
731
-
732
- <span class="code-name">
733
- isUatStage
734
- </span>
735
-
736
- </h4>
737
-
738
-
739
- <p class="summary"><p>Utility method to determine if the initialisation is in uat (uat) stage
740
- This is determined by the stage property injected via cdk context</p></p>
741
-
742
-
743
-
744
- <div class="description">
745
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
746
- </div>
747
-
748
-
749
-
750
-
751
-
752
- <dl class="details">
753
-
754
-
755
-
756
-
757
-
758
-
759
-
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
-
784
- <p class="tag-source">
785
- <a href="common_construct.ts.html" class="button">View Source</a>
786
- <span>
787
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line105">line 105</a>
788
- </span>
789
- </p>
790
-
791
- </dl>
792
-
793
-
794
-
795
-
796
-
797
- </div>
798
-
799
- <div class="member">
800
-
801
- <h4 class="name" id="isUatStage">
802
- <a class="href-link" href="#isUatStage">#</a>
803
-
804
- <span class="code-name">
805
- isUatStage
806
- </span>
807
-
808
- </h4>
809
-
810
-
811
- <p class="summary"><p>Utility method to determine if the initialisation is in uat (uat) stage
812
- This is determined by the stage property injected via cdk context</p></p>
813
-
814
-
815
-
816
- <div class="description">
817
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
818
- </div>
819
-
820
-
821
-
822
-
823
-
824
- <dl class="details">
825
-
826
-
827
-
828
-
829
-
830
-
831
-
832
-
833
-
834
-
835
-
836
-
837
-
838
-
839
-
840
-
841
-
842
-
843
-
844
-
845
-
846
-
847
-
848
-
849
-
850
-
851
-
852
-
853
-
854
-
855
-
856
- <p class="tag-source">
857
- <a href="common_construct.ts.html" class="button">View Source</a>
858
- <span>
859
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line153">line 153</a>
860
- </span>
861
- </p>
862
-
863
- </dl>
864
-
865
-
866
-
867
-
868
-
869
- </div>
870
-
871
- </div>
872
- </div>
873
-
874
-
875
-
876
- <div class='vertical-section'>
877
- <h1>Methods</h1>
878
- <div class="members">
879
-
880
- <div class="member">
881
-
882
-
883
-
884
- <h4 class="name" id="addCfnOutput">
885
- <a class="href-link" href="#addCfnOutput">#</a>
886
-
887
-
888
- <span class='tag'>protected</span>
889
-
890
-
891
- <span class="code-name">
892
-
893
- addCfnOutput<span class="signature">(id, value, description<span class="signature-attributes">nullable</span>, overrideId)</span><span class="type-signature"> &rarr; {cdk.CfnOutput}</span>
894
-
895
- </span>
896
- </h4>
897
-
898
-
899
-
900
- <p class="summary"><p>Helper method to add CloudFormation outputs from the construct</p></p>
901
-
902
-
903
- <div class="description">
904
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
905
- </div>
906
-
907
-
908
-
909
-
910
-
911
-
912
-
913
-
914
-
915
-
916
- <h5>Parameters:</h5>
917
-
918
- <div class="table-container">
919
- <table class="params table">
920
- <thead>
921
- <tr>
922
-
923
- <th>Name</th>
924
-
925
-
926
- <th>Type</th>
927
-
928
-
929
- <th>Attributes</th>
930
-
931
-
932
-
933
-
934
- <th class="last">Description</th>
935
- </tr>
936
- </thead>
937
-
938
- <tbody>
939
-
940
-
941
-
942
- <tr class="deep-level-0">
943
-
944
- <td class="name"><code>id</code></td>
945
-
946
-
947
- <td class="type">
948
-
949
-
950
- <code class="param-type">string</code>
951
-
952
-
953
-
954
- </td>
955
-
956
-
957
- <td class="attributes">
958
-
959
-
960
-
961
-
962
-
963
- </td>
964
-
965
-
966
-
967
-
968
- <td class="description last"><p>scoped id of the resource</p></td>
969
- </tr>
970
-
971
-
972
-
973
-
974
-
975
- <tr class="deep-level-0">
976
-
977
- <td class="name"><code>value</code></td>
978
-
979
-
980
- <td class="type">
981
-
982
-
983
- <code class="param-type">string</code>
984
-
985
-
986
-
987
- </td>
988
-
989
-
990
- <td class="attributes">
991
-
992
-
993
-
994
-
995
-
996
- </td>
997
-
998
-
999
-
1000
-
1001
- <td class="description last"><p>the value of the exported output</p></td>
1002
- </tr>
1003
-
1004
-
1005
-
1006
-
1007
-
1008
- <tr class="deep-level-0">
1009
-
1010
- <td class="name"><code>description</code></td>
1011
-
1012
-
1013
- <td class="type">
1014
-
1015
-
1016
- <code class="param-type">string</code>
1017
-
1018
-
1019
-
1020
- </td>
1021
-
1022
-
1023
- <td class="attributes">
1024
-
1025
-
1026
-
1027
- &lt;nullable><br>
1028
-
1029
-
1030
-
1031
- </td>
1032
-
1033
-
1034
-
1035
-
1036
- <td class="description last"><p>optional description for the output</p></td>
1037
- </tr>
1038
-
1039
-
1040
-
1041
-
1042
-
1043
- <tr class="deep-level-0">
1044
-
1045
- <td class="name"><code>overrideId</code></td>
1046
-
1047
-
1048
- <td class="type">
1049
-
1050
-
1051
- <code class="param-type">boolean</code>
1052
-
1053
-
1054
-
1055
- </td>
1056
-
1057
-
1058
- <td class="attributes">
1059
-
1060
-
1061
-
1062
-
1063
-
1064
- </td>
1065
-
1066
-
1067
-
1068
-
1069
- <td class="description last"><p>Flag which indicates whether to override the default logical id of the output</p></td>
1070
- </tr>
1071
-
1072
-
1073
-
1074
- </tbody>
1075
- </table>
1076
- </div>
1077
-
1078
-
1079
-
1080
-
1081
-
1082
- <dl class="details">
1083
-
1084
-
1085
-
1086
-
1087
-
1088
-
1089
-
1090
-
1091
-
1092
-
1093
-
1094
-
1095
-
1096
-
1097
-
1098
-
1099
-
1100
-
1101
-
1102
-
1103
-
1104
-
1105
-
1106
-
1107
-
1108
-
1109
-
1110
-
1111
-
1112
-
1113
-
1114
- <p class="tag-source">
1115
- <a href="common_construct.ts.html" class="button">View Source</a>
1116
- <span>
1117
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line129">line 129</a>
1118
- </span>
1119
- </p>
1120
-
1121
- </dl>
1122
-
1123
-
1124
-
1125
-
1126
-
1127
-
1128
-
1129
-
1130
-
1131
-
1132
-
1133
-
1134
-
1135
-
1136
-
1137
-
1138
-
1139
-
1140
- <div class='columns method-parameter'>
1141
- <div class="column is-2"><label>Returns:</label></div>
1142
- <div class="column is-10">
1143
-
1144
-
1145
-
1146
- <div class="columns">
1147
-
1148
-
1149
- <div class='column is-5 has-text-left'>
1150
- <label>Type: </label>
1151
-
1152
- <code class="param-type">cdk.CfnOutput</code>
1153
-
1154
-
1155
- </div>
1156
-
1157
- </div>
1158
-
1159
-
1160
- </div>
1161
- </div>
1162
-
1163
-
1164
-
1165
-
1166
- </div>
1167
-
1168
- <div class="member">
1169
-
1170
-
1171
-
1172
- <h4 class="name" id="determineFullyQualifiedDomain">
1173
- <a class="href-link" href="#determineFullyQualifiedDomain">#</a>
1174
-
1175
-
1176
- <span class='tag'>protected</span>
1177
-
1178
-
1179
- <span class="code-name">
1180
-
1181
- determineFullyQualifiedDomain<span class="signature">()</span><span class="type-signature"></span>
1182
-
1183
- </span>
1184
- </h4>
1185
-
1186
-
1187
-
1188
- <p class="summary"><p>Determine the fully qualified domain name based on domainName &amp; subDomain</p></p>
1189
-
1190
-
1191
- <div class="description">
1192
- <script type="text/javascript" src="https://unpkg.com/mermaid@7.1.0/dist/mermaid.min.js"></script>
1193
- </div>
1194
-
1195
-
1196
-
1197
-
1198
-
1199
-
1200
-
1201
-
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
- <dl class="details">
1209
-
1210
-
1211
-
1212
-
1213
-
1214
-
1215
-
1216
-
1217
-
1218
-
1219
-
1220
-
1221
-
1222
-
1223
-
1224
-
1225
-
1226
-
1227
-
1228
-
1229
-
1230
-
1231
-
1232
-
1233
-
1234
-
1235
-
1236
-
1237
-
1238
-
1239
-
1240
- <p class="tag-source">
1241
- <a href="common_construct.ts.html" class="button">View Source</a>
1242
- <span>
1243
- <a href="common_construct.ts.html">common/construct.ts</a>, <a href="common_construct.ts.html#line135">line 135</a>
1244
- </span>
1245
- </p>
1246
-
1247
- </dl>
1248
-
1249
-
1250
-
1251
-
1252
-
1253
-
1254
-
1255
-
1256
-
1257
-
1258
-
1259
-
1260
-
1261
-
1262
-
1263
-
1264
-
1265
-
1266
-
1267
-
1268
-
1269
- </div>
1270
-
1271
- </div>
1272
- </div>
1273
-
1274
-
1275
-
1276
-
1277
-
1278
- </article>
1279
-
1280
- </section>
1281
-
1282
-
1283
-
1284
-
1285
- </div>
1286
-
1287
- </div>
1288
- <div id="side-nav" class="side-nav">
1289
- </div>
1290
- </div>
1291
- <script src="scripts/app.min.js"></script>
1292
- <script>PR.prettyPrint();</script>
1293
- <script src="scripts/linenumber.js"> </script>
1294
-
1295
- <script src="scripts/search.js"> </script>
1296
-
1297
-
1298
- </body>
1299
- </html>