Bangun Stack AWS CDK Pertama Anda: Tutorial Ramah Pemula

Bekerja dengan Construct CDK

App AWS CDK bergantung pada construct sebagai elemen struktural esensialnya. Kode infrastruktur Anda akan menjadi lebih modular, mudah dirawat, dan mudah dibaca saat Anda menguasai construct, baik menggunakan construct layanan bawaan maupun membuat pola dapat digunakan ulang milik Anda.

Bagian ini mengajarkan Anda tentang penggunaan construct L2 (tingkat tinggi) dan cara mengembangkan construct kustom yang mengurangi pola berulang.

Menggunakan construct L2

Construct L2 adalah abstraksi native CDK yang lebih mudah digunakan daripada CloudFormation mentah (L1). Mereka memiliki default yang masuk akal dan type safety, seringkali membutuhkan lebih sedikit baris kode untuk menyiapkan sumber daya AWS.

Mengapa menggunakan construct L2?

• Lebih sedikit boilerplate — lebih sedikit field wajib dibandingkan L1
• Kode Python lebih mudah dibaca dan idiomatis
• Mencakup metode utilitas seperti .add_to_role_policy() atau .add_event_notification()
• Secara otomatis mengelola dependensi antar sumber daya

Contoh: Membuat bucket S3 menggunakan L2

from aws_cdk import aws_s3 as s3
# Create a versioned and encrypted S3 bucket
bucket = s3.Bucket(
    self,
    "MyBucket",
    versioned=True,
    encryption=s3.BucketEncryption.S3_MANAGED
)Didukung oleh

Construct L1 yang setara, s3.CfnBucket, akan memerlukan semua properti disetel secara manual dan konfigurasi didefinisikan sebagai dict mentah—jauh kurang intuitif.

Construct L2 umum lainnya meliputi:

• lambda_.Function() untuk AWS Lambda
• dynamodb.Table() untuk DynamoDB
• sqs.Queue() untuk SQS
• sns.Topic() untuk SNS

Membuat construct kustom

Infrastruktur Anda akan berkembang dengan pola berulang, seperti membuat fungsi Lambda dengan izin tertentu dan bucket S3. Construct kustom adalah solusi ideal untuk skenario ini.

Construct kustom memungkinkan Anda menggabungkan sumber daya terkait menjadi satu unit logis, yang dapat digunakan ulang di berbagai stack atau proyek.

Kapan membuat construct kustom:

• Saat Anda memiliki 3+ sumber daya yang selalu disediakan bersama
• Saat Anda ingin mengenkapsulasi logika yang dapat digunakan ulang
• Saat Anda ingin mengurangi duplikasi kode di berbagai stack

Contoh: Pola S3 + Lambda yang dapat digunakan ulang

from constructs import Construct
from aws_cdk import aws_s3 as s3, aws_lambda as lambda_
class StorageWithLambda(Construct):
    def __init__(self, scope: Construct, id: str) -> None:
        super().__init__(scope, id)
        # S3 bucket
        self.bucket = s3.Bucket(self, "MyBucket")

        # Lambda function
        self.function = lambda_.Function(
            self,
            "MyFunction",
            runtime=lambda_.Runtime.PYTHON_3_9,
            handler="index.handler",
            code=lambda_.Code.from_asset("lambda")
        )
        # Grant Lambda access to the S3 bucket
        self.bucket.grant_read_write(self.function)Didukung oleh

Sekarang Anda dapat menggunakan construct ini di dalam stack mana pun seperti ini:

from my_project.storage_with_lambda import StorageWithLambda
storage = StorageWithLambda(self, "ReusableComponent")Didukung oleh

Sebelum menjalankan hal di atas, buat folder bernama lambda di root proyek dan buat file index.py dengan konten berikut:

def handler(event, context):
    return {
        "statusCode": 200,
        "body": "Hello from Lambda!"
    }Didukung oleh

Kiat keterpakaiulangan

• Awali file dengan construct_ atau tempatkan di dalam folder constructs/
• Ekspos output seperti self.bucket atau self.function untuk fleksibilitas
• Jaga setiap construct fokus pada satu tanggung jawab

Menguji dan Mensintesis App CDK

