feat: Typescript example of AWS AppConfig hosted configuration with lambda using AppConfig Lambda extension integration #361

ScottHand · 2020-11-02T16:19:58Z

AWS AppConfig hosted configuration example with consuming Lambda using AppConfig Lambda extension integration.

Fixes #360

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

…lambda extension integration

…mples

mergify · 2020-11-02T16:21:13Z

Title does not follow the guidelines of Conventional Commits. Please adjust title before merge.

NGL321

This looks like a great potential addition to the examples library, I have a few suggestions that unfortunately may take a bit of effort to add, but I can review additions/fixes incrementally if you would prefer.

My main suggestions revolve around the idea that this needs to be a helpful example, and while the code itself can help people set up their own AppConfig stacks, the lack of explanatory comments makes it a little challenging to grok the reasoning behind it.

Thanks in advance for the contribution!!

😸 😷 🚀

NGL321 · 2020-11-12T04:00:11Z

typescript/appconfig-hosted-configuration-lambda-extension/index.ts

@@ -0,0 +1,89 @@
+import * as cdk from '@aws-cdk/core';
+import { CfnApplication, CfnEnvironment, CfnConfigurationProfile, CfnHostedConfigurationVersion, CfnDeploymentStrategy, CfnDeployment } from '@aws-cdk/aws-appconfig';


