Requisitos previos Acerca de este tutorial Paso 1: cree su proyecto de CDK Paso 2: Configure su entorno AWS Paso 3: Inicie su entorno AWS Paso 4: cree su aplicación de CDK Paso 5: enumere las pilas de CDK de su aplicación Paso 6: defina la función de Lambda Paso 7: implemente la URL de función de Lambda Paso 8: Sintetizar una plantilla CloudFormation Paso 9: implemente su pila de CDK Paso 10: Interactúe con su aplicación en AWS Paso 11: modifique su aplicación Paso 12: elimine la aplicación Pasos a seguir a continuación

Tutorial: Crea tu primera aplicación de AWS CDK

Comience a usar el AWS Cloud Development Kit (AWS CDK) mediante la interfaz de línea de comandos de AWS CDK (AWS CDK CLI) para desarrollar su primera aplicación de CDK, arrancar AWS su entorno e implementar su aplicación. AWS

Requisitos previos

Antes de comenzar este tutorial, complete todos los pasos de configuración que aparecen en Introducción a la CDK. AWS

Acerca de este tutorial

En este tutorial, creará e implementará una aplicación sencilla sobre el AWS uso del AWS CDK. La aplicación consta de una función AWS Lambda que devuelve un Hello World! mensaje cuando se invoca. La función se invocará a través de la URL de la función de Lambda que sirve como punto de conexión HTTP(S) dedicado para la función de Lambda.

A través de este tutorial, hará lo siguiente:

Cree su proyecto: cree un proyecto de CDK mediante el comando cdk init CLI de CDK.
Configure su AWS entorno: configure el AWS entorno en el que implementará la aplicación.
Inicie su AWS entorno: prepare su AWS entorno para la implementación iniciándolo mediante el comando CDK CLI. cdk bootstrap
Desarrolle su aplicación: utilice construcciones de la biblioteca AWS Construct para definir los recursos de URL de la función Lambda y la función Lambda.
Prepare su aplicación para la implementación: use la CLI de CDK para crear su aplicación y sintetizar una AWS CloudFormation plantilla.
Implemente su aplicación: utilice el cdk deploy comando CLI de CDK para implementar su aplicación y aprovisionar sus AWS recursos.
Interactúe con su aplicación: interactúe con la función Lambda AWS desplegada invocándola y recibiendo una respuesta.
Modificar su aplicación: modifique su función de Lambda e impleméntela para aplicar sus cambios.
Eliminar la aplicación: elimine todos los recursos que creó mediante el cdk destroy comando CDK CLI.

Paso 1: cree su proyecto de CDK

En este paso va a crear un proyecto nuevo de CDK. Un proyecto de CDK debe estar en su propio directorio, con sus propias dependencias de módulos locales.

Para crear un proyecto de CDK

Desde el directorio de inicio que elija, cree y navegue hasta un directorio denominado hello-cdk:
```
$ mkdir hello-cdk && cd hello-cdk
```
importante
Asegúrese de asignar un nombre al directorio del proyecto hello-cdk, exactamente como se muestra aquí. La CLI de la CDK usa este nombre de directorio para nombrar las cosas del código de la CDK. Si utiliza otro nombre de directorio, tendrá problemas durante este tutorial.
Desde el hello-cdk directorio, inicialice un nuevo proyecto de CDK mediante el comando CDK CLIcdk init. Especifique la plantilla de la app y su lenguaje de programación preferido con la opción --language:
TypeScript

$ cdk init app --language typescript

JavaScript

$ cdk init app --language javascript

Python

$ cdk init app --language python

Una vez que cree la aplicación, ingrese también los siguientes dos comandos. Estos activan el entorno virtual Python de la aplicación e instalan las dependencias principales del AWS CDK.

$ source .venv/bin/activate # On Windows, run `.\venv\Scripts\activate` instead $ python -m pip install -r requirements.txt

Java

$ cdk init app --language java

Si utiliza un IDE, ahora puede abrir o importar el proyecto. Por ejemplo, en Eclipse, elija Archivo > Importar > Maven > Proyectos de Maven existentes. Asegúrese de que la configuración del proyecto esté configurada para utilizar Java 8 (1.8).

C#

$ cdk init app --language csharp

Si utiliza Visual Studio, abra el archivo de la solución en el directorio src.

Go

$ cdk init app --language go

Una vez creada la aplicación, introduce también el siguiente comando para instalar los módulos de AWS Construct Library que requiere la aplicación.

$ go get

El comando cdk init crea una estructura de archivos y carpetas dentro del directorio hello-cdk para ayudar a organizar el código fuente de la aplicación de CDK. Esta estructura de archivos y carpetas se denomina proyecto de CDK. Tómese un momento para explorar su proyecto de CDK.

Si ha instalado Git, cada proyecto que cree utilizando cdk init se iniciará como un repositorio de Git.

Durante la inicialización del proyecto, la CLI de CDK crea una aplicación de CDK que contiene una única pila de CDK. La instancia de la aplicación de CDK se crea mediante el constructo App. La siguiente es una parte de este código del archivo de aplicación de CDK:

TypeScript

Se encuentra en bin/hello-cdk.ts:


#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import { HelloCdkStack } from '../lib/hello-cdk-stack';

const app = new cdk.App();
new HelloCdkStack(app, 'HelloCdkStack', {
});

JavaScript

Se encuentra en bin/hello-cdk.js:


#!/usr/bin/env node

const cdk = require('aws-cdk-lib');
const { HelloCdkStack } = require('../lib/hello-cdk-stack');

const app = new cdk.App();
new HelloCdkStack(app, 'HelloCdkStack', {
});

Python

Se encuentra en app.py:


#!/usr/bin/env python3
import os

import aws_cdk as cdk

from hello_cdk.hello_cdk_stack import HelloCdkStack

app = cdk.App()
HelloCdkStack(app, "HelloCdkStack",)

