CDK AWS v2 개발자 안내서입니다. 이전 CDK v1은 2022년 6월 1일에 유지 관리에 들어갔으며 2023년 6월 1일에 지원이 종료되었습니다.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

AWS CDK Toolkit Library 클라우드 어셈블리 소스 관리

AWS CDK Toolkit Library를 사용하여 클라우드 어셈블리 소스를 구성하고 CDK 애플리케이션을 배포하는 방법을 사용자 지정합니다. 이 가이드에서는 배포 요구 사항 및 워크플로 요구 사항에 맞게 클라우드 어셈블리 소스를 구성하는 방법을 보여줍니다.

CDK Toolkit을 사용하기 전에 클라우드 어셈블리 소스를 지정합니다. 클라우드 어셈블리 소스는 CDK 앱에서 클라우드 어셈블리를 생성하는 지침을 제공합니다. 결과 클라우드 어셈블리에는 CDK Toolkit이 배포하는 합성된 인프라 아티팩트가 포함되어 있습니다 AWS.

CDK Toolkit Library는 클라우드 어셈블리 소스를 구성하는 몇 가지 접근 방식을 제공하며, 각각 다양한 시나리오 및 워크플로에 적합합니다.

클라우드 어셈블리 소스 선택

클라우드 어셈블리 소스 구성

기존 CDK 앱에서

fromCdkApp 메서드를 사용하여 지원되는 언어로 작성된 CDK 앱을 사용할 수 있습니다. 이 접근 방식은 기존 CDK 애플리케이션이 있고 프로그래밍 방식으로 배포하려는 경우에 적합합니다.

import { App } from 'aws-cdk-lib';
import { Toolkit } from '@aws-cdk/toolkit-lib';

// Create a toolkit instance
const toolkit = new Toolkit();

// TypeScript app
const cloudAssemblySource = await toolkit.fromCdkApp("ts-node app.ts");

// Deploy a specific stack from the assembly
await toolkit.deploy(cloudAssemblySource, {
    stacks: ['MyStack']
});

// Other language examples:
// JavaScript app
// const cloudAssemblySource = await toolkit.fromCdkApp("node app.js");

// Python app
// const cloudAssemblySource = await toolkit.fromCdkApp("python app.py");

// Java app
// const cloudAssemblySource = await toolkit.fromCdkApp("mvn -e -q exec:java -Dexec.mainClass=com.mycompany.app.App");

인라인 어셈블리 빌더에서

어셈블리 빌더 함수를 사용하여 코드에서 직접 CDK 앱을 생성합니다. 이 접근 방식은 인프라를 인라인으로 정의하려는 간단한 배포 또는 테스트 시나리오에 유용합니다.

import { App, Stack, RemovalPolicy, StackProps } from 'aws-cdk-lib';
import { Bucket } from 'aws-cdk-lib/aws-s3';
import { Toolkit } from '@aws-cdk/toolkit-lib';
import { Construct } from 'constructs';

// Create a cloud assembly source from an inline CDK app
const cloudAssemblySource = await toolkit.fromAssemblyBuilder(async () => {
    const app = new App();

    // Define a simple stack with an S3 bucket
    class MyStack extends Stack {
        constructor(scope: Construct, id: string, props?: StackProps) {
            super(scope, id, props);

            // Create an S3 bucket
            new Bucket(this, 'MyBucket', {
                versioned: true,
                removalPolicy: RemovalPolicy.DESTROY,
                autoDeleteObjects: true
            });
        }
    }

    // Instantiate the stack
    new MyStack(app, 'MyInlineStack');

    return app.synth();
});

// Deploy using the cloud assembly source
await toolkit.deploy(cloudAssemblySource, {
    stacks: ['MyInlineStack']
});

기존 어셈블리 디렉터리에서

이미 합성된 클라우드 어셈블리가 있는 경우 직접 사용할 수 있습니다. 이는 이미를 실행cdk synth했거나 CI/CD 파이프라인에서 생성된 클라우드 어셈블리로 작업할 때 유용합니다.

import { Toolkit } from '@aws-cdk/toolkit-lib';

// Create a toolkit instance
const toolkit = new Toolkit();

// Use an existing cloud assembly directory
const cloudAssemblySource = await toolkit.fromAssemblyDirectory("cdk.out");

// Deploy using the cloud assembly source
await toolkit.deploy(cloudAssemblySource, {
    stacks: ['MyStack']
});

캐시된 클라우드 어셈블리 작업

클라우드 어셈블리로 작업할 때는 두 가지 옵션이 있습니다.

다음과 같은 경우 캐시된 어셈블리를 사용합니다.

다음과 같은 경우 클라우드 어셈블리 소스를 직접 사용합니다.

클라우드 어셈블리를 생성, 캐시 및 재사용하는 방법

클라우드 어셈블리 소스를 생성한 후 클라우드 어셈블리를 합성하여 생성할 수 있습니다. 클라우드 어셈블리에는 배포에 필요한 AWS CloudFormation 템플릿과 자산이 포함되어 있습니다.

