@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,491 +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/cloudfront-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/cloudfront-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 acm from 'aws-cdk-lib/aws-certificatemanager'
139
- import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
140
- import * as origins from 'aws-cdk-lib/aws-cloudfront-origins'
141
- import * as ec2 from 'aws-cdk-lib/aws-ec2'
142
- import * as efs from 'aws-cdk-lib/aws-efs'
143
- import * as lambda from 'aws-cdk-lib/aws-lambda'
144
- import * as s3 from 'aws-cdk-lib/aws-s3'
145
- import * as cr from 'aws-cdk-lib/custom-resources'
146
- import * as common from '../../common'
147
- import * as types from '../../types'
148
- import * as utils from '../../utils'
149
-
150
- /**
151
- * @stability stable
152
- * @category cdk-utils.cloudfront-manager
153
- * @subcategory Construct
154
- * @classdesc Provides operations on AWS CloudFront.
155
- * - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
156
- * - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
157
- * @example
158
- * import * as common from '@gradientedge/cdk-utils'
159
- *
160
- * class CustomConstruct extends common.common.CommonConstruct {
161
- * constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
162
- * super(parent, id, props)
163
- * this.props = props
164
- * this.cloudFrontManager.createCloudFrontDistribution(
165
- * 'MyDistribution',
166
- * this,
167
- * siteBucket,
168
- * logBucket,
169
- * originAccessIdentity,
170
- * certificate
171
- * )
172
- * }
173
- * }
174
- *
175
- * @see [CDK CloudFront Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_cloudfront-readme.html}
176
- */
177
- export class CloudFrontManager {
178
- public createOriginAccessIdentity(id: string, scope: common.CommonConstruct, accessBucket?: s3.IBucket) {
179
- const oai = new cloudfront.OriginAccessIdentity(scope, `${id}`, {
180
- comment: `${id} - ${scope.props.stage} stage`,
181
- })
182
- if (accessBucket) accessBucket.grantRead(oai)
183
-
184
- return oai
185
- }
186
-
187
- /**
188
- * @deprecated Use `createDistributionWithS3Origin` instead
189
- *
190
- * @summary Method to create a cloudfront distribution
191
- * @param {string} id scoped id of the resource
192
- * @param {common.CommonConstruct} scope scope in which this resource is defined
193
- * @param {types.CloudFrontProps} props distribution properties
194
- * @param {s3.IBucket?} siteBucket
195
- * @param {s3.IBucket?} logBucket
196
- * @param {cloudfront.OriginAccessIdentity?} oai
197
- * @param {acm.ICertificate?} certificate
198
- * @param {string[]?} aliases
199
- */
200
- public createCloudFrontDistribution(
201
- id: string,
202
- scope: common.CommonConstruct,
203
- props: types.CloudFrontProps,
204
- siteBucket?: s3.IBucket,
205
- logBucket?: s3.IBucket,
206
- oai?: cloudfront.OriginAccessIdentity,
207
- certificate?: acm.ICertificate,
208
- aliases?: string[]
209
- ) {
210
- if (!siteBucket) throw `SiteBucket not defined`
211
- if (!certificate) throw `Certificate not defined`
212
- if (!props) throw `CloudFront props undefined`
213
-
214
- const distribution = new cloudfront.CloudFrontWebDistribution(scope, `${id}`, {
215
- comment: `${id} - ${scope.props.stage} stage`,
216
- defaultRootObject: props.defaultRootObject,
217
- enabled: props.enabled ?? true,
218
- enableIpV6: props.enableIpV6,
219
- errorConfigurations: props.errorConfigurations,
220
- geoRestriction: props.geoRestriction,
221
- httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
222
- loggingConfig: {
223
- bucket: logBucket,
224
- prefix: 'cloudfront/',
225
- },
226
- originConfigs: [
227
- {
228
- s3OriginSource: {
229
- s3BucketSource: siteBucket,
230
- originAccessIdentity: oai,
231
- },
232
- behaviors: [{ isDefaultBehavior: true }],
233
- },
234
- ],
235
- priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
236
- viewerCertificate: cloudfront.ViewerCertificate.fromAcmCertificate(certificate, {
237
- aliases: aliases ? [...aliases, ...[siteBucket.bucketName]] : [siteBucket.bucketName],
238
- securityPolicy: cloudfront.SecurityPolicyProtocol.TLS_V1_1_2016,
239
- sslMethod: cloudfront.SSLMethod.SNI,
240
- }),
241
- webACLId: props.webACLId,
242
- })
243
-
244
- utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
245
- utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
246
-
247
- return distribution
248
- }
249
-
250
- /**
251
- * Method to create a CloudFront distribution with S3 Origin
252
- * @param {string} id scoped id of the resource
253
- * @param {common.CommonConstruct} scope scope in which this resource is defined
254
- * @param {types.DistributionProps} props distribution properties
255
- * @param {origins.S3Origin} origin
256
- * @param {s3.IBucket} siteBucket
257
- * @param {s3.IBucket?} logBucket
258
- * @param {cloudfront.OriginAccessIdentity?} oai
259
- * @param {acm.ICertificate?} certificate
260
- * @param {string[]?} aliases
261
- * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
262
- */
263
- public createDistributionWithS3Origin(
264
- id: string,
265
- scope: common.CommonConstruct,
266
- props: types.DistributionProps,
267
- origin: origins.S3Origin,
268
- siteBucket: s3.IBucket,
269
- logBucket?: s3.IBucket,
270
- oai?: cloudfront.OriginAccessIdentity,
271
- certificate?: acm.ICertificate,
272
- aliases?: string[],
273
- defaultFunctionAssociations?: cloudfront.FunctionAssociation[]
274
- ) {
275
- const distribution = new cloudfront.Distribution(scope, `${id}`, {
276
- certificate: certificate,
277
- comment: `${id} - ${scope.props.stage} stage`,
278
- defaultBehavior: {
279
- cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
280
- origin: origin,
281
- originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
282
- functionAssociations: defaultFunctionAssociations ?? undefined,
283
- },
284
- additionalBehaviors: props.additionalBehaviors,
285
- defaultRootObject: props.defaultRootObject,
286
- domainNames: aliases ? [...aliases, ...[siteBucket.bucketName]] : [siteBucket.bucketName],
287
- enabled: props.enabled ?? true,
288
- enableIpv6: props.enableIpv6,
289
- enableLogging: props.enableLogging ?? true,
290
- errorResponses: props.errorResponses,
291
- geoRestriction: props.geoRestriction,
292
- httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
293
- logBucket: logBucket,
294
- logIncludesCookies: props.logIncludesCookies ?? true,
295
- logFilePrefix: props.logFilePrefix ?? `edge/`,
296
- minimumProtocolVersion: props.minimumProtocolVersion ?? cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
297
- priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
298
- webAclId: props.webAclId,
299
- })
300
-
301
- utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
302
- utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
303
-
304
- return distribution
305
- }
306
-
307
- /**
308
- * Method to create a CloudFront distribution with HTTP Origin
309
- * @param {string} id scoped id of the resource
310
- * @param {common.CommonConstruct} scope scope in which this resource is defined
311
- * @param {types.DistributionProps} props distribution properties
312
- * @param {origins.S3Origin} origin
313
- * @param {string[]} domainNames
314
- * @param {s3.IBucket?} logBucket
315
- * @param {acm.ICertificate?} certificate
316
- * @param {cloudfront.FunctionAssociation?} defaultFunctionAssociations
317
- */
318
- public createDistributionWithHttpOrigin(
319
- id: string,
320
- scope: common.CommonConstruct,
321
- props: types.DistributionProps,
322
- origin: origins.HttpOrigin,
323
- domainNames: string[],
324
- logBucket?: s3.IBucket,
325
- certificate?: acm.ICertificate,
326
- defaultFunctionAssociations?: cloudfront.FunctionAssociation[]
327
- ) {
328
- const distribution = new cloudfront.Distribution(scope, `${id}`, {
329
- certificate: certificate,
330
- comment: `${id} - ${scope.props.stage} stage`,
331
- defaultBehavior: {
332
- cachePolicy: props.defaultBehavior ? props.defaultBehavior.cachePolicy : undefined,
333
- origin: origin,
334
- originRequestPolicy: props.defaultBehavior ? props.defaultBehavior.originRequestPolicy : undefined,
335
- functionAssociations: defaultFunctionAssociations ?? undefined,
336
- },
337
- additionalBehaviors: props.additionalBehaviors,
338
- defaultRootObject: props.defaultRootObject,
339
- domainNames: domainNames,
340
- enabled: props.enabled ?? true,
341
- enableIpv6: props.enableIpv6,
342
- enableLogging: props.enableLogging ?? true,
343
- errorResponses: props.errorResponses,
344
- geoRestriction: props.geoRestriction,
345
- httpVersion: props.httpVersion ?? cloudfront.HttpVersion.HTTP2,
346
- logBucket: logBucket,
347
- logIncludesCookies: props.logIncludesCookies ?? true,
348
- logFilePrefix: props.logFilePrefix ?? `edge/`,
349
- minimumProtocolVersion: props.minimumProtocolVersion ?? cloudfront.SecurityPolicyProtocol.TLS_V1_2_2021,
350
- priceClass: props.priceClass ?? cloudfront.PriceClass.PRICE_CLASS_ALL,
351
- webAclId: props.webAclId,
352
- })
353
-
354
- utils.createCfnOutput(`${id}-distributionId`, scope, distribution.distributionId)
355
- utils.createCfnOutput(`${id}-distributionDomainName`, scope, distribution.distributionDomainName)
356
-
357
- return distribution
358
- }
359
-
360
- /**
361
- * @summary Method to provision a Lambda@Edge function
362
- *
363
- * @param {string} id scoped id of the resource
364
- * @param {common.CommonConstruct} scope scope in which this resource is defined
365
- * @param {types.LambdaEdgeProps} props lambda@edge properties
366
- * @param {lambda.ILayerVersion[]} layers
367
- * @param {lambda.AssetCode} code
368
- * @param {Map&lt;string, string>} environment
369
- * @param {ec2.IVpc} vpc
370
- * @param {ec2.ISecurityGroup[]} securityGroups
371
- * @param {efs.IAccessPoint} accessPoint
372
- * @param {string} mountPath
373
- */
374
- public createEdgeFunction(
375
- id: string,
376
- scope: common.CommonConstruct,
377
- props: types.LambdaEdgeProps,
378
- layers: lambda.ILayerVersion[],
379
- code: lambda.AssetCode,
380
- environment?: any,
381
- vpc?: ec2.IVpc,
382
- securityGroups?: ec2.ISecurityGroup[],
383
- accessPoint?: efs.IAccessPoint,
384
- mountPath?: string
385
- ) {
386
- if (!props) throw 'EdgeFunction props undefined'
387
-
388
- const edgeFunction = new cloudfront.experimental.EdgeFunction(scope, `${id}`, {
389
- code: code,
390
- environment: {
391
- ...environment,
392
- },
393
- filesystem: accessPoint ? lambda.FileSystem.fromEfsAccessPoint(accessPoint, mountPath ?? '/mnt/msg') : undefined,
394
- functionName: `${props.functionName}-${scope.props.stage}`,
395
- handler: props.handler ?? 'index.handler',
396
- layers: layers,
397
- logRetention: props.logRetention,
398
- memorySize: props.memorySize,
399
- reservedConcurrentExecutions: props.reservedConcurrentExecutions,
400
- runtime: props.runtime ?? lambda.Runtime.NODEJS_14_X,
401
- securityGroups: securityGroups,
402
- stackId: `${id}-stack-id-${scope.props.stage}`,
403
- timeout: props.timeoutInSecs ? cdk.Duration.seconds(props.timeoutInSecs) : cdk.Duration.minutes(1),
404
- vpc: vpc,
405
- })
406
-
407
- utils.createCfnOutput(`${id}-edgeArn`, scope, edgeFunction.edgeArn)
408
- utils.createCfnOutput(`${id}-edgeFunctionArn`, scope, edgeFunction.functionArn)
409
- utils.createCfnOutput(`${id}-edgeFunctionName`, scope, edgeFunction.functionName)
410
-
411
- return edgeFunction
412
- }
413
-
414
- /**
415
- *
416
- * @param id
417
- * @param scope
418
- * @param dockerFilePath
419
- * @param distributionId
420
- * @param paths
421
- */
422
- public invalidateCache(
423
- id: string,
424
- scope: common.CommonConstruct,
425
- dockerFilePath: string,
426
- distributionId: string,
427
- paths?: string
428
- ) {
429
- new cr.AwsCustomResource(scope, `${id}-trigger-codebuild-${new Date().getTime()}`, {
430
- onCreate: {
431
- service: 'CodeBuild',
432
- action: 'startBuild',
433
- parameters: {
434
- projectName: scope.codeBuildManager.createProjectForCloudfrontInvalidation(
435
- id,
436
- scope,
437
- dockerFilePath,
438
- distributionId,
439
- paths
440
- ).projectName,
441
- },
442
- physicalResourceId: cr.PhysicalResourceId.fromResponse('build.id'),
443
- },
444
- policy: cr.AwsCustomResourcePolicy.fromSdkCalls({ resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE }),
445
- })
446
- }
447
-
448
- /**
449
- * @summary Method to provision a Cloudfront function
450
- *
451
- * @param {string} id scoped id of the resource
452
- * @param {common.CommonConstruct} scope scope in which this resource is defined
453
- * @param {types.CloudfrontFunctionProps} props
454
- */
455
- public createCloudfrontFunction(id: string, scope: common.CommonConstruct, props: types.CloudfrontFunctionProps) {
456
- const cloudfrontFunction = new cloudfront.Function(scope, `${id}`, {
457
- code: cloudfront.FunctionCode.fromFile({
458
- filePath: props.functionFilePath,
459
- }),
460
- comment: props.comment,
461
- functionName: `${props.functionName}-${scope.props.stage}`,
462
- })
463
-
464
- utils.createCfnOutput(`${id}-functionArn`, scope, cloudfrontFunction.functionArn)
465
- utils.createCfnOutput(`${id}-functionName`, scope, cloudfrontFunction.functionName)
466
-
467
- return cloudfrontFunction
468
- }
469
- }
470
- </code></pre>
471
- </article>
472
- </section>
473
-
474
-
475
-
476
-
477
- </div>
478
-
479
- </div>
480
- <div id="side-nav" class="side-nav">
481
- </div>
482
- </div>
483
- <script src="scripts/app.min.js"></script>
484
- <script>PR.prettyPrint();</script>
485
- <script src="scripts/linenumber.js"> </script>
486
-
487
- <script src="scripts/search.js"> </script>
488
-
489
-
490
- </body>
491
- </html>