Setelah menulis kode infrastruktur Anda, penting untuk memeriksa apa yang akan diterapkan CDK dan idealnya menguji bahwa stack Anda berperilaku seperti yang diharapkan. AWS CDK menyediakan alat untuk mensintesis template CloudFormation dan menulis pengujian otomatis guna menangkap salah konfigurasi sebelum deployment.

Mensintesis template

Perintah cdk synth menghasilkan template CloudFormation dari kode CDK Anda.

cdk synthDidukung oleh

Saat Anda menjalankannya, CDK akan:

• Memuat app Anda (melalui app.py)
• Menyelesaikan semua construct dan stack
• Menghasilkan template CloudFormation mentah dalam YAML/JSON

Template CloudFormation yang disintesis 

Secara default, output ditampilkan di terminal Anda, tetapi Anda juga dapat mengarahkannya ke file jika diperlukan:

cdk synth > template.yamlDidukung oleh

Ini berguna ketika:

• Anda ingin memeriksa template sebenarnya sebelum deployment
• Anda sedang men-debug struktur sebuah stack
• Anda berbagi template dengan tim yang tidak menggunakan CDK

Menguji infrastruktur

Meskipun menguji infrastructure as code mungkin terdengar tidak biasa, ini bermanfaat, terutama saat stack Anda menjadi besar atau mencakup logika kondisional, loop, atau construct yang dapat digunakan ulang.

AWS CDK menawarkan modul assertions untuk menguji stack yang disintesis.

Menulis pengujian sederhana dengan pytest

Berikut contoh pengujian yang memeriksa apakah sumber daya tertentu (seperti bucket S3) disertakan dalam stack:

# test/test_cdk_datacamp_stack.py
import aws_cdk as cdk
from aws_cdk.assertions import Template
from cdk_datacamp.cdk_datacamp_stack import CdkDatacampStack
def test_s3_bucket_created():
    app = cdk.App()
    stack = CdkDatacampStack(app, "TestStack")
    template = Template.from_stack(stack)
    # Assert that an S3 bucket exists
    template.resource_count_is("AWS::S3::Bucket", 1)Didukung oleh

Untuk menjalankan pengujian, pastikan pytest terpasang:

pip install -U pytestDidukung oleh

Lalu jalankan:

pytestDidukung oleh

Jika semuanya lolos, Anda akan melihat tanda centang hijau. Jika tidak, output pengujian akan memberi tahu Anda apa yang kurang.

Output Pytest yang menunjukkan eksekusi sukses semua kasus uji untuk stack AWS CDK

Anda juga dapat menyertakan validasi di stack CDK Anda. Pengujian validasi adalah pemeriksaan runtime di dalam kode construct atau stack Anda yang memvalidasi input sebelum deployment terjadi. Ini membantu menangkap salah konfigurasi atau menegakkan batasan lebih awal dalam siklus pengembangan.

Misalkan kita ingin meneruskan bucket_name sebagai variabel konteks, tetapi kita ingin memvalidasi bahwa:

• Nama bucket tidak kosong
• Memenuhi aturan penamaan S3 (mis., huruf kecil saja)

Buat file bernama test/test_storage_with_lambda.py dan tambahkan berikut ini:

import pytest
from aws_cdk import App, Stack
from cdk_datacamp.storage_with_lambda import StorageWithLambda

def test_missing_bucket_name():
    app = App()
    stack = Stack(app, "TestStack")

    with pytest.raises(ValueError, match="bucket_name is required"):
        StorageWithLambda(stack, "FailingConstruct", bucket_name=None)

def test_bucket_name_uppercase():
    app = App()
    stack = Stack(app, "TestStack")

    with pytest.raises(ValueError, match="must be lowercase"):
        StorageWithLambda(stack, "FailingConstruct", bucket_name="InvalidName")Didukung oleh

 Untuk menguji validasi, jalankan perintah di bawah ini:

test/test_storage_with_lambda.pyDidukung oleh

Output Pytest yang menunjukkan eksekusi sukses semua kasus uji untuk stack AWS CDK

Kapan menggunakan pengujian:

• Anda membuat construct atau pola yang dapat digunakan ulang.
• Penerapan pengujian berfungsi untuk menetapkan persyaratan teknis standar di antara anggota tim.
• Anda ingin menangkap regresi atau perubahan yang tidak diinginkan selama CI/CD.

