@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,665 +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 types/aws/index.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>types/aws/index.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 apig from 'aws-cdk-lib/aws-apigateway'
139
- import * as appconfig from 'aws-cdk-lib/aws-appconfig'
140
- import * as acm from 'aws-cdk-lib/aws-certificatemanager'
141
- import * as cloudfront from 'aws-cdk-lib/aws-cloudfront'
142
- import * as cloudtrail from 'aws-cdk-lib/aws-cloudtrail'
143
- import * as watch from 'aws-cdk-lib/aws-cloudwatch'
144
- import * as dynamodb from 'aws-cdk-lib/aws-dynamodb'
145
- import * as ec2 from 'aws-cdk-lib/aws-ec2'
146
- import * as ecs from 'aws-cdk-lib/aws-ecs'
147
- import * as ecsPatterns from 'aws-cdk-lib/aws-ecs-patterns'
148
- import * as eks from 'aws-cdk-lib/aws-eks'
149
- import * as elb from 'aws-cdk-lib/aws-elasticloadbalancingv2'
150
- import * as events from 'aws-cdk-lib/aws-events'
151
- import * as iam from 'aws-cdk-lib/aws-iam'
152
- import * as lambda from 'aws-cdk-lib/aws-lambda'
153
- import * as destinations from 'aws-cdk-lib/aws-lambda-destinations'
154
- import * as logs from 'aws-cdk-lib/aws-logs'
155
- import * as route53 from 'aws-cdk-lib/aws-route53'
156
- import * as s3 from 'aws-cdk-lib/aws-s3'
157
- import * as s3deploy from 'aws-cdk-lib/aws-s3-deployment'
158
- import * as sns from 'aws-cdk-lib/aws-sns'
159
- import * as wafv2 from 'aws-cdk-lib/aws-wafv2'
160
- import * as types from '../index'
161
-
162
- /**
163
- * @category cdk-utils.app-config-manager
164
- * @subcategory Properties
165
- */
166
- export interface AppConfigProps {
167
- id: string
168
- application: appconfig.CfnApplicationProps
169
- configurationProfile: appconfig.CfnConfigurationProfileProps
170
- deployment: appconfig.CfnDeploymentProps
171
- deploymentStrategy: appconfig.CfnDeploymentStrategyProps
172
- environment: appconfig.CfnEnvironmentProps
173
- }
174
-
175
- /**
176
- * @category cdk-utils.common-stack
177
- * @subcategory Properties
178
- */
179
- export interface CommonStackProps extends cdk.StackProps {
180
- name: string
181
- region: string
182
- stage: string
183
- domainName: string
184
- subDomain?: string
185
- extraContexts?: string[]
186
- stageContextPath?: string
187
- }
188
-
189
- /**
190
- * @category cdk-utils.site-with-ecs-backend
191
- * @subcategory Properties
192
- */
193
- export interface SiteWithEcsBackendProps extends CommonStackProps {
194
- siteCacheInvalidationDockerFilePath?: string
195
- siteHealthCheck: HealthCheck
196
- siteCertificate: AcmProps
197
- siteCluster: EcsClusterProps
198
- siteDistribution: DistributionProps
199
- siteCloudfrontFunctionProps?: CloudfrontFunctionProps
200
- siteFunctionFilePath?: string
201
- siteEcsContainerImagePath: string
202
- siteLog: LogProps
203
- siteLogBucket: S3BucketProps
204
- siteRecordName?: string
205
- siteSubDomain: string
206
- siteTask: ecsPatterns.ApplicationLoadBalancedFargateServiceProps
207
- siteVpc: ec2.VpcProps
208
- useExistingHostedZone: boolean
209
- nodeEnv: string
210
- logLevel: string
211
- timezone: string
212
- }
213
-
214
- /**
215
- * @category cdk-utils.static-site
216
- * @subcategory Properties
217
- */
218
- export interface StaticSiteProps extends CommonStackProps {
219
- siteCreateAltARecord: boolean
220
- siteCertificate: AcmProps
221
- siteBucket: S3BucketProps
222
- siteLogBucket: S3BucketProps
223
- siteDistribution?: DistributionProps
224
- siteCloudfrontFunctionProps?: CloudfrontFunctionProps
225
- siteFunctionFilePath?: string
226
- siteSource: s3deploy.ISource
227
- siteHostedZoneDomainName?: string
228
- siteRecordName?: string
229
- siteSubDomain?: string
230
- siteAliases?: string[]
231
- useExistingHostedZone: boolean
232
- nodeEnv: string
233
- logLevel: string
234
- timezone: string
235
- }
236
-
237
- /**
238
- * @category cdk-utils.site-with-ecs-backend
239
- * @subcategory Properties
240
- */
241
- export interface HealthCheck extends elb.HealthCheck {
242
- intervalInSecs: number
243
- timeoutInSecs: number
244
- }
245
-
246
- /**
247
- * @category cdk-utils.lambda-manager
248
- * @subcategory Types
249
- */
250
- export interface LambdaEnvironment {
251
- NODE_ENV: string
252
- LOG_LEVEL: string
253
- TZ: string
254
- }
255
-
256
- /**
257
- * @category cdk-utils.api-to-eventbridge-target
258
- * @subcategory Types
259
- */
260
- export interface ApiDestinedLambdaEnvironment extends LambdaEnvironment {
261
- SOURCE_ID: string
262
- }
263
-
264
- /**
265
- * @category cdk-utils.graphql-api-lambda
266
- * @subcategory Types
267
- */
268
- export interface GraphQlApiLambdaEnvironment extends LambdaEnvironment {}
269
-
270
- /**
271
- * @category cdk-utils.graphql-api-lambda
272
- * @subcategory Properties
273
- */
274
- export interface GraphQlApiLambdaProps extends CommonStackProps {
275
- apiRootPaths?: string[]
276
- apiSubDomain: string
277
- graphQLApiCertificate: AcmProps
278
- graphqlRestApi: apig.LambdaRestApiProps
279
- graphqlApiLambdaLayerSources?: lambda.AssetCode[]
280
- graphQLApiHandler: string
281
- graphQLApiSource: lambda.AssetCode
282
- graphqlApi: LambdaProps
283
- useExistingHostedZone: boolean
284
- nodeEnv: string
285
- logLevel: string
286
- timezone: string
287
- }
288
-
289
- /**
290
- * @category cdk-utils.api-to-eventbridge-target
291
- * @subcategory Types
292
- */
293
- export interface ApiDestinationEventType {
294
- eventBus: events.IEventBus
295
- logGroupFailure: logs.LogGroup
296
- logGroupSuccess: logs.LogGroup
297
- ruleFailure: events.Rule
298
- ruleSuccess: events.Rule
299
- }
300
-
301
- /**
302
- * @category cdk-utils.api-to-eventbridge-target
303
- * @subcategory Types
304
- */
305
- export interface ApiDestinedRestApiType {
306
- api: apig.RestApi
307
- certificate: acm.ICertificate
308
- domain: apig.DomainName
309
- errorResponseModel: apig.Model
310
- hostedZone: route53.IHostedZone
311
- integration: apig.Integration
312
- integrationErrorResponse: apig.IntegrationResponse
313
- integrationRequestParameters: { [p: string]: string }
314
- integrationRequestTemplates: { [p: string]: string }
315
- integrationResponse: apig.IntegrationResponse
316
- method: apig.Method
317
- methodErrorResponse: apig.MethodResponse
318
- methodResponse: apig.MethodResponse
319
- resource: apig.Resource
320
- responseModel: apig.Model
321
- topic: sns.Topic
322
- topicRole: iam.Role
323
- }
324
-
325
- /**
326
- * @category cdk-utils.api-to-eventbridge-target
327
- * @subcategory Types
328
- */
329
- export interface ApiDestinedLambdaType {
330
- destinationFailure: destinations.EventBridgeDestination
331
- destinationSuccess: destinations.EventBridgeDestination
332
- environment: types.ApiDestinedLambdaEnvironment
333
- function: lambda.Function
334
- layers: lambda.LayerVersion[]
335
- policy: iam.PolicyDocument
336
- role: iam.Role
337
- }
338
-
339
- /**
340
- * @category cdk-utils.api-to-eventbridge-target
341
- * @subcategory Properties
342
- */
343
- export interface ApiToEventBridgeTargetRestApiProps {
344
- certificate: AcmProps
345
- integrationResponse?: apig.IntegrationResponse
346
- integrationErrorResponse?: apig.IntegrationResponse
347
- methodResponse?: apig.MethodResponse
348
- methodErrorResponse?: apig.MethodResponse
349
- integrationOptions?: apig.IntegrationOptions
350
- resource: string
351
- errorResponseModel?: apig.ModelOptions
352
- responseModel?: apig.ModelOptions
353
- restApi?: apig.RestApiProps
354
- }
355
-
356
- /**
357
- * @category cdk-utils.api-to-eventbridge-target
358
- * @subcategory Properties
359
- */
360
- interface ApiToEventBridgeTargetLambdaProps {
361
- useNative?: boolean
362
- function: LambdaProps
363
- source?: lambda.AssetCode
364
- layerSource?: lambda.AssetCode
365
- }
366
-
367
- /**
368
- * @category cdk-utils.api-to-eventbridge-target
369
- * @subcategory Properties
370
- */
371
- interface ApiToEventBridgeTargetEventProps {
372
- eventBusName?: string
373
- logGroupSuccess?: LogProps
374
- logGroupFailure?: LogProps
375
- ruleSuccess: EventRuleProps
376
- ruleFailure: EventRuleProps
377
- }
378
-
379
- /**
380
- * @category cdk-utils.api-to-eventbridge-target
381
- * @subcategory Properties
382
- */
383
- export interface ApiToEventBridgeTargetProps extends CommonStackProps {
384
- apiRootPaths?: string[]
385
- apiSubDomain: string
386
- api: ApiToEventBridgeTargetRestApiProps
387
- event: ApiToEventBridgeTargetEventProps
388
- lambda: ApiToEventBridgeTargetLambdaProps
389
- logLevel: string
390
- nodeEnv: string
391
- timezone: string
392
- useExistingHostedZone: boolean
393
- }
394
-
395
- /**
396
- * @category cdk-utils.acm-manager
397
- * @subcategory Properties
398
- */
399
- export interface AcmProps extends acm.CertificateProps {
400
- certificateSsmName?: string
401
- certificateAccount?: string
402
- certificateRegion?: string
403
- certificateId?: string
404
- certificateArn?: string
405
- useExistingCertificate: boolean
406
- }
407
-
408
- /**
409
- * @category cdk-utils.ssm-manager
410
- * @subcategory Properties
411
- */
412
- export interface SSMParameterReaderProps {
413
- parameterName: string
414
- region: string
415
- }
416
-
417
- /**
418
- * @category cdk-utils.cloudfront-manager
419
- * @subcategory Properties
420
- */
421
- export interface CloudFrontProps extends cloudfront.CloudFrontWebDistributionProps {}
422
-
423
- /**
424
- * @category cdk-utils.cloudfront-manager
425
- * @subcategory Properties
426
- */
427
- export interface CloudfrontFunctionProps extends cloudfront.FunctionProps {
428
- functionFilePath: string
429
- eventType: string
430
- }
431
-
432
- /**
433
- * @category cdk-utils.cloudfront-manager
434
- * @subcategory Properties
435
- */
436
- export interface DistributionProps extends cloudfront.DistributionProps {}
437
-
438
- /**
439
- * @category cdk-utils.cloudtrail-manager
440
- * @subcategory Properties
441
- */
442
- export interface CloudTrailProps extends cloudtrail.CfnTrailProps {}
443
-
444
- /**
445
- * @category cdk-utils.cloudwatch-manager
446
- * @subcategory Properties
447
- */
448
- export interface DashboardProps extends watch.DashboardProps {
449
- positionX: number
450
- positionY: number
451
- }
452
-
453
- /**
454
- * @category cdk-utils.cloudwatch-manager
455
- * @subcategory Properties
456
- */
457
- export interface AlarmProps extends watch.AlarmProps {
458
- expression?: string
459
- metricProps?: MetricProps[]
460
- periodInSecs?: number
461
- }
462
-
463
- /**
464
- * @category cdk-utils.cloudwatch-manager
465
- * @subcategory Properties
466
- */
467
- export interface MetricProps extends watch.MetricProps {
468
- stageSuffix: boolean
469
- periodInSecs?: number
470
- functionName?: string
471
- dbClusterIdentifier?: string
472
- }
473
-
474
- /**
475
- * @category cdk-utils.cloudwatch-manager
476
- * @subcategory Properties
477
- */
478
- export interface TextWidgetProps extends watch.TextWidgetProps {
479
- positionX: number
480
- positionY: number
481
- }
482
-
483
- /**
484
- * @category cdk-utils.cloudwatch-manager
485
- * @subcategory Properties
486
- */
487
- export interface NumericWidgetProps extends watch.SingleValueWidgetProps {
488
- positionX: number
489
- positionY: number
490
- metricProps?: watch.MetricProps[]
491
- }
492
-
493
- /**
494
- * @category cdk-utils.cloudwatch-manager
495
- * @subcategory Properties
496
- */
497
- export interface GraphWidgetProps extends watch.GraphWidgetProps {
498
- positionX: number
499
- positionY: number
500
- metricProps?: MetricProps[]
501
- }
502
-
503
- /**
504
- * @category cdk-utils.cloudwatch-manager
505
- * @subcategory Properties
506
- */
507
- export interface AlarmStatusWidgetProps extends watch.AlarmStatusWidgetProps {
508
- positionX: number
509
- positionY: number
510
- alarmProps?: watch.AlarmProps[]
511
- }
512
-
513
- /**
514
- * @category cdk-utils.cloudwatch-manager
515
- * @subcategory Properties
516
- */
517
- export interface LogQueryWidgetProps extends watch.LogQueryWidgetProps {
518
- positionX: number
519
- positionY: number
520
- }
521
-
522
- /**
523
- * @category cdk-utils.ecs-manager
524
- * @subcategory Properties
525
- */
526
- export interface EcsClusterProps extends ecs.ClusterProps {}
527
-
528
- /**
529
- * @category cdk-utils.ecs-manager
530
- * @subcategory Properties
531
- */
532
- export interface EcsTaskProps extends ecs.TaskDefinitionProps {}
533
-
534
- /**
535
- * @category cdk-utils.eks-manager
536
- * @subcategory Properties
537
- */
538
- export interface EksClusterProps extends eks.ClusterProps {
539
- appContainerPort: number
540
- appCapacity: number
541
- }
542
-
543
- /**
544
- * @category cdk-utils.event-manager
545
- * @subcategory Properties
546
- */
547
- export interface RuleProps extends events.CfnRuleProps {}
548
-
549
- /**
550
- * @category cdk-utils.event-manager
551
- * @subcategory Properties
552
- */
553
- export interface EventRuleProps extends events.RuleProps {}
554
-
555
- /**
556
- * @category cdk-utils.event-manager
557
- * @subcategory Properties
558
- */
559
- export interface EventBusProps extends events.EventBusProps {}
560
-
561
- /**
562
- * @category cdk-utils.lambda-manager
563
- * @subcategory Properties
564
- */
565
- export interface LambdaProps extends lambda.FunctionProps {
566
- timeoutInSecs?: number
567
- }
568
-
569
- /**
570
- * @category cdk-utils.lambda-manager
571
- * @subcategory Properties
572
- */
573
- export interface LambdaEdgeProps extends cloudfront.experimental.EdgeFunctionProps {
574
- timeoutInSecs?: number
575
- }
576
-
577
- /**
578
- * @category cdk-utils.cloudwatch-manager
579
- * @subcategory Properties
580
- */
581
- export interface LogProps extends logs.LogGroupProps {}
582
-
583
- /**
584
- * @category cdk-utils.cloudwatch-manager
585
- * @subcategory Properties
586
- */
587
- export interface MetricFilterProps extends logs.MetricFilterProps {
588
- periodInSecs: number
589
- options: watch.MetricOptions
590
- }
591
-
592
- /**
593
- * @category cdk-utils.route53-manager
594
- * @subcategory Properties
595
- */
596
- export interface Route53Props extends route53.HostedZoneProps {
597
- useExistingHostedZone?: boolean
598
- }
599
-
600
- /**
601
- * @category cdk-utils.s3-manager
602
- * @subcategory Properties
603
- */
604
- export interface LifecycleRule extends s3.LifecycleRule {
605
- expirationInDays?: number
606
- noncurrentVersionExpirationInDays?: number
607
- }
608
-
609
- /**
610
- * @category cdk-utils.dynamodb-manager
611
- * @subcategory Properties
612
- */
613
- export interface TableProps extends dynamodb.TableProps {}
614
-
615
- /**
616
- * @category cdk-utils.s3-manager
617
- * @subcategory Properties
618
- */
619
- export interface S3BucketProps extends s3.BucketProps {
620
- enableEventBridge?: boolean
621
- lifecycleRules?: LifecycleRule[]
622
- bucketName: string
623
- logBucketName?: string
624
- existingBucket?: boolean
625
- }
626
-
627
- /**
628
- * @category cdk-utils.sns-manager
629
- * @subcategory Properties
630
- */
631
- export interface SubscriptionProps extends sns.TopicProps {}
632
-
633
- /**
634
- * @category cdk-utils.waf-manager
635
- * @subcategory Properties
636
- */
637
- export interface WafIPSetProps extends wafv2.CfnIPSetProps {}
638
-
639
- /**
640
- * @category cdk-utils.waf-manager
641
- * @subcategory Properties
642
- */
643
- export interface WafWebACLProps extends wafv2.CfnWebACLProps {}
644
- </code></pre>
645
- </article>
646
- </section>
647
-
648
-
649
-
650
-
651
- </div>
652
-
653
- </div>
654
- <div id="side-nav" class="side-nav">
655
- </div>
656
- </div>
657
- <script src="scripts/app.min.js"></script>
658
- <script>PR.prettyPrint();</script>
659
- <script src="scripts/linenumber.js"> </script>
660
-
661
- <script src="scripts/search.js"> </script>
662
-
663
-
664
- </body>
665
- </html>