AWS CDK projets

Fichier qui indique les fichiers et les dossiers à ignorer lors de la publication d'un package sur npm registre. Ce fichier est similaire à.gitignore, mais il est spécifique à npm colis.

Le fichier d'application définit votre application CDK. Les projets CDK peuvent contenir un ou plusieurs fichiers d'application. Les fichiers de candidature sont stockés dans le bin dossier.

Voici un exemple de fichier d'application de base qui définit une application CDK :

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

const app = new cdk.App();
new MyCdkTsProjectStack(app, 'MyCdkTsProjectStack');

Fichier de configuration pour Jest. Jestest populaire JavaScript cadre de test.

Le fichier de pile définit votre pile de CDK. Au sein de votre pile, vous définissez les AWS ressources et les propriétés à l'aide de constructions.

Voici un exemple de fichier de pile de base qui définit une pile CDK :

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

export class MyCdkTsProjectStack extends cdk.Stack {
 constructor(scope: Construct, id: string, props?: cdk.StackProps) {
  super(scope, id, props);
    
  // code that defines your resources and properties go here
 }
}

Dossier commun dans Node.js projets qui contiennent des dépendances pour votre projet.

Fichier de métadonnées qui fonctionne avec le package.json fichier pour gérer les versions des dépendances.

Fichier de métadonnées couramment utilisé dans Node.js projets. Ce fichier contient des informations sur votre projet CDK, telles que le nom du projet, les définitions de script, les dépendances et d'autres informations au niveau du projet d'importation.

Un dossier de test est créé pour organiser les tests de votre projet CDK. Un exemple de fichier de test est également créé.

Vous pouvez écrire des tests dans TypeScript et utilisez Jest pour compiler votre TypeScript code avant d'exécuter les tests.

Fichier de configuration utilisé dans TypeScript projets qui spécifient les options du compilateur et les paramètres du projet.

Fichier qui indique les fichiers et les dossiers à ignorer lors de la publication d'un package sur npm registre. Ce fichier est similaire à.gitignore, mais il est spécifique à npm colis.

Le fichier d'application définit votre application CDK. Les projets CDK peuvent contenir un ou plusieurs fichiers d'application. Les fichiers de candidature sont stockés dans le bin dossier.

Voici un exemple de fichier d'application de base qui définit une application CDK :

#!/usr/bin/env node

const cdk = require('aws-cdk-lib');
const { MyCdkJsProjectStack } = require('../lib/my-cdk-js-project-stack');

const app = new cdk.App();
new MyCdkJsProjectStack(app, 'MyCdkJsProjectStack');

Fichier de configuration pour Jest. Jestest populaire JavaScript cadre de test.

Le fichier de pile définit votre pile de CDK. Au sein de votre pile, vous définissez les AWS ressources et les propriétés à l'aide de constructions.

Voici un exemple de fichier de pile de base qui définit une pile CDK :

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

class MyCdkJsProjectStack extends Stack {
 constructor(scope, id, props) {
  super(scope, id, props);
    
  // code that defines your resources and properties go here
 }
}

module.exports = { MyCdkJsProjectStack }

Dossier commun dans Node.js projets qui contiennent des dépendances pour votre projet.

Fichier de métadonnées qui fonctionne avec le package.json fichier pour gérer les versions des dépendances.

Fichier de métadonnées couramment utilisé dans Node.js projets. Ce fichier contient des informations sur votre projet CDK, telles que le nom du projet, les définitions de script, les dépendances et d'autres informations au niveau du projet d'importation.

Un dossier de test est créé pour organiser les tests de votre projet CDK. Un exemple de fichier de test est également créé.

Vous pouvez écrire des tests dans JavaScript et utilisez Jest pour compiler votre JavaScript code avant d'exécuter les tests.

Le CDK CLI crée automatiquement un environnement virtuel pour votre projet. Le .venv répertoire fait référence à cet environnement virtuel.

Le fichier d'application définit votre application CDK. Les projets CDK peuvent contenir un ou plusieurs fichiers d'application.

Voici un exemple de fichier d'application de base qui définit une application CDK :

#!/usr/bin/env python3
import os

import aws_cdk as cdk

from my_cdk_py_project.my_cdk_py_project_stack import MyCdkPyProjectStack

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

app.synth()

Répertoire contenant vos fichiers de pile. Le CDK CLI crée ce qui suit ici :

Voici un exemple de fichier de pile :

from aws_cdk import Stack

from constructs import Construct