app.synth()

Java

Se encuentra en src/main/java/…/HelloCdkApp.java:


package com.myorg;

import software.amazon.awscdk.App;
import software.amazon.awscdk.Environment;
import software.amazon.awscdk.StackProps;

import java.util.Arrays;

public class HelloCdkApp {
  public static void main(final String[] args) {
    App app = new App();

    new HelloCdkStack(app, "HelloCdkStack", StackProps.builder()
      .build());

    app.synth();
  }
}

C#

Se encuentra en src/HelloCdk/Program.cs:


using Amazon.CDK;
using System;
using System.Collections.Generic;
using System.Linq;

namespace HelloCdk
{
  sealed class Program
  {
    public static void Main(string[] args)
    {
      var app = new App();
      new HelloCdkStack(app, "HelloCdkStack", new StackProps
      {});
      app.Synth();
    }
  }
}

Go

Se encuentra en hello-cdk.go:


package main

import (
  "github.com/aws/aws-cdk-go/awscdk/v2"
  "github.com/aws/constructs-go/constructs/v10"
  "github.com/aws/jsii-runtime-go"
)

// ...

func main() {
  defer jsii.Close()

  app := awscdk.NewApp(nil)

  NewHelloCdkStack(app, "HelloCdkStack", &HelloCdkStackProps{
    awscdk.StackProps{
      Env: env(),
    },
  })

  app.Synth(nil)
}

// ...

La pila de CDK se crea mediante el constructo Stack. La siguiente es una parte de este código del archivo de pila de CDK:

TypeScript

Se encuentra en lib/hello-cdk-stack.ts:


import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';

export class HelloCdkStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Define your constructs here

  }
}

JavaScript

Se encuentra en lib/hello-cdk-stack.js:


const { Stack } = require('aws-cdk-lib');

class HelloCdkStack extends Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    // Define your constructs here

  }
}

module.exports = { HelloCdkStack }

Python

Se encuentra en hello_cdk/hello_cdk_stack.py:


from aws_cdk import (
  Stack,
)
from constructs import Construct

class HelloCdkStack(Stack):

  def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
    super().__init__(scope, construct_id, **kwargs)

    # Define your constructs here

Java

Se encuentra en src/main/java/…/HelloCdkStack.java:


package com.myorg;

import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;

public class HelloCdkStack extends Stack {
  public HelloCdkStack(final Construct scope, final String id) {
    this(scope, id, null);
  }

  public HelloCdkStack(final Construct scope, final String id, final StackProps props) {
    super(scope, id, props);

    // Define your constructs here
  }
}

C#

Se encuentra en src/HelloCdk/HelloCdkStack.cs:


using Amazon.CDK;
using Constructs;

namespace HelloCdk
{
  public class HelloCdkStack : Stack
  {
    internal HelloCdkStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
    {
      // Define your constructs here
    }
  }
}

Go

Se encuentra en hello-cdk.go:


package main

import (
  "github.com/aws/aws-cdk-go/awscdk/v2"
  "github.com/aws/constructs-go/constructs/v10"
  "github.com/aws/jsii-runtime-go"
)

type HelloCdkStackProps struct {
  awscdk.StackProps
}

func NewHelloCdkStack(scope constructs.Construct, id string, props *HelloCdkStackProps) awscdk.Stack {
  var sprops awscdk.StackProps
  if props != nil {
    sprops = props.StackProps
  }
  stack := awscdk.NewStack(scope, &id, &sprops)

  return stack
}

// ...

Paso 2: Configure su entorno AWS

En este paso, configurará el AWS entorno de su pila de CDK. De este modo, podrá especificar en qué entorno se implementará su pila de CDK.

En primer lugar, determine el AWS entorno que quiere usar. Un AWS entorno consta de una AWS cuenta y una AWS región.

Cuando usa la AWS CLI para configurar las credenciales de seguridad en su máquina local, puede usar la AWS CLI para obtener información del AWS entorno para un perfil específico.

Para usar la AWS CLI para obtener el ID de su AWS cuenta

Ejecute el siguiente comando AWS CLI para obtener el ID de AWS cuenta default de su perfil:
```
$ aws sts get-caller-identity --query "Account" --output text
```
Si prefiere utilizar un perfil con nombre, proporcione el nombre de su perfil a través de la opción --profile:
```
$ aws sts get-caller-identity --profile your-profile-name --query "Account" --output text
```

Para usar la AWS CLI para obtener su AWS región

Ejecute el siguiente comando AWS CLI para obtener la región que configuró para su default perfil:
```
$ aws configure get region
```
Si prefiere utilizar un perfil con nombre, proporcione el nombre de su perfil a través de la opción --profile:
```
$ aws configure get region --profile your-profile-name
```

A continuación, configurará el AWS entorno de su pila de CDK modificando la HelloCdkStack instancia en el archivo de su aplicación. Para este tutorial, codificará la información de su AWS entorno. Recomendamos este procedimiento para los entornos de producción. Para obtener información sobre otras formas de configurar entornos, consulte Configurar entornos para usarlos con la AWS CDK.

Para configurar el entorno de su pila de CDK

En el archivo de la aplicación, utilice la propiedad env del constructo Stack para configurar el entorno. A continuación, se muestra un ejemplo:

TypeScript

Se encuentra en bin/hello-cdk.ts:


#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import { HelloCdkStack } from '../lib/hello-cdk-stack';

const app = new cdk.App();
new HelloCdkStack(app, 'HelloCdkStack', {
  env: { account: '123456789012', region: 'us-east-1' },
});

JavaScript

Se encuentra en bin/hello-cdk.js:


#!/usr/bin/env node

const cdk = require('aws-cdk-lib');
const { HelloCdkStack } = require('../lib/hello-cdk-stack');

const app = new cdk.App();
new HelloCdkStack(app, 'HelloCdkStack', {
  env: { account: '123456789012', region: 'us-east-1' },
});