Ingin memperkuat pengetahuan CDK Anda dalam situasi wawancara? Kumpulan pertanyaan wawancara AWS DevOps teratas ini dapat membantu Anda bersiap.

Praktik Terbaik dan Kiat untuk Bekerja dengan AWS CDK

Setelah menguasai pembuatan dan deployment stack CDK, Anda harus mengikuti praktik terbaik untuk menjaga kode infrastruktur tetap bersih, aman, dan skalabel. Bagian ini akan membahas cara menyusun proyek besar, menangani keamanan dengan benar, dan mengintegrasikan CDK ke pipeline CI/CD.

Mengorganisasi proyek besar

Saat app CDK Anda berkembang, mengorganisasi kode menjadi unit yang dapat dikelola menjadi hal penting.

Gunakan beberapa stack

Pisahkan infrastruktur berdasarkan concern. Misalnya:

• NetworkingStack: VPC, subnet, security group
• ComputeStack: EC2, Lambda
• StorageStack: S3, DynamoDB

Ini memungkinkan Anda menerapkan, menguji, atau menghapus bagian infrastruktur secara mandiri. Berikut cara menyertakannya dalam app.py:

network_stack = NetworkingStack(app, "NetworkingStack")
compute_stack = ComputeStack(app, "ComputeStack")Didukung oleh

Anda juga dapat meneruskan sumber daya antar stack menggunakan output atau referensi.

Buat construct bertingkat yang dapat digunakan ulang

Enkapsulasi sumber daya terkait (seperti Lambda dan izinnya) ke dalam construct kustom, seperti yang Anda lakukan dengan StorageWithLambda. Ini meningkatkan keterbacaan dan keterpakaiulangan lintas stack atau app.

Gunakan konfigurasi spesifik lingkungan

Dukung beberapa lingkungan (dev, staging, prod) menggunakan:

• cdk.json dengan nilai konteks
• Override CLI: cdk deploy -c env=prod
• Logika kondisional di stack Anda

env = app.node.try_get_context("env")
if env == "prod":
    bucket_name = "mycompany-prod-logs"Didukung oleh

Keamanan dan izin

Setiap proyek infrastruktur harus memprioritaskan keamanan selama proses deployment otomatis AWS CDK. Bagian berikut menunjukkan pengelolaan sumber daya IAM yang aman melalui prinsip least privilege.

Definisikan role IAM alih-alih menggunakan default

Construct CDK, termasuk tugas Lambda atau ECS, akan otomatis membuat role IAM. Meskipun nyaman, ini dapat membatasi kontrol Anda atas izin dan penamaan.

Sebagai gantinya, definisikan role secara eksplisit:

from aws_cdk import aws_iam as iam

execution_role = iam.Role(
    self,
    "LambdaExecutionRole",
    assumed_by=iam.ServicePrincipal("lambda.amazonaws.com"),
    description="Custom role for Lambda with least privilege",
    managed_policies=[
        iam.ManagedPolicy.from_aws_managed_policy_name("service-role/AWSLambdaBasicExecutionRole")
    ]
)Didukung oleh

Role ini hanya mengizinkan logging dan tidak ada yang lain secara default.

Terapkan prinsip least privilege

Hindari menggunakan "*" pada actions atau resources kecuali benar-benar diperlukan.

Contoh:

lambda_fn.add_to_role_policy(
    iam.PolicyStatement(
        actions=["*"],
        resources=["*"]
    )
)Didukung oleh

Anda juga dapat menggunakan grant spesifik sumber daya jika tersedia:

bucket.grant_read(lambda_fn)Didukung oleh

Ini secara otomatis menghasilkan kebijakan yang diperlukan dengan akses yang dibatasi ke bucket S3 tersebut.

Gunakan managed policy jika memungkinkan

AWS-managed policy menyederhanakan pemeliharaan dan mengurangi kemungkinan kesalahan.

iam.ManagedPolicy.from_aws_managed_policy_name("AmazonSQSReadOnlyAccess")Didukung oleh

Anda dapat melampirkannya ke role kustom untuk layanan seperti ECS, Batch, atau Step Functions.

Integrasi CI/CD