클라우드 어셈블리를 한 번 생성하고 여러 Toolkit 작업에 재사용하는 것이 좋습니다. 이 캐싱 접근 방식은 각 작업에 대한 어셈블리를 재생성하는 것보다 더 효율적입니다. 소스가 자주 변경되는 경우에만 어셈블리를 다시 생성하는 것이 좋습니다.

캐시된 클라우드 어셈블리를 생성하는 방법은 다음과 같습니다.

// Generate a cloud assembly from your source
const cloudAssembly = await toolkit.synth(cloudAssemblySource);

그런 다음 캐시된 클라우드 어셈블리에서 , list() deploy()및와 같은 다양한 도구 키트 작업을 수행할 수 있습니다diff(). 클라우드 어셈블리를 캐싱하면 합성이 한 번만 수행되므로 후속 Toolkit 작업이 더 빠르게 수행됩니다. 자세한 내용은 synth - Generate cloud assembly를 참조하세요.

클라우드 어셈블리 리소스 폐기

클라우드 어셈블리를 사용하여 임시 리소스를 정리한 후에는 항상 클라우드 어셈블리를 폐기하십시오. 특히 여러 작업을 수행할 때 적절한 정리를 보장하려면 try/finally 블록을 사용하는 것이 좋습니다.

// Generate a cloud assembly
const cloudAssembly = await toolkit.synth(cloudAssemblySource);

try {
    // Use the cloud assembly for multiple operations
    await toolkit.list(cloudAssembly);
    await toolkit.deploy(cloudAssembly);
} finally {
    // Always dispose when done
    await cloudAssembly.dispose();
}

다음은 캐시된 클라우드 어셈블리를 생성하고 폐기하는 방법을 보여주는 예제입니다.

import { Toolkit } from '@aws-cdk/toolkit-lib';

const toolkit = new Toolkit();

// Create cloud assembly source from a CDK app
const cloudAssemblySource = await toolkit.fromCdkApp("ts-node app.ts");

// Create cloud assembly from source
const cloudAssembly = await toolkit.synth(cloudAssemblySource);

try {
    // List stacks in the assembly
    await toolkit.list(cloudAssembly);

    // Check for changes
    await toolkit.diff(cloudAssembly);

    // Deploy if needed
    await toolkit.deploy(cloudAssembly);
} finally {
    // Always dispose when done
    await cloudAssembly.dispose();
}

클라우드 어셈블리 수명 이해

를 사용하여 캐시된 클라우드 어셈블리를 생성할 때 읽기 가능한 CloudAssembly와의 역할을 하는 특수 유형을 얻게 synth()됩니다CloudAssemblySource. 이 캐시된 어셈블리(예: 목록 또는 배포 작업)에서 생성된 모든 클라우드 어셈블리는 상위의 수명과 연결됩니다.

클라우드 어셈블리 소스 모범 사례

클라우드 어셈블리 소스로 작업할 때는 다음 모범 사례를 고려하세요.

다음 예제에서는 여러 작업에 클라우드 어셈블리를 재사용하면서 오류 처리 및 적절한 정리를 구현하는 방법을 보여줍니다.

import { Toolkit } from '@aws-cdk/toolkit-lib';

// Example with error handling and proper cleanup
async function deployInfrastructure(): Promise<void> {
    let cloudAssembly;

    try {
        // Generate a cloud assembly once
        cloudAssembly = await toolkit.synth(cloudAssemblySource);

        // Reuse the same cloud assembly for multiple operations
        await toolkit.list(cloudAssembly);    // Uses existing assembly
        await toolkit.deploy(cloudAssembly);   // Uses existing assembly
        await toolkit.diff(cloudAssembly);     // Uses existing assembly
    } catch (error) {
        console.error("Failed to deploy:", error);
    } finally {
        // Always dispose when done
        if (cloudAssembly) {
            await cloudAssembly.dispose();
        }
    }
}

// Call the async function
deployInfrastructure().catch(error => {
    console.error("Deployment failed:", error);
    process.exit(1);
});

잠재적 문제 해결

다음 단계에 따라 클라우드 어셈블리 소스의 잠재적 문제를 해결합니다.

도구 키트 작업 중에 오류가 발생하면 오류 처리를 단순하게 유지하고 사용자에게 명확한 오류 메시지를 제공하는 데 집중하세요. 클라우드 어셈블리를 사용한 후에는 항상 폐기하십시오. 다음은 적절한 정리를 통한 기본 오류 처리를 보여주는 예입니다.

import { Toolkit } from '@aws-cdk/toolkit-lib';

// Example with simple error handling
try {
    // Create the cloud assembly source
    const cloudAssemblySource = await toolkit.fromCdkApp("ts-node app.ts");

    // Synthesize the cloud assembly
    const cloudAssembly = await toolkit.synth(cloudAssemblySource);

    // Use the cloud assembly
    await toolkit.list(cloudAssembly);
} catch (error) {
    // Display the error message
    console.error("Operation failed:", error.message);
} finally {
    // Clean up resources
    await cloudAssembly.dispose();
}