Procedura dettagliata - Parte 1 - Costrutti delle soluzioni AWS

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Procedura dettagliata - Parte 1

Nota

Costrutti di AWS Solutions è supportato sulle versioni CDK ≥ 1.46.0.

Questo tutorial illustra come creare e distribuire una semplice app AWS CDK «Hello Constructs» che utilizza un modello di AWS Solutions Constructs, dall'inizializzazione del progetto alla distribuzione del modello AWS CloudFormation risultante. L'app Hello Constructs creerà la seguente semplice soluzione:


      Diagramma dell'architettura

Costrutti di Hello

Iniziamo a costruire la nostra prima app CDK AWS utilizzando lo sviluppo basato su pattern.

Nota

Questa è una modifica di esempio diHello CDK!dagliWorkshop CDK: . Se questa è la prima volta che utilizzi AWS CDK, ti consigliamo di iniziare con questo workshop per una procedura dettagliata pratica e come sfruttare il CDK nella costruzione di un progetto reale.

Creazione della directory delle app e inizializzazione del CDK AWS

Creare una directory per l'app CDK e quindi creare un'app AWS CDK in tale directory.

TypeScript
mkdir hello-constructs cd hello-constructs cdk init --language typescript
Python
mkdir hello-constructs cd hello-constructs cdk init --language python
Suggerimento

Ora è il momento giusto per aprire il progetto nel tuo IDE preferito ed esplorare. Per ulteriori informazioni sulla struttura del progetto, seleziona il collegamento appropriato:

Aggiorna le dipendenze di base di

avvertimento

Per garantire la corretta funzionalità, AWS Solutions Constructs e AWS CDK pacchetti devono utilizzare lo stesso numero di versione all'interno del progetto. Ad esempio, se si utilizza AWS Solutions Constructs v.1.52.0, è necessario utilizzare anche AWS CDK v.1.52.0.

Suggerimento

Prendere nota della versione più recente di AWS Solutions Constructs e applicare tale numero di versione alVERSION_NUMBERnella procedura riportata di seguito (sia per AWS Solutions Constructs che per i pacchetti AWS CDK). Per controllare tutte le versioni pubbliche della libreria Costrutts,Fare clic qui: .

TypeScript

Modificare il filepackage.jsoncon le seguenti informazioni:

"devDependencies": { "@aws-cdk/assert": "VERSION_NUMBER", "@types/jest": "^24.0.22", "@types/node": "10.17.5", "jest": "^24.9.0", "ts-jest": "^24.1.0", "aws-cdk": "VERSION_NUMBER", "ts-node": "^8.1.0", "typescript": "~3.7.2" }, "dependencies": { "@aws-cdk/core": "VERSION_NUMBER", "source-map-support": "^0.5.16" }
Python

Modificare il filesetup.pycon le seguenti informazioni:

install_requires=[ "aws-cdk.core==VERSION_NUMBER", ],

Installare le dipendenze di base dei progetti.

TypeScript
npm install
Python
source .venv/bin/activate pip install -r requirements.txt

Crea ed esegui l'app e conferma che crea uno stack vuoto.

TypeScript
npm run build cdk synth
Python
cdk synth

Dovresti vedere uno stack come il seguente, doveCDK-VERSIONè la versione del CDK. (Il tuo output potrebbe differire leggermente da quello mostrato qui.)

TypeScript
Resources: CDKMetadata: Type: AWS::CDK::Metadata Properties: Modules: aws-cdk=CDK-VERSION,@aws-cdk/core=VERSION_NUMBER,@aws-cdk/cx-api=VERSION_NUMBER,jsii-runtime=node.js/10.17.0
Python
Resources: CDKMetadata: Type: AWS::CDK::Metadata Properties: Modules: aws-cdk=CDK-VERSION,@aws-cdk/core=VERSION_NUMBER,@aws-cdk/cx-api=VERSION_NUMBER,jsii-runtime=Python/3.7.7

Codice del gestore Lambda

Inizieremo con il codice gestore AWS Lambda.

Creazione di una directorylambdanella directory root dell'albero del progetto.

TypeScript

Aggiungere un file denominatolambda/hello.jscon i seguenti contenuti:

exports.handler = async function(event) { console.log("request:", JSON.stringify(event, null, 2)); return { statusCode: 200, headers: { "Content-Type": "text/plain" }, body: `Hello, AWS Solutions Constructs! You've hit ${event.path}\n` }; };
Python

Aggiungere un file denominatolambda/hello.pycon i seguenti contenuti:

import json def handler(event, context): print('request: {}'.format(json.dumps(event))) return { 'statusCode': 200, 'headers': { 'Content-Type': 'text/plain' }, 'body': 'Hello, CDK! You have hit {}\n'.format(event['path']) }

Questa è una semplice funzione Lambda che restituisce il testo «Ciao, costrutti! Hai colpito [url path]». L'output della funzione include anche il codice di stato HTTP e le intestazioni HTTP. Questi vengono utilizzati da API Gateway per formulare la risposta HTTP all'utente.

Questa Lambda è fornita in JavaScript. Per ulteriori informazioni sulla scrittura delle funzioni Lambda nella lingua di scelta, fare riferimento allaDocumentazione AWS Lambda: .

Installare le dipendenze di AWS CDK e AWS Solutions Constructs

AWS Solutions Constructs viene fornito con una vasta libreria di costrutti. La libreria è divisa in moduli, uno per ogni modello ben progettato. Ad esempio, se si desidera definire un'Amazon API Gateway Rest API per una funzione AWS Lambda, sarà necessario utilizzare ilaws-apigateway-lambdaLibreria di pattern.

Abbiamo anche bisogno di aggiungere la libreria di costrutto AWS Lambda e Amazon API Gateway dal CDK AWS.

Installa il modulo AWS Lambda e tutte le sue dipendenze nel nostro progetto:

Nota

Ricordarsi di sostituire la versione corretta e corrispondente da utilizzare sia per AWS Solutions Constructs che per AWS CDK nelVERSION_NUMBERcampi segnaposto per ogni comando. La mancata corrispondenza delle versioni tra i pacchetti può causare errori.

TypeScript
npm install -s @aws-cdk/aws-lambda@VERSION_NUMBER
Python
pip install aws_cdk.aws_lambda==VERSION_NUMBER

Successivamente, installa il modulo Amazon API Gateway e tutte le sue dipendenze nel nostro progetto:

TypeScript
npm install -s @aws-cdk/aws-apigateway@VERSION_NUMBER
Python
pip install aws_cdk.aws_apigateway==VERSION_NUMBER

Infine, installa i costrutti di soluzioni AWSaws-apigateway-lambdae tutte le sue dipendenze nel nostro progetto:

TypeScript
npm install -s @aws-solutions-constructs/aws-apigateway-lambda@VERSION_NUMBER
Python
pip install aws_solutions_constructs.aws_apigateway_lambda==VERSION_NUMBER

Aggiungi un gateway API Amazon/modello AWS Lambda al tuo stack

Ora, definiamo il modello AWS Solutions Constructs per l'implementazione di un Amazon API Gateway con un proxy AWS Lambda.

TypeScript

Modificare il filelib/hello-constructs.tscon gli elementi seguenti:

import * as cdk from '@aws-cdk/core'; import * as lambda from '@aws-cdk/aws-lambda'; import * as api from '@aws-cdk/aws-apigateway'; import { ApiGatewayToLambda, ApiGatewayToLambdaProps } from '@aws-solutions-constructs/aws-apigateway-lambda'; export class HelloConstructsStack extends cdk.Stack { constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) { super(scope, id, props); // The code that defines your stack goes here const api_lambda_props: ApiGatewayToLambdaProps = { lambdaFunctionProps: { code: lambda.Code.fromAsset('lambda'), runtime: lambda.Runtime.NODEJS_12_X, handler: 'hello.handler' }, apiGatewayProps: { defaultMethodOptions: { authorizationType: api.AuthorizationType.NONE } } }; new ApiGatewayToLambda(this, 'ApiGatewayToLambda', api_lambda_props); } }
Python

Modificare il filehello_constructs/hello_constructs_stack.pycon gli elementi seguenti:

from aws_cdk import ( aws_lambda as _lambda, aws_apigateway as apigw, core, ) from aws_solutions_constructs import ( aws_apigateway_lambda as apigw_lambda ) class HelloConstructsStack(core.Stack): def __init__(self, scope: core.Construct, id: str, **kwargs) -> None: super().__init__(scope, id, **kwargs) # The code that defines your stack goes here apigw_lambda.ApiGatewayToLambda( self, 'ApiGatewayToLambda', lambda_function_props=_lambda.FunctionProps( runtime=_lambda.Runtime.PYTHON_3_7, code=_lambda.Code.asset('lambda'), handler='hello.handler', ), api_gateway_props=apigw.RestApiProps( default_method_options=apigw.MethodOptions( authorization_type=apigw.AuthorizationType.NONE ) ) )

Questo è tutto. Questo è tutto ciò che devi fare per definire un API Gateway che proxy tutte le richieste a una funzione AWS Lambda. Confrontiamo il nostro nuovo stack con quello originale:

TypeScript
npm run build cdk diff
Python
cdk diff

L'output dovrebbe essere simile al seguente:

Stack HelloConstructsStack
IAM Statement Changes
┌───┬─────────────────────────────┬────────┬─────────────────────────────┬─────────────────────────────┬──────────────────────────────┐
│   │ Resource                    │ Effect │ Action                      │ Principal                   │ Condition                    │
├───┼─────────────────────────────┼────────┼─────────────────────────────┼─────────────────────────────┼──────────────────────────────┤
│ + │ ${LambdaFunction.Arn}       │ Allow  │ lambda:InvokeFunction       │ Service:apigateway.amazonaw │ "ArnLike": {                 │
│   │                             │        │                             │ s.com                       │   "AWS:SourceArn": "arn:${AW │
│   │                             │        │                             │                             │ S::Partition}:execute-api:${ │
│   │                             │        │                             │                             │ AWS::Region}:${AWS::AccountI │
│   │                             │        │                             │                             │ d}:${RestApi0C43BF4B}/${Rest │
│   │                             │        │                             │                             │ Api/DeploymentStage.prod}/*/ │
│   │                             │        │                             │                             │ {proxy+}"                    │
│   │                             │        │                             │                             │ }                            │
│ + │ ${LambdaFunction.Arn}       │ Allow  │ lambda:InvokeFunction       │ Service:apigateway.amazonaw │ "ArnLike": {                 │
│   │                             │        │                             │ s.com                       │   "AWS:SourceArn": "arn:${AW │
│   │                             │        │                             │                             │ S::Partition}:execute-api:${ │
│   │                             │        │                             │                             │ AWS::Region}:${AWS::AccountI │
│   │                             │        │                             │                             │ d}:${RestApi0C43BF4B}/test-i │
│   │                             │        │                             │                             │ nvoke-stage/*/{proxy+}"      │
│   │                             │        │                             │                             │ }                            │
│ + │ ${LambdaFunction.Arn}       │ Allow  │ lambda:InvokeFunction       │ Service:apigateway.amazonaw │ "ArnLike": {                 │
│   │                             │        │                             │ s.com                       │   "AWS:SourceArn": "arn:${AW │
│   │                             │        │                             │                             │ S::Partition}:execute-api:${ │
│   │                             │        │                             │                             │ AWS::Region}:${AWS::AccountI │
│   │                             │        │                             │                             │ d}:${RestApi0C43BF4B}/${Rest │
│   │                             │        │                             │                             │ Api/DeploymentStage.prod}/*/ │
│   │                             │        │                             │                             │ "                            │
│   │                             │        │                             │                             │ }                            │
│ + │ ${LambdaFunction.Arn}       │ Allow  │ lambda:InvokeFunction       │ Service:apigateway.amazonaw │ "ArnLike": {                 │
│   │                             │        │                             │ s.com                       │   "AWS:SourceArn": "arn:${AW │
│   │                             │        │                             │                             │ S::Partition}:execute-api:${ │
│   │                             │        │                             │                             │ AWS::Region}:${AWS::AccountI │
│   │                             │        │                             │                             │ d}:${RestApi0C43BF4B}/test-i │
│   │                             │        │                             │                             │ nvoke-stage/*/"              │
│   │                             │        │                             │                             │ }                            │
├───┼─────────────────────────────┼────────┼─────────────────────────────┼─────────────────────────────┼──────────────────────────────┤
│ + │ ${LambdaFunctionServiceRole │ Allow  │ sts:AssumeRole              │ Service:lambda.amazonaws.co │                              │
│   │ .Arn}                       │        │                             │ m                           │                              │
├───┼─────────────────────────────┼────────┼─────────────────────────────┼─────────────────────────────┼──────────────────────────────┤
│ + │ ${LambdaRestApiCloudWatchRo │ Allow  │ sts:AssumeRole              │ Service:apigateway.amazonaw │                              │
│   │ le.Arn}                     │        │                             │ s.com                       │                              │
├───┼─────────────────────────────┼────────┼─────────────────────────────┼─────────────────────────────┼──────────────────────────────┤
│ + │ arn:aws:logs:${AWS::Region} │ Allow  │ logs:CreateLogGroup         │ AWS:${LambdaRestApiCloudWat │                              │
│   │ :${AWS::AccountId}:*        │        │ logs:CreateLogStream        │ chRole}                     │                              │
│   │                             │        │ logs:DescribeLogGroups      │                             │                              │
│   │                             │        │ logs:DescribeLogStreams     │                             │                              │
│   │                             │        │ logs:FilterLogEvents        │                             │                              │
│   │                             │        │ logs:GetLogEvents           │                             │                              │
│   │                             │        │ logs:PutLogEvents           │                             │                              │
├───┼─────────────────────────────┼────────┼─────────────────────────────┼─────────────────────────────┼──────────────────────────────┤
│ + │ arn:aws:logs:${AWS::Region} │ Allow  │ logs:CreateLogGroup         │ AWS:${LambdaFunctionService │                              │
│   │ :${AWS::AccountId}:log-grou │        │ logs:CreateLogStream        │ Role}                       │                              │
│   │ p:/aws/lambda/*             │        │ logs:PutLogEvents           │                             │                              │
└───┴─────────────────────────────┴────────┴─────────────────────────────┴─────────────────────────────┴──────────────────────────────┘
(NOTE: There may be security-related changes not in this list. See https://github.com/aws/aws-cdk/issues/1299)

Parameters
[+] Parameter AssetParameters/ba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340a/S3Bucket AssetParametersba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340aS3Bucket9780A3BC: {"Type":"String","Description":"S3 bucket for asset \"ba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340a\""}
[+] Parameter AssetParameters/ba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340a/S3VersionKey AssetParametersba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340aS3VersionKey37F36FFB: {"Type":"String","Description":"S3 key for asset version \"ba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340a\""}
[+] Parameter AssetParameters/ba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340a/ArtifactHash AssetParametersba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340aArtifactHash80199FBC: {"Type":"String","Description":"Artifact hash for asset \"ba91444ebd644d9419e8cfee417f3aaa728507dd428788a2fc40574646c4340a\""}

Conditions
[+] Condition CDKMetadataAvailable: {"Fn::Or":[{"Fn::Or":[{"Fn::Equals":[{"Ref":"AWS::Region"},"ap-east-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"ap-northeast-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"ap-northeast-2"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"ap-south-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"ap-southeast-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"ap-southeast-2"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"ca-central-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"cn-north-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"cn-northwest-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"eu-central-1"]}]},{"Fn::Or":[{"Fn::Equals":[{"Ref":"AWS::Region"},"eu-north-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"eu-west-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"eu-west-2"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"eu-west-3"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"me-south-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"sa-east-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"us-east-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"us-east-2"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"us-west-1"]},{"Fn::Equals":[{"Ref":"AWS::Region"},"us-west-2"]}]}]}

Resources
[+] AWS::Logs::LogGroup ApiGatewayToLambda/ApiAccessLogGroup ApiGatewayToLambdaApiAccessLogGroupE2B41502 
[+] AWS::IAM::Role LambdaFunctionServiceRole LambdaFunctionServiceRole0C4CDE0B 
[+] AWS::Lambda::Function LambdaFunction LambdaFunctionBF21E41F 
[+] AWS::ApiGateway::RestApi RestApi RestApi0C43BF4B 
[+] AWS::ApiGateway::Deployment RestApi/Deployment RestApiDeployment180EC503d2c6df3c8dc8b7193b98c1a0bff4e677 
[+] AWS::ApiGateway::Stage RestApi/DeploymentStage.prod RestApiDeploymentStageprod3855DE66 
[+] AWS::ApiGateway::Resource RestApi/Default/{proxy+} RestApiproxyC95856DD 
[+] AWS::Lambda::Permission RestApi/Default/{proxy+}/ANY/ApiPermission.HelloConstructsStackRestApiFDB18C2E.ANY..{proxy+} RestApiproxyANYApiPermissionHelloConstructsStackRestApiFDB18C2EANYproxyE43D39B3 
[+] AWS::Lambda::Permission RestApi/Default/{proxy+}/ANY/ApiPermission.Test.HelloConstructsStackRestApiFDB18C2E.ANY..{proxy+} RestApiproxyANYApiPermissionTestHelloConstructsStackRestApiFDB18C2EANYproxy0B23CDC7 
[+] AWS::ApiGateway::Method RestApi/Default/{proxy+}/ANY RestApiproxyANY1786B242 
[+] AWS::Lambda::Permission RestApi/Default/ANY/ApiPermission.HelloConstructsStackRestApiFDB18C2E.ANY.. RestApiANYApiPermissionHelloConstructsStackRestApiFDB18C2EANY5684C1E6 
[+] AWS::Lambda::Permission RestApi/Default/ANY/ApiPermission.Test.HelloConstructsStackRestApiFDB18C2E.ANY.. RestApiANYApiPermissionTestHelloConstructsStackRestApiFDB18C2EANY81DBDF56 
[+] AWS::ApiGateway::Method RestApi/Default/ANY RestApiANYA7C1DC94 
[+] AWS::ApiGateway::UsagePlan RestApi/UsagePlan RestApiUsagePlan6E1C537A 
[+] AWS::Logs::LogGroup ApiAccessLogGroup ApiAccessLogGroupCEA70788 
[+] AWS::IAM::Role LambdaRestApiCloudWatchRole LambdaRestApiCloudWatchRoleF339D4E6 
[+] AWS::ApiGateway::Account LambdaRestApiAccount LambdaRestApiAccount 

Outputs
[+] Output RestApi/Endpoint RestApiEndpoint0551178A: {"Value":{"Fn::Join":["",["https://",{"Ref":"RestApi0C43BF4B"},".execute-api.",{"Ref":"AWS::Region"},".",{"Ref":"AWS::URLSuffix"},"/",{"Ref":"RestApiDeploymentStageprod3855DE66"},"/"]]}}

Che bello. Questo semplice esempio con un modello ben progettato da AWS Solutions Constructs ha aggiunto 21 nuove risorse al tuo stack.

Distribuzione di cdk

Suggerimento

Prima di poter distribuire la prima app AWS CDK contenente una funzione Lambda, è necessario eseguire il bootstrap dell'ambiente AWS. Questo crea un bucket di gestione temporanea che AWS CDK utilizza per distribuire stack contenenti risorse. Se questa è la prima volta che si utilizza AWS CDK per distribuire le risorse, sarà necessario eseguire il comandocdk bootstrapper distribuire lo stack di toolkit CDK nel tuo ambiente AWS.

Pronti per la distribuzione?

cdk deploy

Output dello stack

Al termine della distribuzione, noterai questa riga:

Outputs:
HelloConstructsStack.RestApiEndpoint0551178A = https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/prod/

Si tratta di un output dello stack che viene aggiunto automaticamente dal modello AWS Solutions Constructs e include l'URL dell'endpoint del API Gateway.

Esecuzione del test dell'app

Proviamo a colpire questo endpoint concurl: . Copia l'URL ed esegui (il tuo prefisso e la tua regione saranno probabilmente diversi).

curl https://xxxxxxxxxx.execute-api.us-east-1.amazonaws.com/prod/

L'output dovrebbe essere simile al seguente:

Hello, AWS Solutions Constructs! You've hit /

Se questo è l'output che hai ricevuto, la tua app funziona!