AWS CDK memberikan kekuatan luar biasa melalui kemampuannya berintegrasi dengan pipeline CI/CD kontemporer. CDK mendukung delivery infrastruktur otomatis melalui deployment kode yang dikendalikan versi, yang bekerja dengan GitHub, GitLab, dan layanan native AWS termasuk CodePipeline. Sistem ini mengurangi kesalahan manusia sambil memperpendek siklus umpan balik dan memungkinkan deployment di berbagai lingkungan.

GitHub Actions: Mengotomatiskan deployment CDK

Anda dapat menggunakan GitHub Actions untuk melakukan synth, diff, test, dan deploy stack CDK pada setiap push atau pull request.

Lihat .github/workflows/deploy.yml ini:

name: Deploy CDK App

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - uses: actions/setup-python@v4
        with:
          python-version: 3.11

      - name: Install dependencies
        run: |
          pip install -r requirements.txt
          npm install -g aws-cdk

      - name: Run unit tests
        run: pytest

      - name: CDK Synth
        run: cdk synth -c environment=prod

      - name: Deploy to AWS
        run: cdk deploy --require-approval never
        env:
          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}Didukung oleh

Gunakan cdk diff dalam PR untuk meninjau perubahan infra sebelum menggabungkan.

CDK pipelines: CI/CD native CDK dengan CodePipeline

Untuk deployment terkelola penuh di dalam AWS, CDK menyediakan modul bernama aws_cdk.pipelines, yang memungkinkan Anda mendefinisikan seluruh pipeline CI/CD sebagai kode, seperti halnya infrastruktur.

Berikut contoh yang disederhanakan:

from aws_cdk import pipelines, SecretValue, Stack
from constructs import Construct
from my_app_stage import MyAppStage  # replace with your actual stage import

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

        # Define the source of the pipeline from a GitHub repository
        source = pipelines.CodePipelineSource.git_hub(
            repo_string="your-org/your-repo",  # GitHub org/repo
            branch="main",
            authentication=SecretValue.secrets_manager("GITHUB_TOKEN")
        )

        # Define the CodePipeline and its synthesis step
        pipeline = pipelines.CodePipeline(
            self,
            "MyAppPipeline",
            synth=pipelines.ShellStep(
                "Synth",
                input=source,
                commands=[
                    "pip install -r requirements.txt",
                    "npm install -g aws-cdk",
                    "cdk synth"
                ]
            )
        )

        # Add an application stage (e.g., production deployment)
        pipeline.add_stage(
            MyAppStage(self, "ProdStage")
        )Didukung oleh

Pada kode di atas:

• SecretValue.secrets_manager("GITHUB_TOKEN") secara aman mengambil token GitHub Anda dari Secrets Manager.
• MyAppStage harus berupa kelas yang memperluas Stage dan membungkus stack CDK Anda yang sebenarnya.

Jika Anda menerapkan sistem machine learning, integrasi CDK dengan praktik deployment berkelanjutan dibahas dalam kursus CI/CD for Machine Learning kami.

Kesimpulan

Tutorial ini menunjukkan cara membangun dan menerapkan infrastruktur cloud dalam Python melalui operasi AWS Cloud Development Kit (CDK). Anda telah mempelajari cara:

• Membuat stack CDK pertama Anda.
• Mendefinisikan dan memvalidasi bucket S3 dan fungsi Lambda sebagai sumber daya.
• Mengorganisasi proyek melalui construct kustom dan pola multi-stack.
• Menerapkan praktik keamanan terbaik melalui prinsip least privilege.
• Mengotomatiskan deployment dengan menggabungkan GitHub Actions dan CDK Pipelines.
• Menulis pengujian untuk memvalidasi logika infrastruktur Anda.

Sekarang Anda telah menerapkan app CDK pertama Anda, berikut beberapa cara untuk naik tingkat:

• Gunakan lingkungan terparametrisasi untuk dev/staging/prod
• Tambahkan CloudWatch alarms, API Gateway, atau Step Functions
• Jelajahi construct CDK seperti aws_s3_deployment, aws_ecs_patterns, dan cdk.pipelines
• Ubah construct Anda menjadi pustaka Python internal untuk keterpakaiulangan

Untuk terus belajar dan membangun, simak kursus Introduction to AWS Boto in Python!