Esta es la guía para desarrolladores de AWS CDK v2. La primera versión del CDK pasó a la etapa de mantenimiento el 1.° de junio de 2022 y no cuenta con soporte desde el 1.° de junio de 2023.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Trabajando con el AWS CDK en Go

Goes un lenguaje de cliente totalmente compatible con el AWS Cloud Development Kit (AWS CDK) y se considera estable. Para trabajar con el AWS CDK en Go se utilizan herramientas conocidas. La versión Go del AWS CDK incluso usa identificadores tipo Go.

A diferencia de otros lenguajes, el CDK no Go es un lenguaje de programación tradicional orientado a objetos. Goutiliza la composición, mientras que otros lenguajes suelen aprovechar la herencia. Hemos intentado emplear Go enfoques idiomáticos en la medida de lo posible, pero hay aspectos en los que la CDK puede diferir.

Este tema proporciona orientación para trabajar con la AWS CDK en. Go Consulta la entrada del blog sobre el anuncio para ver un tutorial de un sencillo proyecto de Go para el AWS CDK.

Introducción a Go

Para trabajar con el AWS CDK, debe tener una AWS cuenta y credenciales, y tener instalados Node.js y el kit de herramientas del AWS CDK. Consulte Primeros pasos con el CDK. AWS

Los Go enlaces del AWS CDK utilizan la cadena de herramientas Go estándar, versión 1.18 o posterior. Puede utilizar el editor de su elección.

Creación de un proyecto

Para crear un nuevo proyecto de AWS CDK, se invoca en un directorio vacío. cdk init Utilice la opción --language y especifique go:

mkdir my-project
cd my-project
cdk init app --language go

cdk init utiliza el nombre de la carpeta del proyecto para asignar un nombre a varios elementos del proyecto, incluidas las clases, las subcarpetas y los archivos. Los guiones del nombre de la carpeta se convierten en guiones bajos. Sin embargo, de lo contrario, el nombre debería tener la forma de un Go identificador; por ejemplo, no debería empezar por un número ni contener espacios.

El proyecto resultante incluye una referencia al Go módulo principal de AWS CDKgithub.com/aws/aws-cdk-go/awscdk/v2, engo.mod. Ejecute go get para instalar este y otros módulos necesarios.

Gestión de los módulos de AWS Construct Library

En la mayoría de la documentación y los ejemplos de AWS CDK, la palabra «módulo» suele usarse para referirse a los módulos de AWS Construct Library, uno o más por AWS servicio, lo que difiere del Go uso idiomático del término. La biblioteca Construct de CDK se proporciona en un Go módulo con los módulos individuales de la biblioteca Construct, que admiten los distintos AWS servicios y que se proporcionan como Go paquetes dentro de ese módulo.

La compatibilidad con AWS Construct Library de algunos servicios se encuentra en más de un módulo (Gopaquete) de Construct Library. Por ejemplo, Amazon Route 53 tiene tres módulos de la Biblioteca de constructos, además del paquete principal de awsroute53, denominados awsroute53patterns awsroute53resolver y awsroute53targets.

El paquete principal del AWS CDK, que necesitarás en la mayoría de las aplicaciones de AWS CDK, se importa en Go código como. github.com/aws/aws-cdk-go/awscdk/v2 Los paquetes de los distintos servicios de la biblioteca AWS Construct se encuentran en. github.com/aws/aws-cdk-go/awscdk/v2 Por ejemplo, el espacio de nombres del módulo Amazon S3 es. github.com/aws/aws-cdk-go/awscdk/v2/awss3

import (
        "github.com/aws/aws-cdk-go/awscdk/v2/awss3"
        // ...
)

Una vez que haya importado los módulos (Gopaquetes) de Construct Library para los servicios que desee usar en su aplicación, podrá acceder a las construcciones de ese módulo utilizando, por ejemplo,. awss3.Bucket

Administración de dependencias en Go