Python

Se encuentra en app.py:


#!/usr/bin/env python3
import os

import aws_cdk as cdk

from hello_cdk.hello_cdk_stack import HelloCdkStack

app = cdk.App()
HelloCdkStack(app, "HelloCdkStack",
  env=cdk.Environment(account='123456789012', region='us-east-1'),
  )

app.synth()

Java

Se encuentra en src/main/java/…/HelloCdkApp.java:


package com.myorg;

import software.amazon.awscdk.App;
import software.amazon.awscdk.Environment;
import software.amazon.awscdk.StackProps;

import java.util.Arrays;

public class HelloCdkApp {
    public static void main(final String[] args) {
        App app = new App();

        new HelloCdkStack(app, "HelloCdkStack", StackProps.builder()
                .env(Environment.builder()
                        .account("123456789012")
                        .region("us-east-1")
                        .build())

                .build());

        app.synth();
    }
}

C#

Se encuentra en src/HelloCdk/Program.cs:


using Amazon.CDK;
using System;
using System.Collections.Generic;
using System.Linq;

namespace HelloCdk
{
    sealed class Program
    {
        public static void Main(string[] args)
        {
            var app = new App();
            new HelloCdkStack(app, "HelloCdkStack", new StackProps
            {
                Env = new Amazon.CDK.Environment
                {
                    Account = "123456789012",
                    Region = "us-east-1",
                }
            });
            app.Synth();
        }
    }
}

Go

Se encuentra en hello-cdk.go:


package main

import (
  "github.com/aws/aws-cdk-go/awscdk/v2"
  "github.com/aws/constructs-go/constructs/v10"
  "github.com/aws/jsii-runtime-go"
)

// ...

func main() {
  defer jsii.Close()

  app := awscdk.NewApp(nil)

  NewHelloCdkStack(app, "HelloCdkStack", &HelloCdkStackProps{
    awscdk.StackProps{
      Env: env(),
    },
  })

  app.Synth(nil)
}

func env() *awscdk.Environment {
	return &awscdk.Environment{
		Account: jsii.String("123456789012"),
		Region:  jsii.String("us-east-1"),
	}
}

Paso 3: Inicie su entorno AWS

En este paso, arranca el AWS entorno que configuró en el paso anterior. Esto prepara el entorno para las implementaciones de CDK.

Para arrancar su entorno, ejecute lo siguiente desde la raíz de su proyecto de CDK:


$ cdk bootstrap

Al arrancar desde la raíz del proyecto de CDK, no es necesario que proporciones ninguna información adicional. La CLI de CDK obtiene información del entorno de su proyecto. En el caso de que arranque fuera de un proyecto de CDK, debe proporcionar información sobre el entorno con el comando cdk bootstrap. Para obtener más información, consulte Bootstrap your environment para usarlo con el CDK. AWS

Paso 4: cree su aplicación de CDK

En la mayoría de los entornos de programación, el código se crea o compila después de realizar cambios. Esto no es necesario con la AWS CDK, ya que la CLI de la CDK realizará este paso automáticamente. Sin embargo, puede seguir compilando de forma manual cuando quiera encontrar errores de sintaxis y de tipeo. A continuación, se muestra un ejemplo:

Paso 5: enumere las pilas de CDK de su aplicación

En este punto, debería tener una aplicación de CDK que contenga una sola pila de CDK. Para verificarlo, utilice el cdk list comando CLI de CDK para mostrar las pilas. El resultado debe mostrar una sola pila denominada HelloCdkStack:


$ cdk list
HelloCdkStack

Si no ve este resultado, compruebe que está en el directorio de trabajo correcto de su proyecto e inténtelo de nuevo. Si sigues sin ver tu pila, repite el paso 1: crea tu proyecto de CDK e inténtalo de nuevo.

Paso 6: defina la función de Lambda

En este paso, importará el aws_lambdamódulo de la biblioteca de AWS construcciones y utilizará la construcción FunctionL2.

Modifique el archivo de pila de CDK de la siguiente manera:

TypeScript

Se encuentra en lib/hello-cdk-stack.ts:


import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
// Import the Lambda module
import * as lambda from 'aws-cdk-lib/aws-lambda';

export class HelloCdkStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Define the Lambda function resource
    const myFunction = new lambda.Function(this, "HelloWorldFunction", {
      runtime: lambda.Runtime.NODEJS_20_X, // Provide any supported Node.js runtime
      handler: "index.handler",
      code: lambda.Code.fromInline(`
        exports.handler = async function(event) {
          return {
            statusCode: 200,
            body: JSON.stringify('Hello World!'),
          };
        };
      `),
    });
  }
}

JavaScript

Se encuentra en lib/hello-cdk-stack.js:


const { Stack } = require('aws-cdk-lib');
// Import the Lambda module
const lambda = require('aws-cdk-lib/aws-lambda');

class HelloCdkStack extends Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    // Define the Lambda function resource
    const myFunction = new lambda.Function(this, "HelloWorldFunction", {
      runtime: lambda.Runtime.NODEJS_20_X, // Provide any supported Node.js runtime
      handler: "index.handler",
      code: lambda.Code.fromInline(`
        exports.handler = async function(event) {
          return {
            statusCode: 200,
            body: JSON.stringify('Hello World!'),
          };
        };
      `),
    });

  }
}

module.exports = { HelloCdkStack }

Python

Se encuentra en hello_cdk/hello_cdk_stack.py:


from aws_cdk import (
  Stack,
  aws_lambda as _lambda, # Import the Lambda module
)
from constructs import Construct

