@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
|
@@ -1,260 +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/api-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/api-manager.ts</h1>
|
|
129
|
-
</header>
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
<section>
|
|
136
|
-
<article>
|
|
137
|
-
<pre class="prettyprint source linenums"><code>import * as apig from 'aws-cdk-lib/aws-apigateway'
|
|
138
|
-
import * as acm from 'aws-cdk-lib/aws-certificatemanager'
|
|
139
|
-
import * as lambda from 'aws-cdk-lib/aws-lambda'
|
|
140
|
-
import * as common from '../../common'
|
|
141
|
-
import * as utils from '../../utils'
|
|
142
|
-
|
|
143
|
-
/**
|
|
144
|
-
* @stability stable
|
|
145
|
-
* @category cdk-utils.api-manager
|
|
146
|
-
* @subcategory Construct
|
|
147
|
-
* @classdesc Provides operations on AWS API Gateway.
|
|
148
|
-
* - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
|
|
149
|
-
* - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
|
|
150
|
-
* @example
|
|
151
|
-
* import { common.CommonConstruct } from '@gradientedge/cdk-utils'
|
|
152
|
-
*
|
|
153
|
-
* class CustomConstruct extends common.CommonConstruct {
|
|
154
|
-
* constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
|
|
155
|
-
* super(parent, id, props)
|
|
156
|
-
* this.props = props
|
|
157
|
-
* const lambdaFunction = this.lambdaManager.createLambdaFunction('MyFunction', this, role, layers, code)
|
|
158
|
-
* this.apiManager.createLambdaRestApi('MyCertificate', this, props, lambdaFunction)
|
|
159
|
-
* }
|
|
160
|
-
* }
|
|
161
|
-
*
|
|
162
|
-
* @see [CDK API Gateway Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway-readme.html}
|
|
163
|
-
*/
|
|
164
|
-
export class ApiManager {
|
|
165
|
-
/**
|
|
166
|
-
* @summary Method to create a Rest API with Lambda backend/target
|
|
167
|
-
* @param {string} id scoped id of the resource
|
|
168
|
-
* @param {common.CommonConstruct} scope scope in which this resource is defined
|
|
169
|
-
* @param {AcmProps} props lambda rest restApi props
|
|
170
|
-
* @param lambdaFunction
|
|
171
|
-
*/
|
|
172
|
-
public createLambdaRestApi(
|
|
173
|
-
id: string,
|
|
174
|
-
scope: common.CommonConstruct,
|
|
175
|
-
props: apig.LambdaRestApiProps,
|
|
176
|
-
lambdaFunction: lambda.Function
|
|
177
|
-
) {
|
|
178
|
-
const api = new apig.LambdaRestApi(scope, `${id}`, {
|
|
179
|
-
binaryMediaTypes: props.binaryMediaTypes,
|
|
180
|
-
minimumCompressionSize: props.minimumCompressionSize,
|
|
181
|
-
defaultMethodOptions: props.defaultMethodOptions,
|
|
182
|
-
deploy: props.deploy || true,
|
|
183
|
-
deployOptions: {
|
|
184
|
-
stageName: scope.props.stage,
|
|
185
|
-
accessLogDestination: props.deployOptions?.accessLogDestination,
|
|
186
|
-
accessLogFormat: props.deployOptions?.accessLogFormat,
|
|
187
|
-
tracingEnabled: props.deployOptions?.tracingEnabled,
|
|
188
|
-
cacheClusterEnabled: props.deployOptions?.cacheClusterEnabled,
|
|
189
|
-
cacheClusterSize: props.deployOptions?.cacheClusterSize,
|
|
190
|
-
clientCertificateId: props.deployOptions?.clientCertificateId,
|
|
191
|
-
description: `${id} - ${scope.props.stage} stage`,
|
|
192
|
-
documentationVersion: props.deployOptions?.documentationVersion,
|
|
193
|
-
variables: props.deployOptions?.variables,
|
|
194
|
-
methodOptions: props.deployOptions?.methodOptions,
|
|
195
|
-
},
|
|
196
|
-
retainDeployments: props.retainDeployments,
|
|
197
|
-
parameters: props.parameters,
|
|
198
|
-
policy: props.policy,
|
|
199
|
-
failOnWarnings: props.failOnWarnings || false,
|
|
200
|
-
domainName: props.domainName,
|
|
201
|
-
cloudWatchRole: props.cloudWatchRole || false,
|
|
202
|
-
endpointTypes: props.endpointTypes,
|
|
203
|
-
endpointConfiguration: {
|
|
204
|
-
types: props.endpointConfiguration?.types || [apig.EndpointType.REGIONAL],
|
|
205
|
-
vpcEndpoints: props.endpointConfiguration?.vpcEndpoints,
|
|
206
|
-
},
|
|
207
|
-
restApiName: `${props.restApiName}-${scope.props.stage}`,
|
|
208
|
-
handler: lambdaFunction,
|
|
209
|
-
defaultCorsPreflightOptions: props.defaultCorsPreflightOptions,
|
|
210
|
-
proxy: props.proxy || true,
|
|
211
|
-
})
|
|
212
|
-
|
|
213
|
-
utils.createCfnOutput(`${id}-restApiId`, scope, api.restApiId)
|
|
214
|
-
utils.createCfnOutput(`${id}-restApiName`, scope, api.restApiName)
|
|
215
|
-
|
|
216
|
-
return api
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
/**
|
|
220
|
-
* @summary Method to create custom restApi domain
|
|
221
|
-
* @param {string} id scoped id of the resource
|
|
222
|
-
* @param {common.CommonConstruct} scope scope in which this resource is defined
|
|
223
|
-
* @param domainName the domain name to use
|
|
224
|
-
* @param certificate the certificate used for custom restApi domain
|
|
225
|
-
*/
|
|
226
|
-
public createApiDomain(id: string, scope: common.CommonConstruct, domainName: string, certificate: acm.ICertificate) {
|
|
227
|
-
const apiDomain = new apig.DomainName(scope, `${id}`, {
|
|
228
|
-
domainName: domainName,
|
|
229
|
-
certificate: certificate,
|
|
230
|
-
endpointType: scope.isProductionStage() ? apig.EndpointType.EDGE : apig.EndpointType.REGIONAL,
|
|
231
|
-
securityPolicy: apig.SecurityPolicy.TLS_1_2,
|
|
232
|
-
})
|
|
233
|
-
|
|
234
|
-
utils.createCfnOutput(`${id}-customDomainName`, scope, apiDomain.domainName)
|
|
235
|
-
|
|
236
|
-
return apiDomain
|
|
237
|
-
}
|
|
238
|
-
}
|
|
239
|
-
</code></pre>
|
|
240
|
-
</article>
|
|
241
|
-
</section>
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
</div>
|
|
247
|
-
|
|
248
|
-
</div>
|
|
249
|
-
<div id="side-nav" class="side-nav">
|
|
250
|
-
</div>
|
|
251
|
-
</div>
|
|
252
|
-
<script src="scripts/app.min.js"></script>
|
|
253
|
-
<script>PR.prettyPrint();</script>
|
|
254
|
-
<script src="scripts/linenumber.js"> </script>
|
|
255
|
-
|
|
256
|
-
<script src="scripts/search.js"> </script>
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
</body>
|
|
260
|
-
</html>
|
|
@@ -1,310 +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/app-config-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/app-config-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 appconfig from 'aws-cdk-lib/aws-appconfig'
|
|
139
|
-
import * as common from '../../common'
|
|
140
|
-
import * as types from '../../types'
|
|
141
|
-
import * as utils from '../../utils'
|
|
142
|
-
|
|
143
|
-
/**
|
|
144
|
-
* @stability stable
|
|
145
|
-
* @category cdk-utils.app-config-manager
|
|
146
|
-
* @subcategory Construct
|
|
147
|
-
* @returns { Map<string, string> } ArnsByRegion
|
|
148
|
-
*/
|
|
149
|
-
export const ArnsByRegion: { [key: string]: string } = {
|
|
150
|
-
'us-east-1': 'arn:aws:lambda:us-east-1:027255383542:layer:AWS-AppConfig-Extension:11',
|
|
151
|
-
'us-east-2': 'arn:aws:lambda:us-east-2:728743619870:layer:AWS-AppConfig-Extension:15',
|
|
152
|
-
'us-west-1': 'arn:aws:lambda:us-west-1:958113053741:layer:AWS-AppConfig-Extension:11',
|
|
153
|
-
'us-west-2': 'arn:aws:lambda:us-west-2:359756378197:layer:AWS-AppConfig-Extension:18',
|
|
154
|
-
'ca-central-1': 'arn:aws:lambda:ca-central-1:039592058896:layer:AWS-AppConfig-Extension:15',
|
|
155
|
-
'eu-central-1': 'arn:aws:lambda:eu-central-1:066940009817:layer:AWS-AppConfig-Extension:19',
|
|
156
|
-
'eu-west-1': 'arn:aws:lambda:eu-west-1:434848589818:layer:AWS-AppConfig-Extension:11',
|
|
157
|
-
'eu-west-2': 'arn:aws:lambda:eu-west-2:282860088358:layer:AWS-AppConfig-Extension:15',
|
|
158
|
-
'eu-west-3': 'arn:aws:lambda:eu-west-3:493207061005:layer:AWS-AppConfig-Extension:15',
|
|
159
|
-
'eu-north-1': 'arn:aws:lambda:eu-north-1:646970417810:layer:AWS-AppConfig-Extension:19',
|
|
160
|
-
'ap-east-1': 'arn:aws:lambda:ap-east-1:630222743974:layer:AWS-AppConfig-Extension:15',
|
|
161
|
-
'ap-northeast-1': 'arn:aws:lambda:ap-northeast-1:980059726660:layer:AWS-AppConfig-Extension:12',
|
|
162
|
-
'ap-northeast-2': 'arn:aws:lambda:ap-northeast-2:826293736237:layer:AWS-AppConfig-Extension:19',
|
|
163
|
-
'ap-northeast-3': 'arn:aws:lambda:ap-northeast-3:706869817123:layer:AWS-AppConfig-Extension:3',
|
|
164
|
-
'ap-southeast-1': 'arn:aws:lambda:ap-southeast-1:421114256042:layer:AWS-AppConfig-Extension:12',
|
|
165
|
-
'ap-southeast-2': 'arn:aws:lambda:ap-southeast-2:080788657173:layer:AWS-AppConfig-Extension:19',
|
|
166
|
-
'ap-south-1': 'arn:aws:lambda:ap-south-1:554480029851:layer:AWS-AppConfig-Extension:20',
|
|
167
|
-
'sa-east-1': 'arn:aws:lambda:sa-east-1:000010852771:layer:AWS-AppConfig-Extension:11',
|
|
168
|
-
'af-south-1': 'arn:aws:lambda:af-south-1:574348263942:layer:AWS-AppConfig-Extension:15',
|
|
169
|
-
'me-south-1': 'arn:aws:lambda:me-south-1:559955524753:layer:AWS-AppConfig-Extension:15',
|
|
170
|
-
}
|
|
171
|
-
|
|
172
|
-
/**
|
|
173
|
-
* @category cdk-utils.app-config-manager
|
|
174
|
-
* @subcategory Construct
|
|
175
|
-
* @classdesc Provides operations on AWS AppConfig.
|
|
176
|
-
* - A new instance of this class is injected into {@link common.CommonConstruct} constructor.
|
|
177
|
-
* - If a custom construct extends {@link common.CommonConstruct}, an instance is available within the context.
|
|
178
|
-
* @example
|
|
179
|
-
* import * as common from '@gradientedge/cdk-utils'
|
|
180
|
-
*
|
|
181
|
-
* class CustomConstruct extends common.common.CommonConstruct {
|
|
182
|
-
* constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
|
|
183
|
-
* super(parent, id, props)
|
|
184
|
-
* this.props = props
|
|
185
|
-
* this.appConfigManager.createApplication('MyApplication', this)
|
|
186
|
-
* }
|
|
187
|
-
* }
|
|
188
|
-
*
|
|
189
|
-
* @see [CDK AppConfig Module]{@link https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html}
|
|
190
|
-
*/
|
|
191
|
-
export class AppConfigManager {
|
|
192
|
-
/**
|
|
193
|
-
* Method to get static ARNs for AppConfig extensions
|
|
194
|
-
* @param {common.CommonConstruct} scope scope in which this resource is defined
|
|
195
|
-
*/
|
|
196
|
-
public getArnForAppConfigExtension(scope: common.CommonConstruct) {
|
|
197
|
-
return ArnsByRegion[scope.props.region]
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
/**
|
|
201
|
-
* @summary Method to create an AppConfig Application
|
|
202
|
-
* @param {string} id scoped id of the resource
|
|
203
|
-
* @param {common.CommonConstruct} scope scope in which this resource is defined
|
|
204
|
-
* @param {types.AppConfigProps} props
|
|
205
|
-
* @returns {appconfig.CfnApplication}
|
|
206
|
-
*/
|
|
207
|
-
public createApplication(
|
|
208
|
-
id: string,
|
|
209
|
-
scope: common.CommonConstruct,
|
|
210
|
-
props: types.AppConfigProps
|
|
211
|
-
): appconfig.CfnApplication {
|
|
212
|
-
if (!props) throw `AppConfig props undefined`
|
|
213
|
-
|
|
214
|
-
const application = new appconfig.CfnApplication(scope, `${id}`, {
|
|
215
|
-
name: `${props.application.name}-${scope.props.stage}`,
|
|
216
|
-
description: props.application.description,
|
|
217
|
-
tags: props.application.tags,
|
|
218
|
-
})
|
|
219
|
-
|
|
220
|
-
utils.createCfnOutput(`${id}-ApplicationId`, scope, cdk.Fn.ref(application.logicalId))
|
|
221
|
-
utils.createCfnOutput(`${id}-ApplicationName`, scope, application.name)
|
|
222
|
-
|
|
223
|
-
return application
|
|
224
|
-
}
|
|
225
|
-
|
|
226
|
-
/**
|
|
227
|
-
* @summary Method to create an AppConfig Environment for a given application
|
|
228
|
-
* @param {string} id scoped id of the resource
|
|
229
|
-
* @param {common.CommonConstruct} scope scope in which this resource is defined
|
|
230
|
-
* @param {string} applicationId id of the application
|
|
231
|
-
* @param {types.AppConfigProps} props
|
|
232
|
-
* @returns {appconfig.CfnEnvironment}
|
|
233
|
-
*/
|
|
234
|
-
public createEnvironment(
|
|
235
|
-
id: string,
|
|
236
|
-
scope: common.CommonConstruct,
|
|
237
|
-
applicationId: string,
|
|
238
|
-
props: types.AppConfigProps
|
|
239
|
-
): appconfig.CfnEnvironment {
|
|
240
|
-
if (!props) throw `AppConfig props undefined`
|
|
241
|
-
|
|
242
|
-
const environment = new appconfig.CfnEnvironment(scope, `${id}`, {
|
|
243
|
-
applicationId: applicationId,
|
|
244
|
-
name: scope.props.stage,
|
|
245
|
-
description: props.environment.description,
|
|
246
|
-
monitors: props.environment.monitors,
|
|
247
|
-
tags: props.environment.tags,
|
|
248
|
-
})
|
|
249
|
-
|
|
250
|
-
utils.createCfnOutput(`${id}-configurationEnvironmentId`, scope, cdk.Fn.ref(environment.logicalId))
|
|
251
|
-
utils.createCfnOutput(`${id}-configurationEnvironmentName`, scope, environment.name)
|
|
252
|
-
|
|
253
|
-
return environment
|
|
254
|
-
}
|
|
255
|
-
|
|
256
|
-
/**
|
|
257
|
-
* @summary Method to create an AppConfig Configuration Profile for a given application
|
|
258
|
-
* - <p>&#9888; The <b>locationUri</b> is defaulted to <i>hosted</i> if undefined</p>
|
|
259
|
-
* @param {string} id scoped id of the resource
|
|
260
|
-
* @param {common.CommonConstruct} scope scope in which this resource is defined
|
|
261
|
-
* @param {string} applicationId id of the application
|
|
262
|
-
* @param {types.AppConfigProps} props
|
|
263
|
-
* @returns {appconfig.CfnConfigurationProfile}
|
|
264
|
-
*/
|
|
265
|
-
public createConfigurationProfile(
|
|
266
|
-
id: string,
|
|
267
|
-
scope: common.CommonConstruct,
|
|
268
|
-
applicationId: string,
|
|
269
|
-
props: types.AppConfigProps
|
|
270
|
-
): appconfig.CfnConfigurationProfile {
|
|
271
|
-
if (!props) throw `AppConfig props undefined`
|
|
272
|
-
|
|
273
|
-
const profile = new appconfig.CfnConfigurationProfile(scope, `${id}`, {
|
|
274
|
-
applicationId: applicationId,
|
|
275
|
-
locationUri: props.configurationProfile.locationUri || 'hosted',
|
|
276
|
-
name: `${props.configurationProfile.name}-${scope.props.stage}`,
|
|
277
|
-
description: props.configurationProfile.description,
|
|
278
|
-
retrievalRoleArn: props.configurationProfile.retrievalRoleArn,
|
|
279
|
-
tags: props.configurationProfile.tags,
|
|
280
|
-
validators: props.configurationProfile.validators,
|
|
281
|
-
})
|
|
282
|
-
|
|
283
|
-
utils.createCfnOutput(`${id}-configurationProfileId`, scope, cdk.Fn.ref(profile.logicalId))
|
|
284
|
-
utils.createCfnOutput(`${id}-configurationProfileName`, scope, profile.name)
|
|
285
|
-
|
|
286
|
-
return profile
|
|
287
|
-
}
|
|
288
|
-
}
|
|
289
|
-
</code></pre>
|
|
290
|
-
</article>
|
|
291
|
-
</section>
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
</div>
|
|
297
|
-
|
|
298
|
-
</div>
|
|
299
|
-
<div id="side-nav" class="side-nav">
|
|
300
|
-
</div>
|
|
301
|
-
</div>
|
|
302
|
-
<script src="scripts/app.min.js"></script>
|
|
303
|
-
<script>PR.prettyPrint();</script>
|
|
304
|
-
<script src="scripts/linenumber.js"> </script>
|
|
305
|
-
|
|
306
|
-
<script src="scripts/search.js"> </script>
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
</body>
|
|
310
|
-
</html>
|