You should space long imports on separate lines (or import * and use an accessor

Suggested change

import { CfnApplication, CfnEnvironment, CfnConfigurationProfile, CfnHostedConfigurationVersion, CfnDeploymentStrategy, CfnDeployment } from '@aws-cdk/aws-appconfig';

import {

CfnApplication,

CfnEnvironment,

CfnConfigurationProfile,

CfnHostedConfigurationVersion,

CfnDeploymentStrategy,

CfnDeployment

} from '@aws-cdk/aws-appconfig';

NGL321 · 2020-11-12T04:10:35Z

typescript/appconfig-hosted-configuration-lambda-extension/src/lambda-handler.ts

+	return [
+		{
+			name: 'AWS AppConfig'
+		},
+		{
+			name: 'Amazon SageMaker Studio'
+		},
+		{
+			name: 'Amazon Kendra'
+		},
+		{
+			name: 'Amazon CodeGuru'
+		},
+		{
+			name: 'Amazon Fraud Detector'
+		},
+		{
+			name: 'Amazon EKS on AWS Fargate'
+		},
+		{
+			name: 'AWS Outposts'
+		},
+		{
+			name: 'AWS Wavelength'
+		},
+		{
+			name: 'AWS Transit Gateway'
+		},
+		{
+			name: 'Amazon Detective'
+		}
+	]


You can make this a little more condensed while still obeying the eslint rules.

Suggested change

return [

{

name: 'AWS AppConfig'

},

{

name: 'Amazon SageMaker Studio'

},

{

name: 'Amazon Kendra'

},

{

name: 'Amazon CodeGuru'

},

{

name: 'Amazon Fraud Detector'

},

{

name: 'Amazon EKS on AWS Fargate'

},

{

name: 'AWS Outposts'

},

{

name: 'AWS Wavelength'

},

{

name: 'AWS Transit Gateway'

},

{

name: 'Amazon Detective'

}

]

return [

{ name: 'AWS AppConfig' },

{ name: 'Amazon SageMaker Studio' },

{ name: 'Amazon Kendra' },

{ name: 'Amazon CodeGuru' },

{ name: 'Amazon Fraud Detector' },

{ name: 'Amazon EKS on AWS Fargate' },

{ name: 'AWS Outposts' },

{ name: 'AWS Wavelength' },

{ name: 'AWS Transit Gateway' },

{ name: 'Amazon Detective' }

]

NGL321 · 2020-11-12T04:14:58Z

typescript/appconfig-hosted-configuration-lambda-extension/README.md

+<!--BEGIN STABILITY BANNER-->
+---
+
+![Stability: Stable](https://img.shields.io/badge/stability-Stable-success.svg?style=for-the-badge)


This actually isn't considered a "stable" module since only the L1 containing Cfn resources exists. You can see the banner here and explanation of reasoning here

NGL321 · 2020-11-12T04:17:32Z

typescript/appconfig-hosted-configuration-lambda-extension/index.ts

+		const application = new CfnApplication(this,'AppConfigApplication', {
+			name: 'AppConfigSampleApplication',
+			description: 'Sample AppConfig Application using CDK'
+		});
+
+		const environment = new CfnEnvironment(this, 'LambdaDevelopmentEnvironment', {
+			applicationId: application.ref,
+			name: 'AppConfigSampleLambdaDevelopmentEnvironment',
+			description: 'Sample AppConfig Development environment for Lambda implementation'
+		});
+
+		const configurationProfile = new CfnConfigurationProfile(this, 'ConfigurationProfile', {
+			applicationId: application.ref,
+			name: 'AppConfigSampleConfigurationProfile',
+			locationUri: 'hosted',
+			description: 'Sample AppConfig configuration profile'
+		});
+
+		const hostedConfigurationProfile = new CfnHostedConfigurationVersion(this, 'HostedConfigurationProfile', {
+			applicationId: application.ref,
+			configurationProfileId: configurationProfile.ref,
+			contentType: 'application/json',
+			content: '{\"boolEnableLimitResults\": true, \"intResultLimit\":5}',
+			latestVersionNumber: 1
+		});
+
+		hostedConfigurationProfile.addMetadata('description', 'Sample AppConfig hosted configuration profile content');
+
+		const deploymentStrategy = new CfnDeploymentStrategy(this, 'DeploymentStrategy', {
+			name: 'Custom.AllAtOnce',
+			deploymentDurationInMinutes: 0,
+			growthFactor: 100,
+			finalBakeTimeInMinutes: 0,
+			replicateTo: 'NONE',
+			growthType: 'LINEAR',
+			description: 'Sample AppConfig deployment strategy - All at once deployment (i.e., immediate)'
+		});
+
+		const deployment = new CfnDeployment(this, 'Deployment', {
+			applicationId: application.ref,
+			configurationProfileId: configurationProfile.ref,
+			configurationVersion: '1',
+			deploymentStrategyId: deploymentStrategy.ref,
+			environmentId: environment.ref,
+		});


Consider leaving an inline comment to indicate that these are essential components to an AppConfig configuration, and explain what each does along the way.

For inspiration, take a look at the Cloudformation description

NGL321 · 2020-11-12T04:20:10Z

typescript/appconfig-hosted-configuration-lambda-extension/index.ts

+			description: 'Sample AppConfig Application using CDK'
+		});
+
+		const environment = new CfnEnvironment(this, 'LambdaDevelopmentEnvironment', {


It would be useful here to include both a dev and prod environment with appropriate configurations for each. This would show the real power/reason to use AppConfig over a standard deployment strategy.

NGL321 · 2020-11-12T04:34:18Z

typescript/appconfig-hosted-configuration-lambda-extension/index.ts

+
+		deployment.addDependsOn(hostedConfigurationProfile);
+
+		deployment.addMetadata('description', 'Sample AppConfig initial deployment');


Again, provide in props?

NGL321 · 2020-11-12T04:35:28Z

typescript/appconfig-hosted-configuration-lambda-extension/README.md

+---
+<!--END STABILITY BANNER-->
+
+This an example of AppConfig fature toggle use case with a hosted configuration and a consuming Lambda using AppConfig Lambda extension integration.


This would be a great place to include a brief description of why this pattern might be useful.
eg. "Deploying an AppConfig resource can allow for easier deployments to multiple environments from development to production and allow for easier changing of necessary configurations depending on environment ...."

NGL321 · 2020-11-12T04:37:17Z

typescript/appconfig-hosted-configuration-lambda-extension/index.ts

+		deployment.addMetadata('description', 'Sample AppConfig initial deployment');
+
+		const sampleAppConfigLambda = new Function(this, 'sampleAppConfigLambda', {
+			code: new AssetCode('src'),


By standards this should be:

Suggested change

code: new AssetCode('src'),

code: Code.fromAsset('src'),

This also requires adjusting imports

NGL321 · 2020-11-12T04:39:17Z

typescript/appconfig-hosted-configuration-lambda-extension/src/lambda-handler.ts

+	// retrieve AppConfig configuration data from Lambda extension
+	const res: any = await new Promise((resolve) => {
+		http.get(
+			`http://localhost:2772/applications/AppConfigSampleApplication/environments/AppConfigSampleLambdaDevelopmentEnvironment/configurations/AppConfigSampleConfigurationProfile`,


Maybe I'm missing something, but I dont see where this URL is coming from

I believe this only works with Lambda/ECS/Fargate workloads, normally you would acquire these config values via the AWS SDK: https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-integration-lambda-extensions.html#appconfig-integration-lambda-extensions-enabling

There's also this blog post that references the localhost URL proxy: https://aws.amazon.com/blogs/mt/introducing-aws-appconfig-lambda-extension-deploying-application-configuration-serverless/

NGL321 · 2020-11-12T04:42:40Z

typescript/appconfig-hosted-configuration-lambda-extension/README.md

+<!--END STABILITY BANNER-->
+
+This an example of AppConfig fature toggle use case with a hosted configuration and a consuming Lambda using AppConfig Lambda extension integration.
+


An explanation of the purpose of the lambda would also be important here. At the moment it is very difficult to decipher (and I imagine even more so for someone with less context than me).

ryparker · 2021-09-30T22:22:49Z

@ScottHand Would you mind addressing NGL321's review?

indrora · 2022-09-22T17:50:01Z

This PR has not been touched since before the release of CDKv2. Closing.

Scott Hand added 2 commits November 2, 2020 11:07

added AWS AppConfig hosted configuration with lambda using AppConfig …

d781f7d

…lambda extension integration

updated README to include appconfig example in list of Typescript exa…

469bb0a

…mples

ScottHand changed the title ~~added AWS AppConfig hosted configuration with lambda using AppConfig …~~ feat: Typescript AWS AppConfig hosted configuration with lambda using AppConfig Lambda extension integration Nov 2, 2020

ScottHand changed the title ~~feat: Typescript AWS AppConfig hosted configuration with lambda using AppConfig Lambda extension integration~~ feat: Typescript example of AWS AppConfig hosted configuration with lambda using AppConfig Lambda extension integration Nov 2, 2020

changed cdk versions to *

4c67b1d

ScottHand mentioned this pull request Nov 2, 2020

AWS AppConfig Hosted Configuration Typescript Example #360

Open

2 tasks

SomayaB assigned NGL321 Nov 2, 2020

NGL321 suggested changes Nov 12, 2020

View reviewed changes

ryparker added the language/typescript Related to Typescript examples label Jul 9, 2021

NGL321 removed their assignment Jul 19, 2021

indrora closed this Sep 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Typescript example of AWS AppConfig hosted configuration with lambda using AppConfig Lambda extension integration #361

feat: Typescript example of AWS AppConfig hosted configuration with lambda using AppConfig Lambda extension integration #361

ScottHand commented Nov 2, 2020 •

edited by SomayaB

Loading

mergify bot commented Nov 2, 2020

NGL321 left a comment

NGL321 Nov 12, 2020

NGL321 Nov 12, 2020

NGL321 Nov 12, 2020

NGL321 Nov 12, 2020

NGL321 Nov 12, 2020

NGL321 Nov 12, 2020

NGL321 Nov 12, 2020

NGL321 Nov 12, 2020

NGL321 Nov 12, 2020

giantcow Mar 2, 2021

NGL321 Nov 12, 2020

ryparker commented Sep 30, 2021

indrora commented Sep 22, 2022

		@@ -0,0 +1,89 @@
		import * as cdk from '@aws-cdk/core';
		import { CfnApplication, CfnEnvironment, CfnConfigurationProfile, CfnHostedConfigurationVersion, CfnDeploymentStrategy, CfnDeployment } from '@aws-cdk/aws-appconfig';


		deployment.addDependsOn(hostedConfigurationProfile);

		deployment.addMetadata('description', 'Sample AppConfig initial deployment');

		<!--END STABILITY BANNER-->

		This an example of AppConfig fature toggle use case with a hosted configuration and a consuming Lambda using AppConfig Lambda extension integration.

feat: Typescript example of AWS AppConfig hosted configuration with lambda using AppConfig Lambda extension integration #361

feat: Typescript example of AWS AppConfig hosted configuration with lambda using AppConfig Lambda extension integration #361

Conversation

ScottHand commented Nov 2, 2020 • edited by SomayaB Loading

mergify bot commented Nov 2, 2020

NGL321 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ryparker commented Sep 30, 2021

indrora commented Sep 22, 2022

ScottHand commented Nov 2, 2020 •

edited by SomayaB

Loading