class HelloCdkStack(Stack):

  def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
    super().__init__(scope, construct_id, **kwargs)

    # Define the Lambda function resource
    my_function = _lambda.Function(
      self, "HelloWorldFunction",
      runtime = _lambda.Runtime.NODEJS_20_X, # Provide any supported Node.js runtime
      handler = "index.handler",
      code = _lambda.Code.from_inline(
        """
        exports.handler = async function(event) {
          return {
            statusCode: 200,
            body: JSON.stringify('Hello World!'),
          };
        };
        """
      ),
    )

Java

Se encuentra en src/main/java/…/HelloCdkStack.java:


package com.myorg;

import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
// Import Lambda function
import software.amazon.awscdk.services.lambda.Code;
import software.amazon.awscdk.services.lambda.Function;
import software.amazon.awscdk.services.lambda.Runtime;

public class HelloCdkStack extends Stack {
  public HelloCdkStack(final Construct scope, final String id) {
    this(scope, id, null);
  }

  public HelloCdkStack(final Construct scope, final String id, final StackProps props) {
    super(scope, id, props);

    // Define the Lambda function resource
    Function myFunction = Function.Builder.create(this, "HelloWorldFunction")
      .runtime(Runtime.NODEJS_20_X) // Provide any supported Node.js runtime
      .handler("index.handler")
      .code(Code.fromInline(
        "exports.handler = async function(event) {" +
        " return {" +
        " statusCode: 200," +
        " body: JSON.stringify('Hello World!')" +
        " };" +
        "};"))
      .build();

  }
}

C#

Se encuentra en src/main/java/…/HelloCdkStack.java:


using Amazon.CDK;
using Constructs;
// Import the Lambda module
using Amazon.CDK.AWS.Lambda;

namespace HelloCdk
{
  public class HelloCdkStack : Stack
  {
    internal HelloCdkStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
    {
      // Define the Lambda function resource
      var myFunction = new Function(this, "HelloWorldFunction", new FunctionProps
      {
        Runtime = Runtime.NODEJS_20_X, // Provide any supported Node.js runtime
        Handler = "index.handler",
        Code = Code.FromInline(@"
          exports.handler = async function(event) {
            return {
              statusCode: 200,
              body: JSON.stringify('Hello World!'),
            };
          };
        "),
      });
    }
  }
}

Go

Se encuentra en hello-cdk.go:


package main

import (
  "github.com/aws/aws-cdk-go/awscdk/v2"
  "github.com/aws/constructs-go/constructs/v10"
  "github.com/aws/jsii-runtime-go"
  // Import the Lambda module
  "github.com/aws/aws-cdk-go/awscdk/v2/awslambda"
)

type HelloCdkStackProps struct {
  awscdk.StackProps
}

func NewHelloCdkStack(scope constructs.Construct, id string, props *HelloCdkStackProps) awscdk.Stack {
  var sprops awscdk.StackProps
  if props != nil {
    sprops = props.StackProps
  }
  stack := awscdk.NewStack(scope, &id, &sprops)

  // Define the Lambda function resource
  myFunction := awslambda.NewFunction(stack, jsii.String("HelloWorldFunction"), &awslambda.FunctionProps{
    Runtime: awslambda.Runtime_NODEJS_20_X(), // Provide any supported Node.js runtime
    Handler: jsii.String("index.handler"),
    Code: awslambda.Code_FromInline(jsii.String(`
      exports.handler = async function(event) {
        return {
          statusCode: 200,
          body: JSON.stringify('Hello World!'),
        };
      };
    `)),
  })

  return stack
}

// ...

Echemos un vistazo más de cerca a la Function construcción. Como todos los constructos, la clase Function utiliza tres parámetros:

alcance: define la instancia de Stack como la matriz del constructo Function. Todas las construcciones que definen AWS los recursos se crean dentro del ámbito de una pila. Puede definir constructos dentro de otros constructos, lo cual crea una jerarquía (árbol). Aquí, y en la mayoría de los casos, el alcance es this (selfen Python).
ID: el ID de construcción de Function la aplicación AWS CDK. Este ID, más un hash basado en la ubicación de la función dentro de la pila, identifica a la función de forma exclusiva durante la implementación. La AWS CDK también hace referencia a este ID cuando actualizas la construcción en tu aplicación y la vuelves a implementar para actualizar el recurso implementado. Aquí, su ID de constructo es HelloWorldFunction. Las funciones también pueden tener un nombre, especificado con la propiedad functionName. Esta es diferente al ID del constructo.
props: agrupación de valores que definen las propiedades de la función. Aquí se definen las propiedades runtime, handler y code.

Los accesorios se representan de forma diferente en los idiomas compatibles con la CDK. AWS
- En TypeScript y JavaScript, props es un único argumento y se pasa un objeto que contiene las propiedades deseadas.
- En Python, los props se pasan como argumentos de palabras clave.
- En Java, se proporciona un constructor para pasar los accesorios. Existen dos: uno para FunctionProps y otro para Function, con el fin de que pueda construir el constructo y su objeto de props en un solo paso. Este código usa este último.
- En C#, se crea una instancia de un FunctionProps objeto mediante un inicializador de objetos y se pasa como tercer parámetro.
  
  Si los accesorios de una construcción son opcionales, puedes omitir el parámetro por completo. props

Todos los constructos utilizan los mismos tres argumentos, por lo que es fácil mantenerse orientado a medida que se aprenden otros nuevos. Y como es de esperar, puede subclasificar cualquier constructo para ampliarlo según sus necesidades o si desea cambiar sus valores predeterminados.

Paso 7: implemente la URL de función de Lambda

En este paso, se utiliza el método auxiliar addFunctionUrl del constructo Function para definir la URL de una función de Lambda. Para generar el valor de esta URL en el momento de la implementación, creará una AWS CloudFormation salida utilizando la CfnOutputconstrucción.

Agregue lo siguiente a su archivo:

TypeScript

Se encuentra en lib/hello-cdk-stack.ts:


// ...

export class HelloCdkStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Define the Lambda function resource
    // ...