class MyCdkPyProjectStack(Stack):
 def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
  super().__init__(scope, construct_id, **kwargs)
        
  # code that defines your resources and properties go here

Fichier similaire àrequirements.txt, mais utilisé pour gérer les dépendances spécifiquement à des fins de développement plutôt que de production.

Fichier commun utilisé dans Python projets pour spécifier et gérer les dépendances entre les projets.

Fichier Batch pour Windows qui est utilisé pour configurer le Python environnement virtuel.

Répertoire contenant les tests pour votre projet CDK.

Voici un exemple de test unitaire :

import aws_cdk as core
import aws_cdk.assertions as assertions

from my_cdk_py_project.my_cdk_py_project_stack import MyCdkPyProjectStack

def test_sqs_queue_created():
 app = core.App()
 stack = MyCdkPyProjectStack(app, "my-cdk-py-project")
 template = assertions.Template.from_stack(stack)

 template.has_resource_properties("AWS::SQS::Queue", {
  "VisibilityTimeout": 300
 })

Fichier contenant les informations de configuration et les métadonnées relatives à votre projet CDK. Ce fichier fait partie de Maven.

Répertoire contenant votre application et vos fichiers de pile.

Voici un exemple de fichier de candidature :

package com.myorg;

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

import java.util.Arrays;

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

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

  app.synth();
 }
}

Voici un exemple de fichier de pile :

package com.myorg;

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

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

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

  // code that defines your resources and properties go here
 }
}

Répertoire contenant vos fichiers de test. Voici un exemple :

package com.myorg;

import software.amazon.awscdk.App;
import software.amazon.awscdk.assertions.Template;
import java.io.IOException;

import java.util.HashMap;

import org.junit.jupiter.api.Test;

public class MyCdkJavaProjectTest {

 @Test
 public void testStack() throws IOException {
  App app = new App();
  MyCdkJavaProjectStack stack = new MyCdkJavaProjectStack(app, "test");

  Template template = Template.fromStack(stack);

  template.hasResourceProperties("AWS::SQS::Queue", new HashMap<String, Number>() {{
   put("VisibilityTimeout", 300);
  }});
 }
}

Répertoire contenant votre application et vos fichiers de pile.

Voici un exemple de fichier de candidature :

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

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

Voici un exemple de fichier de pile :

using Amazon.CDK;
using Constructs;

namespace MyCdkCsharpProject
{
 public class MyCdkCsharpProjectStack : Stack
 {
  internal MyCdkCsharpProjectStack(Construct scope, string id, IStackProps props = null) : base(scope, id, props)
  {
   // code that defines your resources and properties go here
  }
 }
}

Ce répertoire contient également les éléments suivants :

Microsoft Visual Studio Solution File utilisé pour organiser et gérer des projets connexes.

Fichier contenant des informations sur le module et utilisé pour gérer les dépendances et le versionnement de votre Go projet.

Fichier qui définit votre application CDK et ses piles.

Voici un exemple :

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 MyCdkGoProjectStackProps struct {
 awscdk.StackProps
}

func NewMyCdkGoProjectStack(scope constructs.Construct, id string, props *MyCdkGoProjectStackProps) awscdk.Stack {
 var sprops awscdk.StackProps
 if props != nil {
  sprops = props.StackProps
 }
 stack := awscdk.NewStack(scope, &id, &sprops)
 // The code that defines your resources and properties go here

  return stack
}

func main() {
 defer jsii.Close()
 app := awscdk.NewApp(nil)
 NewMyCdkGoProjectStack(app, "MyCdkGoProjectStack", &MyCdkGoProjectStackProps{
  awscdk.StackProps{
   Env: env(),
  },
 })
 app.Synth(nil)
}

func env() *awscdk.Environment {

 return nil
}

Fichier qui définit un exemple de test.

Voici un exemple :

package main

import (
 "testing"

 "github.com/aws/aws-cdk-go/awscdk/v2"
 "github.com/aws/aws-cdk-go/awscdk/v2/assertions"
 "github.com/aws/jsii-runtime-go"
)

func TestMyCdkGoProjectStack(t *testing.T) {
    
 // GIVEN
 app := awscdk.NewApp(nil)
    
 // WHEN
 stack := NewMyCdkGoProjectStack(app, "MyStack", nil)
    
 // THEN
 template := assertions.Template_FromStack(stack, nil)
 template.HasResourceProperties(jsii.String("AWS::SQS::Queue"), map[string]interface{}{
  "VisibilityTimeout": 300,
 })
}