EnGo, las versiones de dependencias se definen en. go.mod El valor predeterminado go.mod es similar al que se muestra aquí.

module my-package

go 1.16

require (
  github.com/aws/aws-cdk-go/awscdk/v2 v2.16.0
  github.com/aws/constructs-go/constructs/v10 v10.0.5
  github.com/aws/jsii-runtime-go v1.29.0
)

Los nombres de los paquetes (módulos, en el lenguaje de Go) se especifican mediante una URL con el número de versión requerido adjunto. GoSu sistema de módulos no admite rangos de versiones.

Ejecute el comando go get para instalar todos los módulos necesarios y actualizarlos en go.mod. Para ver una lista de las actualizaciones disponibles para sus dependencias, ejecute go list -m -u all.

AWS Los modismos de CDK están en Go

Nombres de campos y métodos

Los nombres de campos y métodos utilizan camel casey (likeThis) en TypeScript, el idioma de origen del CDK. EnGo, estos siguen las Go convenciones, al igual que Pascal-cased (). LikeThis

Limpieza

En su método main, use defer jsii.Close() para asegurarse de que la aplicación CDK se limpie sola.

Valores faltantes y conversión de punteros

EnGo, los valores que faltan en los objetos AWS CDK, como los paquetes de propiedades, se representan mediante. nil Gono tiene tipos anulables; el único tipo que puede contener nil es un puntero. Por lo tanto, para permitir que los valores sean opcionales, todas las propiedades, argumentos y valores de retorno de CDK son punteros, incluso en el caso de los tipos primitivos. Esto se aplica tanto a los valores obligatorios como opcionales. Si un valor obligatorio se vuelve opcional, no será necesario cambiar el tipo de valor.

Al pasar valores o expresiones literales, utilice las siguientes funciones auxiliares para crear punteros a los valores.

Para mantener la coherencia, le recomendamos que utilice los punteros de forma similar cuando defina sus propias construcciones, aunque pueda parecer más conveniente, por ejemplo, recibir la construcción como una cadena en lugar de id como un puntero a una cadena.

Cuando utilices valores AWS CDK opcionales, incluidos valores primitivos y tipos complejos, deberías probar los punteros de forma explícita para asegurarte de que no lo están nil antes de hacer cualquier cosa con ellos. Go no tiene “azúcar sintáctico” que ayude a gestionar los valores vacíos o faltantes, como ocurre en otros lenguajes. Sin embargo, se garantiza la existencia de los valores obligatorios en las agrupaciones de propiedades y estructuras similares (de lo contrario, los constructos no funcionan), por lo que no es necesario verificar nil en estos valores.

Constructos y accesorios

Las construcciones, que representan uno o más AWS recursos y sus atributos asociados, se representan en Go forma de interfaces. Por ejemplo, awss3.Bucket es una interfaz. Cada constructo tiene una función de fábrica, como awss3.NewBucket, para devolver una estructura que implementa la interfaz correspondiente.

Todas las funciones de fábrica utilizan tres argumentos: el argumento scope en el que se define la construcción (su elemento principal en el árbol de construcciones)id, un y props un conjunto de key/value pares que la construcción utiliza para configurar los recursos que crea. El patrón del «conjunto de atributos» también se utiliza en otras partes de la AWS CDK.

EnGo, los accesorios se representan mediante un tipo de estructura específico para cada construcción. Por ejemplo, awss3.Bucket toma un argumento de tipo accesorio awss3.BucketProps. Usa una estructura literal para escribir argumentos de utilería.

var bucket = awss3.NewBucket(stack, jsii.String("amzn-s3-demo-bucket"), &awss3.BucketProps{
    Versioned: jsii.Bool(true),
})

Estructuras genéricas

En algunos lugares, el AWS CDK usa JavaScript matrices u objetos sin tipo como entrada a un método. (Consulte, por ejemplo, el método de.) AWS CodeBuild BuildSpec.fromObject() En Go, estos objetos se representan como sectores y una interfaz vacía.

