@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.
- package/package.json +4 -5
- package/api-docs/AcmManager.html +0 -622
- package/api-docs/AcmProps.html +0 -238
- package/api-docs/AlarmProps.html +0 -238
- package/api-docs/AlarmStatusWidgetProps.html +0 -238
- package/api-docs/ApiDestinationEvent.html +0 -297
- package/api-docs/ApiDestinationEventType.html +0 -238
- package/api-docs/ApiDestinedLambda.html +0 -297
- package/api-docs/ApiDestinedLambdaEnvironment.html +0 -238
- package/api-docs/ApiDestinedLambdaType.html +0 -238
- package/api-docs/ApiDestinedRestApi.html +0 -297
- package/api-docs/ApiDestinedRestApiType.html +0 -238
- package/api-docs/ApiManager.html +0 -766
- package/api-docs/ApiToEventBridgeTarget.html +0 -1877
- package/api-docs/ApiToEventBridgeTarget.jpg +0 -0
- package/api-docs/ApiToEventBridgeTargetEventProps.html +0 -238
- package/api-docs/ApiToEventBridgeTargetLambdaProps.html +0 -238
- package/api-docs/ApiToEventBridgeTargetProps.html +0 -238
- package/api-docs/ApiToEventBridgeTargetRestApiProps.html +0 -238
- package/api-docs/AppConfigManager.html +0 -1203
- package/api-docs/AppConfigProps.html +0 -238
- package/api-docs/CloudFrontManager.html +0 -2402
- package/api-docs/CloudFrontProps.html +0 -238
- package/api-docs/CloudTrailManager.html +0 -637
- package/api-docs/CloudTrailProps.html +0 -238
- package/api-docs/CloudWatchManager.html +0 -2986
- package/api-docs/CloudfrontFunctionProps.html +0 -238
- package/api-docs/CodeBuildManager.html +0 -736
- package/api-docs/CommonConstruct.html +0 -1299
- package/api-docs/CommonStack.html +0 -813
- package/api-docs/CommonStackProps.html +0 -238
- package/api-docs/DashboardProps.html +0 -238
- package/api-docs/DistributionProps.html +0 -238
- package/api-docs/DynamodbManager.html +0 -530
- package/api-docs/EcrManager.html +0 -530
- package/api-docs/EcsClusterProps.html +0 -238
- package/api-docs/EcsManager.html +0 -880
- package/api-docs/EcsTaskProps.html +0 -238
- package/api-docs/EksClusterProps.html +0 -238
- package/api-docs/EksManager.html +0 -580
- package/api-docs/EventBusProps.html +0 -238
- package/api-docs/EventManager.html +0 -1454
- package/api-docs/EventRuleProps.html +0 -238
- package/api-docs/GraphQLApiLambda.html +0 -1671
- package/api-docs/GraphQLApiLambda.jpg +0 -0
- package/api-docs/GraphQlApiLambdaEnvironment.html +0 -238
- package/api-docs/GraphQlApiLambdaProps.html +0 -238
- package/api-docs/GraphWidgetProps.html +0 -238
- package/api-docs/HealthCheck.html +0 -238
- package/api-docs/IamManager.html +0 -3821
- package/api-docs/LambdaEdgeProps.html +0 -238
- package/api-docs/LambdaEnvironment.html +0 -238
- package/api-docs/LambdaManager.html +0 -2378
- package/api-docs/LambdaProps.html +0 -238
- package/api-docs/LifecycleRule.html +0 -238
- package/api-docs/LogManager.html +0 -955
- package/api-docs/LogProps.html +0 -238
- package/api-docs/LogQueryWidgetProps.html +0 -238
- package/api-docs/MetricFilterProps.html +0 -238
- package/api-docs/MetricProps.html +0 -238
- package/api-docs/NumericWidgetProps.html +0 -238
- package/api-docs/Route53Manager.html +0 -1460
- package/api-docs/Route53Props.html +0 -238
- package/api-docs/RuleProps.html +0 -238
- package/api-docs/S3BucketProps.html +0 -238
- package/api-docs/S3Manager.html +0 -1546
- package/api-docs/SSMParameterReader.html +0 -431
- package/api-docs/SSMParameterReaderProps.html +0 -238
- package/api-docs/SecretsManager.html +0 -1140
- package/api-docs/SiteWithEcsBackend.html +0 -2391
- package/api-docs/SiteWithEcsBackendProps.html +0 -238
- package/api-docs/SnsManager.html +0 -780
- package/api-docs/SsmManager.html +0 -955
- package/api-docs/StaticSite.html +0 -1358
- package/api-docs/StaticSiteProps.html +0 -238
- package/api-docs/SubscriptionProps.html +0 -238
- package/api-docs/TableProps.html +0 -238
- package/api-docs/TextWidgetProps.html +0 -238
- package/api-docs/VpcManager.html +0 -986
- package/api-docs/WafIPSetProps.html +0 -238
- package/api-docs/WafManager.html +0 -730
- package/api-docs/WafWebACLProps.html +0 -238
- package/api-docs/common_construct.ts.html +0 -279
- package/api-docs/common_stack.ts.html +0 -303
- package/api-docs/construct_api-to-eventbridge-target_api-destination-event.ts.html +0 -175
- package/api-docs/construct_api-to-eventbridge-target_api-destined-lambda.ts.html +0 -178
- package/api-docs/construct_api-to-eventbridge-target_api-destined-rest-api.ts.html +0 -190
- package/api-docs/construct_api-to-eventbridge-target_main.ts.html +0 -751
- package/api-docs/construct_graphql-api-lambda_main.ts.html +0 -408
- package/api-docs/construct_site-with-ecs-backend_main.ts.html +0 -544
- package/api-docs/construct_static-site_main.ts.html +0 -374
- package/api-docs/global.html +0 -1530
- package/api-docs/index.html +0 -208
- package/api-docs/logo.png +0 -0
- package/api-docs/manager_aws_acm-manager.ts.html +0 -236
- package/api-docs/manager_aws_api-manager.ts.html +0 -260
- package/api-docs/manager_aws_app-config-manager.ts.html +0 -310
- package/api-docs/manager_aws_cloudfront-manager.ts.html +0 -491
- package/api-docs/manager_aws_cloudtrail-manager.ts.html +0 -251
- package/api-docs/manager_aws_cloudwatch-manager.ts.html +0 -553
- package/api-docs/manager_aws_codebuild-manager.ts.html +0 -240
- package/api-docs/manager_aws_dynamodb-manager.ts.html +0 -219
- package/api-docs/manager_aws_ecr-manager.ts.html +0 -199
- package/api-docs/manager_aws_ecs-manager.ts.html +0 -259
- package/api-docs/manager_aws_eks-manager.ts.html +0 -260
- package/api-docs/manager_aws_event-manager.ts.html +0 -336
- package/api-docs/manager_aws_iam-manager.ts.html +0 -573
- package/api-docs/manager_aws_lambda-manager.ts.html +0 -400
- package/api-docs/manager_aws_log-manager.ts.html +0 -259
- package/api-docs/manager_aws_route53-manager.ts.html +0 -333
- package/api-docs/manager_aws_s3-manager.ts.html +0 -361
- package/api-docs/manager_aws_secrets-manager.ts.html +0 -274
- package/api-docs/manager_aws_sns-manager.ts.html +0 -246
- package/api-docs/manager_aws_ssm-manager.ts.html +0 -273
- package/api-docs/manager_aws_vpc-manager.ts.html +0 -244
- package/api-docs/manager_aws_waf-manager.ts.html +0 -232
- package/api-docs/scripts/app.min.js +0 -1
- package/api-docs/scripts/linenumber.js +0 -26
- package/api-docs/scripts/search.js +0 -39
- package/api-docs/styles/app.min.css +0 -1
- package/api-docs/styles/iframe.css +0 -13
- package/api-docs/styles/prettify-jsdoc.css +0 -111
- package/api-docs/styles/prettify-tomorrow.css +0 -132
- package/api-docs/styles/reset.css +0 -44
- package/api-docs/styles.css +0 -113
- package/api-docs/tutorial-Architecture.html +0 -151
- package/api-docs/tutorial-Build.html +0 -150
- package/api-docs/tutorial-CI-CD.html +0 -154
- package/api-docs/tutorial-Development.html +0 -227
- package/api-docs/types_aws_index.ts.html +0 -665
- package/api-docs/utils_aws_index.ts.html +0 -192
- package/api-docs/utils_index.ts.html +0 -227
- package/img/ApiToEventBridgeTarget.jpg +0 -0
- package/img/GraphQLApiLambda.jpg +0 -0
- package/img/logo.png +0 -0
- package/theme/styles.css +0 -113
package/api-docs/index.html
DELETED
|
@@ -1,208 +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 Home</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></p>
|
|
126
|
-
<h1>Home</h1>
|
|
127
|
-
</header>
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
<h3> </h3>
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
<section>
|
|
152
|
-
<article><p><a href="https://gradientedge.com"><img src="https://cdn.gradientedge.io/images/ge-logo-1200.png" alt="Gradient Edge"></a></p>
|
|
153
|
-
<h1>Gradient Edge CDK Utils</h1>
|
|
154
|
-
<p><a href="https://gradientedge.github.io/cdk-utils/"><img src="https://img.shields.io/github/release/gradientedge/cdk-utils.svg" alt="Release"></a>
|
|
155
|
-
<a href="https://www.npmjs.com/package/@gradientedge/cdk-utils"><img src="https://img.shields.io/npm/v/@gradientedge/cdk-utils" alt="version"></a></p>
|
|
156
|
-
<p><a href="https://github.com/gradientedge/cdk-utils/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gradientedge/cdk-utils" alt="License"></a>
|
|
157
|
-
<a href="https://github.com/gradientedge/cdk-utils"><img src="https://img.shields.io/badge/maintained-YES-green" alt="Maintained"></a>
|
|
158
|
-
<a href="https://github.com/gradientedge/cdk-utils/blob/main/package.json"><img src="https://img.shields.io/librariesio/release/npm/@gradientedge/cdk-utils" alt="Dependencies"></a>
|
|
159
|
-
<a href="https://twitter.com/gradientedge"><img src="https://img.shields.io/twitter/follow/gradientedge" alt="Twitter"></a></p>
|
|
160
|
-
<p><a href="https://aws.amazon.com/cli/"><img src="https://img.shields.io/badge/aws--cli-2.3.4-777BB4?logo=amazon-aws" alt="AWS CLI"></a>
|
|
161
|
-
<a href="https://nodejs.dev"><img src="https://img.shields.io/node/v/@gradientedge/cdk-utils" alt="Node"></a>
|
|
162
|
-
<a href="https://yarnpkg.com"><img src="https://img.shields.io/badge/yarn-1.22.10-green?logo=yarn" alt="Yarn"></a>
|
|
163
|
-
<a href="https://aws.amazon.com/cdk/"><img src="https://img.shields.io/github/package-json/dependency-version/gradientedge/cdk-utils/aws-cdk-lib" alt="CDK"></a></p>
|
|
164
|
-
<p><a href="https://github.com/gradientedge/cdk-utils/actions"><img src="https://img.shields.io/github/workflow/status/gradientedge/cdk-utils/CI-Pipeline/main" alt="Builds"></a>
|
|
165
|
-
<a href="https://app.codecov.io/gh/gradientedge/cdk-utils"><img src="https://codecov.io/gh/gradientedge/cdk-utils/branch/main/graph/badge.svg" alt="Coverage"></a>
|
|
166
|
-
<a href="https://www.npmjs.com/package/@gradientedge/cdk-utils"><img src="https://img.shields.io/github/languages/code-size/gradientedge/cdk-utils" alt="Code Size"></a></p>
|
|
167
|
-
<p><a href="https://www.npmjs.com/package/@gradientedge/cdk-utils"><img src="https://img.shields.io/npm/dw/@gradientedge/cdk-utils" alt="Downloads"></a>
|
|
168
|
-
<a href="https://github.com/gradientedge/cdk-utils/commits/main"><img src="https://img.shields.io/github/commit-activity/m/gradientedge/cdk-utils" alt="Commits"></a>
|
|
169
|
-
<a href="https://github.com/gradientedge/cdk-utils/commits/main"><img src="https://img.shields.io/github/last-commit/gradientedge/cdk-utils" alt="Last Commits"></a>
|
|
170
|
-
<a href="https://github.com/gradientedge/cdk-utils/issues"><img src="https://img.shields.io/github/issues/gradientedge/cdk-utils.svg" alt="Issues"></a>
|
|
171
|
-
<a href="https://github.com/gradientedge/cdk-utils/pulls"><img src="https://img.shields.io/github/issues-pr/gradientedge/cdk-utils.svg" alt="Pull Requests"></a></p>
|
|
172
|
-
<h2>Introduction</h2>
|
|
173
|
-
<p>Toolkit for working with the <a href="https://docs.aws.amazon.com/cdk/latest/guide/home.html">AWS CDK</a> Toolkit.</p>
|
|
174
|
-
<p>For more details, see our full <a href="https://gradientedge.github.io/cdk-utils/">API documentation</a>.</p>
|
|
175
|
-
<h2>Installation</h2>
|
|
176
|
-
<h3><img src="https://img.shields.io/badge/command--line-4D4D4D?logo=windows-terminal&style=for-the-badge" alt="cmd"></h3>
|
|
177
|
-
<p>With <strong>npm</strong>:</p>
|
|
178
|
-
<pre class="prettyprint source lang-shell"><code>npm install --save @gradientedge/cdk-utils
|
|
179
|
-
</code></pre>
|
|
180
|
-
<p>With <strong>yarn</strong>:</p>
|
|
181
|
-
<pre class="prettyprint source lang-shell"><code>yarn add @gradientedge/cdk-utils
|
|
182
|
-
</code></pre>
|
|
183
|
-
<h3><img src="https://img.shields.io/badge/package.json-4D4D4D?logo=purescript" alt="purescript"></h3>
|
|
184
|
-
<pre class="prettyprint source"><code>"@gradientedge/cdk-utils": "latest"
|
|
185
|
-
</code></pre>
|
|
186
|
-
<!-- references --></article>
|
|
187
|
-
</section>
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
</div>
|
|
195
|
-
|
|
196
|
-
</div>
|
|
197
|
-
<div id="side-nav" class="side-nav">
|
|
198
|
-
</div>
|
|
199
|
-
</div>
|
|
200
|
-
<script src="scripts/app.min.js"></script>
|
|
201
|
-
<script>PR.prettyPrint();</script>
|
|
202
|
-
<script src="scripts/linenumber.js"> </script>
|
|
203
|
-
|
|
204
|
-
<script src="scripts/search.js"> </script>
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
</body>
|
|
208
|
-
</html>
|
package/api-docs/logo.png
DELETED
|
Binary file
|
|
@@ -1,236 +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/acm-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/acm-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 route53 from 'aws-cdk-lib/aws-route53'
|
|
140
|
-
import * as common from '../../common'
|
|
141
|
-
import * as types from '../../types'
|
|
142
|
-
import * as utils from '../../utils'
|
|
143
|
-
|
|
144
|
-
/**
|
|
145
|
-
* @stability stable
|
|
146
|
-
* @category cdk-utils.acm-manager
|
|
147
|
-
* @subcategory Construct
|
|
148
|
-
* @classdesc Provides operations on AWS Certificates.
|
|
149
|
-
* - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
|
|
150
|
-
* - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
|
|
151
|
-
* @example
|
|
152
|
-
* import { CommonConstruct } from '@gradientedge/cdk-utils'
|
|
153
|
-
*
|
|
154
|
-
* class CustomConstruct extends CommonConstruct {
|
|
155
|
-
* constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
|
|
156
|
-
* super(parent, id, props)
|
|
157
|
-
* this.props = props
|
|
158
|
-
* this.acmManager.createCertificate('MyCertificate', this)
|
|
159
|
-
* }
|
|
160
|
-
* }
|
|
161
|
-
*
|
|
162
|
-
* @see [CDK Certificate Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_certificatemanager-readme.html}
|
|
163
|
-
*/
|
|
164
|
-
export class AcmManager {
|
|
165
|
-
/**
|
|
166
|
-
* @summary Method to create/import a certificate
|
|
167
|
-
* @param {string} id scoped id of the resource
|
|
168
|
-
* @param {common.CommonConstruct} scope scope in which this resource is defined
|
|
169
|
-
* @param {types.AcmProps} props certificate props
|
|
170
|
-
* @param {route53.HostedZone?} hostedZone optional hosted zone to perform DNS validation
|
|
171
|
-
* @returns {acm.ICertificate}
|
|
172
|
-
*
|
|
173
|
-
* @mermaid
|
|
174
|
-
* graph LR;
|
|
175
|
-
* A((Start)) --> B{Valid Properties?};
|
|
176
|
-
* B -- Yes --> C(Fetch By ARN);
|
|
177
|
-
* B -- No --> D[Throw Error];
|
|
178
|
-
* D --> G((Stop));
|
|
179
|
-
* C --> E{Valid ARN?};
|
|
180
|
-
* E -- Yes --> F(Return Certificate);
|
|
181
|
-
* E -- No --> D;
|
|
182
|
-
* F --> G;
|
|
183
|
-
*/
|
|
184
|
-
public resolveCertificate(
|
|
185
|
-
id: string,
|
|
186
|
-
scope: common.CommonConstruct,
|
|
187
|
-
props: types.AcmProps,
|
|
188
|
-
hostedZone?: route53.IHostedZone
|
|
189
|
-
): acm.ICertificate {
|
|
190
|
-
if (!props) throw `Certificate props undefined`
|
|
191
|
-
|
|
192
|
-
let certificate
|
|
193
|
-
|
|
194
|
-
if (props.useExistingCertificate) {
|
|
195
|
-
let certificateArn = props.certificateArn
|
|
196
|
-
if (!certificateArn) {
|
|
197
|
-
const certificateAccount = props.certificateAccount ? props.certificateAccount : cdk.Stack.of(scope).account
|
|
198
|
-
const certificateRegion = props.certificateRegion ? props.certificateRegion : cdk.Stack.of(scope).region
|
|
199
|
-
certificateArn = `arn:aws:acm:${certificateRegion}:${certificateAccount}:certificate/${props.certificateId}`
|
|
200
|
-
}
|
|
201
|
-
certificate = acm.Certificate.fromCertificateArn(scope, `${id}`, certificateArn)
|
|
202
|
-
} else {
|
|
203
|
-
certificate = new acm.Certificate(scope, `${id}`, {
|
|
204
|
-
domainName: props.domainName,
|
|
205
|
-
subjectAlternativeNames: props.subjectAlternativeNames,
|
|
206
|
-
validation: acm.CertificateValidation.fromDns(hostedZone),
|
|
207
|
-
})
|
|
208
|
-
}
|
|
209
|
-
|
|
210
|
-
utils.createCfnOutput(`${id}-certificateArn`, scope, certificate.certificateArn)
|
|
211
|
-
|
|
212
|
-
return certificate
|
|
213
|
-
}
|
|
214
|
-
}
|
|
215
|
-
</code></pre>
|
|
216
|
-
</article>
|
|
217
|
-
</section>
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
</div>
|
|
223
|
-
|
|
224
|
-
</div>
|
|
225
|
-
<div id="side-nav" class="side-nav">
|
|
226
|
-
</div>
|
|
227
|
-
</div>
|
|
228
|
-
<script src="scripts/app.min.js"></script>
|
|
229
|
-
<script>PR.prettyPrint();</script>
|
|
230
|
-
<script src="scripts/linenumber.js"> </script>
|
|
231
|
-
|
|
232
|
-
<script src="scripts/search.js"> </script>
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
</body>
|
|
236
|
-
</html>
|