    // Define the Lambda function URL resource
    const myFunctionUrl = myFunction.addFunctionUrl({
      authType: lambda.FunctionUrlAuthType.NONE,
    });

    // Define a CloudFormation output for your URL
    new cdk.CfnOutput(this, "myFunctionUrlOutput", {
      value: myFunctionUrl.url,
    })

  }
}

JavaScript

Se encuentra en lib/hello-cdk-stack.js:


const { Stack, CfnOutput } = require('aws-cdk-lib');  // Import CfnOutput

class HelloCdkStack extends Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    // Define the Lambda function resource
    // ...

    // Define the Lambda function URL resource
    const myFunctionUrl = myFunction.addFunctionUrl({
      authType: lambda.FunctionUrlAuthType.NONE,
    });

    // Define a CloudFormation output for your URL
    new CfnOutput(this, "myFunctionUrlOutput", {
      value: myFunctionUrl.url,
    })

  }
}

module.exports = { HelloCdkStack }

Python

Se encuentra en hello_cdk/hello_cdk_stack.py:


from aws_cdk import (
  # ...
  CfnOutput # Import CfnOutput
)
from constructs import Construct

class HelloCdkStack(Stack):

  def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
    super().__init__(scope, construct_id, **kwargs)

    # Define the Lambda function resource
    # ...

    # Define the Lambda function URL resource
    my_function_url = my_function.add_function_url(
      auth_type = _lambda.FunctionUrlAuthType.NONE,
    )

    # Define a CloudFormation output for your URL
    CfnOutput(self, "myFunctionUrlOutput", value=my_function_url.url)

Java

Se encuentra en src/main/java/…/HelloCdkStack.java:


package com.myorg;

// ...
// Import Lambda function URL
import software.amazon.awscdk.services.lambda.FunctionUrl;
import software.amazon.awscdk.services.lambda.FunctionUrlAuthType;
import software.amazon.awscdk.services.lambda.FunctionUrlOptions;
// Import CfnOutput
import software.amazon.awscdk.CfnOutput;

public class HelloCdkStack extends Stack {
  public HelloCdkStack(final Construct scope, final String id) {
    this(scope, id, null);
  }

  public HelloCdkStack(final Construct scope, final String id, final StackProps props) {
    super(scope, id, props);

    // Define the Lambda function resource
    // ...

    // Define the Lambda function URL resource
    FunctionUrl myFunctionUrl = myFunction.addFunctionUrl(FunctionUrlOptions.builder()
      .authType(FunctionUrlAuthType.NONE)
      .build());

    // Define a CloudFormation output for your URL
    CfnOutput.Builder.create(this, "myFunctionUrlOutput")
      .value(myFunctionUrl.getUrl())
      .build();
  }
}

C#

Se encuentra en src/main/java/…/HelloCdkStack.java:


// ...

namespace HelloCdk
{
  public class HelloCdkStack : Stack
  {
    internal HelloCdkStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
    {
      // Define the Lambda function resource
      // ...

      // Define the Lambda function URL resource
      var myFunctionUrl = myFunction.AddFunctionUrl(new FunctionUrlOptions
      {
        AuthType = FunctionUrlAuthType.NONE
      });

      // Define a CloudFormation output for your URL
      new CfnOutput(this, "myFunctionUrlOutput", new CfnOutputProps
      {
        Value = myFunctionUrl.Url
      });
    }
  }
}

Go

Se encuentra en hello-cdk.go:


// ...

func NewHelloCdkStack(scope constructs.Construct, id string, props *HelloCdkStackProps) awscdk.Stack {
  var sprops awscdk.StackProps
  if props != nil {
    sprops = props.StackProps
  }
  stack := awscdk.NewStack(scope, &id, &sprops)

  // Define the Lambda function resource
  // ...

  // Define the Lambda function URL resource
  myFunctionUrl := myFunction.AddFunctionUrl(&awslambda.FunctionUrlOptions{
    AuthType: awslambda.FunctionUrlAuthType_NONE,
  })

  // Define a CloudFormation output for your URL
  awscdk.NewCfnOutput(stack, jsii.String("myFunctionUrlOutput"), &awscdk.CfnOutputProps{
    Value: myFunctionUrl.Url(),
  })

  return stack
}

// ...

aviso

Para simplificar este tutorial, la URL de función de Lambda se define sin autenticación. Cuando se implementa, se crea un punto de conexión de acceso público que se puede utilizar para invocar la función. Cuando haya terminado con este tutorial, siga el paso 12: Elimine su aplicación para eliminar estos recursos.

Paso 8: Sintetizar una plantilla CloudFormation

En este paso, se prepara para la implementación sintetizando una CloudFormation plantilla con el comando CDK CLIcdk synth. Este comando realiza una validación básica del código de CDK, ejecuta la aplicación de CDK y genera una CloudFormation plantilla a partir de la pila de CDK.

Si su aplicación contiene más de una pila, debe especificar qué pilas desea sintetizar. Como la aplicación contiene una sola pila, la CLI de CDK detecta automáticamente la pila que se va a sintetizar.

Si no sintetiza una plantilla, la CLI de CDK realizará este paso automáticamente cuando la implemente. Sin embargo, recomendamos que ejecute este paso antes de cada implementación para comprobar si hay errores de síntesis.

Antes de sintetizar una plantilla, si lo desea, puede crear su aplicación para detectar errores de sintaxis y de tipeo. Para obtener instrucciones, consulte el paso 4: Cree su aplicación CDK.

Para sintetizar una CloudFormation plantilla, ejecuta lo siguiente desde la raíz de tu proyecto:


$ cdk synth

nota

Si recibe un error como el siguiente, verifique que se encuentra en el directorio hello-cdk e inténtelo de nuevo:

--app is required either in command-line, in cdk.json or in ~/.cdk.json