El CDK proporciona diversas funciones auxiliares, como jsii.Strings, para crear segmentos que contienen tipos primitivos.

jsii.Strings("One", "Two", "Three")

Trabajando con cualquier rebanada

Algunas construcciones esperan propiedades que sean una lista de varios tipos (en los tipos de unión TypeScript). EnGo, son como una porción de any (*[]any). anyEsto garantiza que el compilador permita la asignación de diferentes tipos allí. Consulte la documentación AWS CDK Go package para averiguar cuáles son los tipos permitidos.

Para trabajar con estas propiedades, utilice las funciones auxiliares que proporciona jsii para crear sectores de cualquier tipo:

Por ejemplo:

func Arns() *[]*string {
a := "arn:aws:s3:::bucket1"
b := "arn:aws:s3:::bucket2"
return &[]*string{&a, &b}
}

awsiam.NewCfnUser(stack, jsii.String("User"), &awsiam.CfnUserProps{
	ManagedPolicyArns: jsii.AnySlice(Arns())
  // or
	ManagedPolicyArns: jsii.AnyStrings("arn:aws:s3:::bucket1", "arn:aws:s3:::bucket2")
  // or
  ManagedPolicyArns: &[]interface{}{
    jsii.String("arn:aws:s3:::bucket1"),
    jsii.String("arn:aws:s3:::bucket2"),
  }
})

Este enfoque garantiza que la CDK interprete correctamente los segmentos, lo que evita errores de deserialización al implementar o sintetizar las pilas.

Desarrollo de constructos personalizados

EnGo, por lo general, es más sencillo escribir una nueva construcción que extender una existente. En primer lugar, defina un nuevo tipo de estructura, incrustando de forma anónima uno o más tipos existentes en caso de que se desee una semántica similar a la de una extensión. Escribe métodos para cualquier funcionalidad nueva que vayas a añadir y los campos necesarios para contener los datos que necesitan. Defina una interfaz de accesorios si su constructo la necesita. Por último, escriba una función de fábrica NewMyConstruct() para devolver una instancia de su constructo.

Si simplemente va a cambiar algunos valores por defecto de un componente fijo existente o a añadir un comportamiento sencillo en la instanciación, no necesitará toda esa combinación. En su lugar, escribe una función de fábrica que llame a la función de fábrica de la construcción que estás «extendiendo». En otros lenguajes de CDK, por ejemplo, puedes crear una TypedBucket construcción que aplique el tipo de objetos de un bucket de Amazon S3 anulando el s3.Bucket tipo y, en el inicializador del nuevo tipo, añadiendo una política de bucket que permita añadir al bucket únicamente extensiones de nombre de archivo especificadas. EnGo, es más fácil escribir simplemente una NewTypedBucket que devuelva una s3.Bucket (uso instanciados3.NewBucket) a la que se haya agregado una política de bucket adecuada. No es necesario ningún tipo de constructo nuevo porque la funcionalidad ya está disponible en el constructo de bucket estándar; el nuevo simplemente proporciona una forma más sencilla de configurarlo.

Construir, sintetizar e implementar

El AWS CDK compila automáticamente la aplicación antes de ejecutarla. Sin embargo, puede resultar útil compilar la aplicación manualmente para comprobar si hay errores y realizar pruebas. Puede hacerlo ejecutándola go build en una línea de comandos desde el directorio raíz de su proyecto.

Ejecute cualquier prueba que haya escrito ejecutándola go test en una línea de comandos.

Solución de problemas

Si se produce un error de compilación como el siguiente, significa que los segmentos de cadena se han pasado directamente a una propiedad esperando un fragmento de alguno de ellos.

Cannot use 'jsii.Strings("arn:aws:s3:::bucket1", "arn:aws:s3:::bucket2")' (type *[]*string) as the type *[]interface{}

Para resolver este error, sustitúyalo porjsii.Strings(). jsii.AnyStrings() Consulte esto CDK GitHub issue para obtener más contexto y soluciones adicionales.