Si se ejecuta correctamente, la CLI de CDK generará YAML una CloudFormation plantilla con formato stdout y guardará una plantilla JSON con formato en el cdk.out directorio de su proyecto.

A continuación, se muestra un ejemplo de salida de la plantilla: CloudFormation


Resources:
  HelloWorldFunctionServiceRole<unique-identifier>:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Statement:
          - Action: sts:AssumeRole
            Effect: Allow
            Principal:
              Service: lambda.amazonaws.com
        Version: "2012-10-17"
      ManagedPolicyArns:
        - Fn::Join:
            - ""
            - - "arn:"
              - Ref: AWS::Partition
              - :iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
    Metadata:
      aws:cdk:path: HelloCdkStack/HelloWorldFunction/ServiceRole/Resource
  HelloWorldFunction<unique-identifier>:
    Type: AWS::Lambda::Function
    Properties:
      Code:
        ZipFile: "

          \        exports.handler = async function(event) {

          \          return {

          \            statusCode: 200,

          \            body: JSON.stringify('Hello World!'),

          \          };

          \        };

          \      "
      Handler: index.handler
      Role:
        Fn::GetAtt:
          - HelloWorldFunctionServiceRole<unique-identifier>
          - Arn
      Runtime: nodejs20.x
    DependsOn:
      - HelloWorldFunctionServiceRole<unique-identifier>
    Metadata:
      aws:cdk:path: HelloCdkStack/HelloWorldFunction/Resource
  HelloWorldFunctionFunctionUrl<unique-identifier>:
    Type: AWS::Lambda::Url
    Properties:
      AuthType: NONE
      TargetFunctionArn:
        Fn::GetAtt:
          - HelloWorldFunction<unique-identifier>
          - Arn
    Metadata:
      aws:cdk:path: HelloCdkStack/HelloWorldFunction/FunctionUrl/Resource
  HelloWorldFunctioninvokefunctionurl<unique-identifier>:
    Type: AWS::Lambda::Permission
    Properties:
      Action: lambda:InvokeFunctionUrl
      FunctionName:
        Fn::GetAtt:
          - HelloWorldFunction<unique-identifier>
          - Arn
      FunctionUrlAuthType: NONE
      Principal: "*"
    Metadata:
      aws:cdk:path: HelloCdkStack/HelloWorldFunction/invoke-function-url
  CDKMetadata:
    Type: AWS::CDK::Metadata
    Properties:
      Analytics: v2:deflate64:<unique-identifier>
    Metadata:
      aws:cdk:path: HelloCdkStack/CDKMetadata/Default
    Condition: CDKMetadataAvailable
Outputs:
  myFunctionUrlOutput:
    Value:
      Fn::GetAtt:
        - HelloWorldFunctionFunctionUrl<unique-identifier>
        - FunctionUrl
Parameters:
  BootstrapVersion:
    Type: AWS::SSM::Parameter::Value<String>
    Default: /cdk-bootstrap/<unique-identifier>/version
    Description: Version of the CDK Bootstrap resources in this environment, automatically retrieved from SSM Parameter Store. [cdk:skip]
Rules:
  CheckBootstrapVersion:
    Assertions:
      - Assert:
          Fn::Not:
            - Fn::Contains:
                - - "1"
                  - "2"
                  - "3"
                  - "4"
                  - "5"
                - Ref: BootstrapVersion
        AssertDescription: CDK bootstrap stack version 6 required. Please run 'cdk bootstrap' with a recent version of the CDK CLI.

nota

Cada plantilla generada contiene un recurso AWS::CDK::Metadata de forma predeterminada. El equipo de AWS CDK utiliza estos metadatos para obtener información sobre el uso de las AWS CDK y encontrar formas de mejorarlo. Para obtener más información, incluida la forma de excluirse de los informes de versiones, consulte los informes de versiones.

Al definir una única construcción de nivel 2, la AWS CDK crea una amplia CloudFormation plantilla que contiene los recursos de Lambda, junto con los permisos y la lógica de unión necesarios para que los recursos interactúen dentro de la aplicación.

Paso 9: implemente su pila de CDK

En este paso, se utiliza el cdk deploy comando CLI de CDK para implementar la pila de CDK. Este comando recupera la CloudFormation plantilla generada y la despliega mediante ella AWS CloudFormation, lo que aprovisiona los recursos como parte de una pila. CloudFormation

Desde la raíz del proyecto, ejecute lo siguiente. Confirme los cambios, si se le solicita:


$ cdk deploy

✨  Synthesis time: 2.69s

HelloCdkStack:  start: Building <unique-identifier>:current_account-current_region
HelloCdkStack:  success: Built <unique-identifier>:current_account-current_region
HelloCdkStack:  start: Publishing <unique-identifier>:current_account-current_region
HelloCdkStack:  success: Published <unique-identifier>:current_account-current_region
This deployment will make potentially sensitive changes according to your current security approval level (--require-approval broadening).
Please confirm you intend to make the following modifications:

IAM Statement Changes
┌───┬───────────────────────────────────────┬────────┬──────────────────────────┬──────────────────────────────┬───────────┐
│   │ Resource                              │ Effect │ Action                   │ Principal                    │ Condition │
├───┼───────────────────────────────────────┼────────┼──────────────────────────┼──────────────────────────────┼───────────┤
│ + │ ${HelloWorldFunction.Arn}             │ Allow  │ lambda:InvokeFunctionUrl │ *                            │           │
├───┼───────────────────────────────────────┼────────┼──────────────────────────┼──────────────────────────────┼───────────┤
│ + │ ${HelloWorldFunction/ServiceRole.Arn} │ Allow  │ sts:AssumeRole           │ Service:lambda.amazonaws.com │           │
└───┴───────────────────────────────────────┴────────┴──────────────────────────┴──────────────────────────────┴───────────┘
IAM Policy Changes
┌───┬───────────────────────────────────┬────────────────────────────────────────────────────────────────────────────────┐
│   │ Resource                          │ Managed Policy ARN                                                             │
├───┼───────────────────────────────────┼────────────────────────────────────────────────────────────────────────────────┤
│ + │ ${HelloWorldFunction/ServiceRole} │ arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole │
└───┴───────────────────────────────────┴────────────────────────────────────────────────────────────────────────────────┘
(NOTE: There may be security-related changes not in this list. See https://github.com/aws/aws-cdk/issues/1299)

Do you wish to deploy these changes (y/n)? y

Del mismo modocdk synth, no es necesario especificar la pila de AWS CDK, ya que la aplicación contiene una sola pila.

Durante la implementación, la CLI de CDK muestra información de progreso a medida que se implementa la pila. Cuando haya terminado, podrá ir a la consola de AWS CloudFormation para ver su pila de HelloCdkStack. También puede ir a la consola de Lambda para ver el recurso HelloWorldFunction.

Cuando se complete la implementación, la CLI de CDK generará la URL de su punto final. Copie esta URL para el siguiente paso. A continuación, se muestra un ejemplo:


...
HelloCdkStack: deploying... [1/1]
HelloCdkStack: creating CloudFormation changeset...

 ✅  HelloCdkStack

✨  Deployment time: 41.65s

Outputs:
HelloCdkStack.myFunctionUrlOutput = https://<api-id>.lambda-url.<Region>.on.aws/
Stack ARN:
arn:aws:cloudformation:<Region:account-id>:stack/HelloCdkStack/<unique-identifier>

✨  Total time: 44.34s

Paso 10: Interactúe con su aplicación en AWS

En este paso, interactúa con la aplicación AWS invocando la función Lambda a través de la URL de la función. Al acceder a la URL, la función de Lambda devuelve el mensaje de Hello World!.

Para invocar la función, acceda a la URL de función a través del navegador o desde la línea de comandos. A continuación, se muestra un ejemplo:


$ curl https://<api-id>.lambda-url.<Region>.on.aws/
"Hello World!"%

Paso 11: modifique su aplicación

En este paso, modifique el mensaje que la función de Lambda devuelve cuando se invoca. Se realiza una diferencia mediante el cdk diff comando CLI de CDK para obtener una vista previa de los cambios y se implementa para actualizar la aplicación. A continuación, interactúa con la aplicación AWS para ver el nuevo mensaje.

Modifique la instancia de myFunction en su archivo de pila de CDK de la siguiente manera:

TypeScript

Se encuentra en lib/hello-cdk-stack.ts:


// ...

export class HelloCdkStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    // Modify the Lambda function resource
    const myFunction = new lambda.Function(this, "HelloWorldFunction", {
      runtime: lambda.Runtime.NODEJS_20_X, // Provide any supported Node.js runtime
      handler: "index.handler",
      code: lambda.Code.fromInline(`
        exports.handler = async function(event) {
          return {
            statusCode: 200,
            body: JSON.stringify('Hello CDK!'),
          };
        };
      `),
    });

    // ...
  }
}

JavaScript

Se encuentra en lib/hello-cdk-stack.js:


// ...

class HelloCdkStack extends Stack {
  constructor(scope, id, props) {
    super(scope, id, props);

    // Modify the Lambda function resource
    const myFunction = new lambda.Function(this, "HelloWorldFunction", {
      runtime: lambda.Runtime.NODEJS_20_X, // Provide any supported Node.js runtime
      handler: "index.handler",
      code: lambda.Code.fromInline(`
        exports.handler = async function(event) {
          return {
            statusCode: 200,
            body: JSON.stringify('Hello CDK!'),
          };
        };
      `),
    });

    // ...

  }
}

module.exports = { HelloCdkStack }

Python

Se encuentra en hello_cdk/hello_cdk_stack.py:


# ...

class HelloCdkStack(Stack):

  def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
    super().__init__(scope, construct_id, **kwargs)

    # Modify the Lambda function resource
    my_function = _lambda.Function(
      self, "HelloWorldFunction",
      runtime = _lambda.Runtime.NODEJS_20_X, # Provide any supported Node.js runtime
      handler = "index.handler",
      code = _lambda.Code.from_inline(
        """
        exports.handler = async function(event) {
          return {
            statusCode: 200,
            body: JSON.stringify('Hello CDK!'),
          };
        };
        """
      ),
    )

    # ...

Java

Se encuentra en src/main/java/…/HelloCdkStack.java:


// ...

public class HelloCdkStack extends Stack {
  public HelloCdkStack(final Construct scope, final String id) {
    this(scope, id, null);
  }

  public HelloCdkStack(final Construct scope, final String id, final StackProps props) {
    super(scope, id, props);

    // Modify the Lambda function resource
    Function myFunction = Function.Builder.create(this, "HelloWorldFunction")
      .runtime(Runtime.NODEJS_20_X) // Provide any supported Node.js runtime
      .handler("index.handler")
      .code(Code.fromInline(
        "exports.handler = async function(event) {" +
        " return {" +
        " statusCode: 200," +
        " body: JSON.stringify('Hello CDK!')" +
        " };" +
        "};"))
      .build();

    // ...
  }
}

C#


// ...

namespace HelloCdk
{
  public class HelloCdkStack : Stack
  {
    internal HelloCdkStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
    {
      // Modify the Lambda function resource
      var myFunction = new Function(this, "HelloWorldFunction", new FunctionProps
      {
        Runtime = Runtime.NODEJS_20_X, // Provide any supported Node.js runtime
        Handler = "index.handler",
        Code = Code.FromInline(@"
          exports.handler = async function(event) {
            return {
              statusCode: 200,
              body: JSON.stringify('Hello CDK!'),
            };
          };
        "),
      });

      // ...
    }
  }
}

Go


// ...

type HelloCdkStackProps struct {
  awscdk.StackProps
}

func NewHelloCdkStack(scope constructs.Construct, id string, props *HelloCdkStackProps) awscdk.Stack {
  var sprops awscdk.StackProps
  if props != nil {
    sprops = props.StackProps
  }
  stack := awscdk.NewStack(scope, &id, &sprops)

  // Modify the Lambda function resource
  myFunction := awslambda.NewFunction(stack, jsii.String("HelloWorldFunction"), &awslambda.FunctionProps{
    Runtime: awslambda.Runtime_NODEJS_20_X(), // Provide any supported Node.js runtime
    Handler: jsii.String("index.handler"),
    Code: awslambda.Code_FromInline(jsii.String(`
      exports.handler = async function(event) {
        return {
          statusCode: 200,
          body: JSON.stringify('Hello CDK!'),
        };
      };
    `)),
  })

// ...

}

Actualmente, los cambios en el código no han realizado ninguna actualización directa en el recurso de Lambda implementado. El código define el estado deseado del recurso. Para modificar el recurso implementado, utilizará la CLI de CDK para sintetizar el estado deseado en una nueva AWS CloudFormation plantilla. A continuación, implementará la nueva CloudFormation plantilla como un conjunto de cambios. Los conjuntos de cambios solo realizan cambios necesarios para alcanzar el nuevo estado deseado.

Para obtener una vista previa de los cambios, ejecute el comando cdk diff. A continuación, se muestra un ejemplo:


$ cdk diff
Stack HelloCdkStack
Hold on while we create a read-only change set to get a diff with accurate replacement information (use --no-change-set to use a less accurate but faster template-only diff)
Resources
[~] AWS::Lambda::Function HelloWorldFunction HelloWorldFunction<unique-identifier>
 └─ [~] Code
     └─ [~] .ZipFile:
         ├─ [-]
                exports.handler = async function(event) {
                    return {
                      statusCode: 200,
                      body: JSON.stringify('Hello World!'),
                    };
                };

         └─ [+]
                exports.handler = async function(event) {
                    return {
                      statusCode: 200,
                      body: JSON.stringify('Hello CDK!'),
                    };
                };


✨  Number of stacks with differences: 1

Para crear esta diferencia, la CLI del CDK consulta su AWS cuenta para obtener la AWS CloudFormation plantilla más reciente de la HelloCdkStack pila. A continuación, compare la plantilla más reciente con la plantilla que acaba de sintetizar en su aplicación.

Para implementar los cambios, ejecute el comando cdk deploy. A continuación, se muestra un ejemplo:


$ cdk deploy

✨  Synthesis time: 2.12s

HelloCdkStack:  start: Building <unique-identifier>:current_account-current_region
HelloCdkStack:  success: Built <unique-identifier>:current_account-current_region
HelloCdkStack:  start: Publishing <unique-identifier>:current_account-current_region
HelloCdkStack:  success: Published <unique-identifier>:current_account-current_region
HelloCdkStack: deploying... [1/1]
HelloCdkStack: creating CloudFormation changeset...

 ✅  HelloCdkStack

✨  Deployment time: 26.96s

Outputs:
HelloCdkStack.myFunctionUrlOutput = https://<unique-identifier>.lambda-url.<Region>.on.aws/
Stack ARN:
arn:aws:cloudformation:<Region:account-id>:stack/HelloCdkStack/<unique-identifier>

✨  Total time: 29.07s

Para interactuar con la aplicación, repita el paso 10: Activa la interacción con la AWS aplicación. A continuación, se muestra un ejemplo:


$ curl https://<api-id>.lambda-url.<Region>.on.aws/
"Hello CDK!"%

Paso 12: elimine la aplicación

En este paso, utiliza el cdk destroy comando CDK CLI para eliminar la aplicación. Este comando elimina la CloudFormation pila asociada a la pila de CDK, que incluye los recursos que ha creado.

Para eliminar la aplicación, ejecute el comando cdk destroy y confirme la solicitud para eliminar la aplicación. A continuación, se muestra un ejemplo:


$ cdk destroy
Are you sure you want to delete: HelloCdkStack (y/n)? y
HelloCdkStack: destroying... [1/1]

 ✅  HelloCdkStack: destroyed

Pasos a seguir a continuación

¡Enhorabuena! Ha completado este tutorial y ha utilizado la AWS CDK para crear, modificar y eliminar recursos en la nube correctamente. AWS Ahora está listo para empezar a usar la AWS CDK.

Para obtener más información sobre el uso del AWS CDK en su lenguaje de programación preferido, consulte Trabajar con la biblioteca del AWS CDK.

Para obtener más ayuda, consulte los siguientes recursos:

Para realizar un recorrido más detallado sobre un proyecto más complejo, pruebe CDK Workshop.
Consulte la referencia de la API para empezar a explorar las estructuras de CDK disponibles para sus servicios favoritos. AWS
Visite Construct Hub para descubrir construcciones creadas por AWS y otras personas.
Explore algunos ejemplos de uso del AWS CDK.

El AWS CDK es un proyecto de código abierto. Para contribuir, consulte Contribución al AWS Cloud Development Kit (AWS CDK).

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Introducción

Trabajar con la biblioteca de CDK

Tutorial: Crea tu primera aplicación de AWS CDK

Requisitos previos

Acerca de este tutorial

Paso 1: cree su proyecto de CDK

importante

Paso 2: Configure su entorno AWS

Paso 3: Inicie su entorno AWS

Paso 4: cree su aplicación de CDK

Paso 5: enumere las pilas de CDK de su aplicación

Paso 6: defina la función de Lambda

Paso 7: implemente la URL de función de Lambda

aviso

Paso 8: Sintetizar una plantilla CloudFormation

nota

nota

Paso 9: implemente su pila de CDK

Paso 10: Interactúe con su aplicación en AWS

Paso 11: modifique su aplicación

Paso 12: elimine la aplicación

Pasos a seguir a continuación