AWS CDK Membangun

Mode fokus

AWS CDK Membangun - AWS Cloud Development Kit (AWS CDK) v2

Impor dan gunakan konstruksi Membangun tingkat Mendefinisikan konstruksi Bekerja dengan konstruksi Bekerja dengan konstruksi pihak ketiga Pelajari selengkapnya

Ini adalah Panduan Pengembang AWS CDK v2. CDK v1 yang lebih lama memasuki pemeliharaan pada 1 Juni 2022 dan mengakhiri dukungan pada 1 Juni 2023.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Ini adalah Panduan Pengembang AWS CDK v2. CDK v1 yang lebih lama memasuki pemeliharaan pada 1 Juni 2022 dan mengakhiri dukungan pada 1 Juni 2023.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Konstruksi adalah blok bangunan dasar AWS Cloud Development Kit (AWS CDK) aplikasi. Konstruk adalah komponen dalam aplikasi Anda yang mewakili satu atau lebih AWS CloudFormation sumber daya dan konfigurasinya. Anda membangun aplikasi Anda, sepotong demi sepotong, dengan mengimpor dan mengonfigurasi konstruksi.

Impor dan gunakan konstruksi

Konstruksi adalah kelas yang Anda impor ke aplikasi CDK Anda dari AWS Construct Library. Anda juga dapat membuat dan mendistribusikan konstruksi Anda sendiri, atau menggunakan konstruksi yang dibuat oleh pengembang pihak ketiga.

Konstruksi adalah bagian dari Construct Programming Model (CPM). Mereka tersedia untuk digunakan dengan alat lain seperti CDK untuk Terraform (CDKtf), CDK untuk Kubernetes (CDK8s), dan Projen.

Banyak pihak ketiga juga telah menerbitkan konstruksi yang kompatibel dengan. AWS CDK Kunjungi Construct Hub untuk menjelajahi ekosistem mitra AWS CDK konstruksi.

Membangun tingkat

Konstruksi dari AWS Construct Library dikategorikan menjadi tiga tingkatan. Setiap tingkat menawarkan tingkat abstraksi yang meningkat. Semakin tinggi abstraksi, semakin mudah dikonfigurasi, membutuhkan lebih sedikit keahlian. Semakin rendah abstraksi, semakin banyak kustomisasi yang tersedia, membutuhkan lebih banyak keahlian.

Konstruksi level 1 (L1)

Konstruksi L1, juga dikenal sebagai sumber daya CFN, adalah konstruksi tingkat terendah dan tidak menawarkan abstraksi. Setiap konstruksi L1 memetakan langsung ke satu AWS CloudFormation sumber daya. Dengan konstruksi L1, Anda mengimpor konstruksi yang mewakili sumber daya tertentu. AWS CloudFormation Anda kemudian menentukan properti sumber daya dalam instance konstruksi Anda.

Konstruksi L1 sangat bagus untuk digunakan ketika Anda terbiasa AWS CloudFormation dan membutuhkan kontrol penuh untuk mendefinisikan properti sumber daya Anda AWS .

Dalam AWS Construct Library, konstruksi L1 diberi nama dimulai denganCfn, diikuti oleh identifier untuk AWS CloudFormation sumber daya yang diwakilinya. Misalnya, CfnBucket konstruk adalah konstruksi L1 yang mewakili sumber daya. AWS::S3::Bucket AWS CloudFormation

Konstruksi L1 dihasilkan dari spesifikasi AWS CloudFormation sumber daya. Jika sumber daya ada di AWS CloudFormation, itu akan tersedia di AWS CDK sebagai konstruksi L1. Sumber daya atau properti baru mungkin membutuhkan waktu hingga satu minggu untuk tersedia di Perpustakaan AWS Konstruksi. Untuk informasi selengkapnya, lihat referensi jenis AWS sumber daya dan properti di Panduan AWS CloudFormation Pengguna.

Konstruksi level 2 (L2)

Konstruksi L2, juga dikenal sebagai konstruksi kurasi, dikembangkan dengan cermat oleh tim CDK dan biasanya merupakan jenis konstruksi yang paling banyak digunakan. Konstruksi L2 memetakan langsung ke AWS CloudFormation sumber daya tunggal, mirip dengan konstruksi L1. Dibandingkan dengan konstruksi L1, konstruksi L2 memberikan abstraksi tingkat yang lebih tinggi melalui API berbasis niat intuitif. Konstruksi L2 mencakup konfigurasi properti default yang masuk akal, kebijakan keamanan praktik terbaik, dan menghasilkan banyak kode boilerplate dan logika lem untuk Anda.

Konstruksi L2 juga menyediakan metode pembantu untuk sebagian besar sumber daya yang membuatnya lebih sederhana dan lebih cepat untuk menentukan properti, izin, interaksi berbasis peristiwa antara sumber daya, dan banyak lagi.

s3.BucketKelas ini adalah contoh konstruksi L2 untuk sumber daya bucket Amazon Simple Storage Service (Amazon S3).

Library AWS Construct berisi konstruksi L2 yang ditunjuk stabil dan siap untuk digunakan produksi. Untuk konstruksi L2 yang sedang dikembangkan, mereka ditunjuk sebagai eksperimental dan ditawarkan dalam modul terpisah.

Konstruksi level 3 (L3)

Konstruksi L3, juga dikenal sebagai pola, adalah abstraksi tingkat tertinggi. Setiap konstruksi L3 dapat berisi kumpulan sumber daya yang dikonfigurasi untuk bekerja sama untuk menyelesaikan tugas atau layanan tertentu dalam aplikasi Anda. Konstruksi L3 digunakan untuk membuat seluruh AWS arsitektur untuk kasus penggunaan tertentu dalam aplikasi Anda.

Untuk menyediakan desain sistem yang lengkap, atau bagian penting dari sistem yang lebih besar, konstruksi L3 menawarkan konfigurasi properti default yang berpendirian. Mereka dibangun di sekitar pendekatan tertentu untuk memecahkan masalah dan memberikan solusi. Dengan konstruksi L3, Anda dapat membuat dan mengonfigurasi beberapa sumber daya dengan cepat, dengan jumlah input dan kode paling sedikit.

ecsPatterns.ApplicationLoadBalancedFargateServiceKelas adalah contoh konstruksi L3 yang mewakili layanan yang berjalan pada cluster Amazon Elastic Container AWS Fargate Service (Amazon ECS) Container Service (Amazon ECS) dan diawali oleh penyeimbang beban aplikasi.

Mirip dengan konstruksi L2, konstruksi L3 yang siap untuk penggunaan produksi disertakan dalam Construct Library. AWS Mereka yang sedang dikembangkan ditawarkan dalam modul terpisah.

Mendefinisikan konstruksi

Komposisi

Komposisi adalah pola kunci untuk mendefinisikan abstraksi tingkat yang lebih tinggi melalui konstruksi. Sebuah konstruksi tingkat tinggi dapat terdiri dari sejumlah konstruksi tingkat rendah. Dari perspektif bottom-up, Anda menggunakan konstruksi untuk mengatur AWS sumber daya individual yang ingin Anda terapkan. Anda menggunakan abstraksi apa pun yang nyaman untuk tujuan Anda, dengan level sebanyak yang Anda butuhkan.

Dengan komposisi, Anda menentukan komponen yang dapat digunakan kembali dan membagikannya seperti kode lainnya. Misalnya, tim dapat menentukan konstruksi yang mengimplementasikan praktik terbaik perusahaan untuk tabel Amazon DynamoDB, termasuk pencadangan, replikasi global, penskalaan otomatis, dan pemantauan. Tim dapat berbagi konstruksi secara internal dengan tim lain, atau secara publik.

Tim dapat menggunakan konstruksi seperti paket perpustakaan lainnya. Ketika pustaka diperbarui, pengembang mendapatkan akses ke perbaikan versi baru dan perbaikan bug, mirip dengan pustaka kode lainnya.

Inisialisasi

Konstruksi diimplementasikan di kelas yang memperluas kelas Constructdasar. Anda mendefinisikan konstruksi dengan membuat instance kelas. Semua konstruksi mengambil tiga parameter saat diinisialisasi:

lingkup — Orang tua atau pemilik konstruksi. Ini bisa berupa tumpukan atau konstruksi lain. Lingkup menentukan tempat konstruk di pohon konstruksi. Anda biasanya harus lulus this (selfdalam Python), yang mewakili objek saat ini, untuk ruang lingkup.
id — Pengenal yang harus unik dalam lingkup. Identifier berfungsi sebagai namespace untuk semua yang didefinisikan dalam konstruksi. Ini digunakan untuk menghasilkan pengidentifikasi unik, seperti nama sumber daya dan AWS CloudFormation logis IDs.

Pengidentifikasi hanya perlu unik dalam lingkup. Ini memungkinkan Anda membuat instance dan menggunakan kembali konstruksi tanpa memperhatikan konstruksi dan pengidentifikasi yang mungkin dikandungnya, dan memungkinkan pembuatan konstruksi menjadi abstraksi tingkat yang lebih tinggi. Selain itu, cakupan memungkinkan untuk merujuk ke kelompok konstruksi sekaligus. Contohnya termasuk untuk penandaan, atau menentukan di mana konstruksi akan digunakan.
props — Satu set properti atau argumen kata kunci, tergantung pada bahasa, yang menentukan konfigurasi awal konstruksi. Konstruksi tingkat yang lebih tinggi memberikan lebih banyak default, dan jika semua elemen prop opsional, Anda dapat menghilangkan parameter props sepenuhnya.

Konfigurasi

Sebagian besar konstruksi menerima props sebagai argumen ketiga mereka (atau dalam Python, argumen kata kunci), kumpulan nama/nilai yang mendefinisikan konfigurasi konstruksi. Contoh berikut mendefinisikan bucket dengan enkripsi AWS Key Management Service (AWS KMS) dan hosting situs web statis diaktifkan. Karena tidak secara eksplisit menentukan kunci enkripsi, Bucket konstruksi mendefinisikan yang baru kms.Key dan mengaitkannya dengan bucket.

anchor anchor anchor anchor anchor anchor


new s3.Bucket(this, 'MyEncryptedBucket', {
  encryption: s3.BucketEncryption.KMS,
  websiteIndexDocument: 'index.html'
});

Berinteraksi dengan konstruksi

Konstruksi adalah kelas yang memperluas kelas Konstruksi dasar. Setelah Anda membuat instance konstruksi, objek konstruksi mengekspos satu set metode dan properti yang memungkinkan Anda berinteraksi dengan konstruksi dan meneruskannya sebagai referensi ke bagian lain dari sistem.

AWS CDK Kerangka kerja tidak membatasi APIs konstruksi. Penulis dapat menentukan API apa pun yang mereka inginkan. Namun, AWS konstruksi yang disertakan dengan AWS Construct Library, sepertis3.Bucket, mengikuti pedoman dan pola umum. Ini memberikan pengalaman yang konsisten di semua AWS sumber daya.

Sebagian besar AWS konstruksi memiliki seperangkat metode hibah yang dapat Anda gunakan untuk memberikan izin AWS Identity and Access Management (IAM) pada konstruksi tersebut ke prinsipal. Contoh berikut memberikan data-science izin grup IAM untuk membaca dari bucket Amazon S3. raw-data

anchor anchor anchor anchor anchor anchor


const rawData = new s3.Bucket(this, 'raw-data');
const dataScience = new iam.Group(this, 'data-science');
rawData.grantRead(dataScience);

Pola umum lainnya adalah AWS konstruksi untuk mengatur salah satu atribut sumber daya dari data yang disediakan di tempat lain. Atribut dapat mencakup Amazon Resource Names (ARNs), nama, atau URLs.

Kode berikut mendefinisikan AWS Lambda fungsi dan mengaitkannya dengan antrian Amazon Simple Queue Service (Amazon SQS) melalui URL antrian dalam variabel lingkungan.

TypeScript


const jobsQueue = new sqs.Queue(this, 'jobs');
const createJobLambda = new lambda.Function(this, 'create-job', {
  runtime: lambda.Runtime.NODEJS_18_X,
  handler: 'index.handler',
  code: lambda.Code.fromAsset('./create-job-lambda-code'),
  environment: {
    QUEUE_URL: jobsQueue.queueUrl
  }
});

JavaScript


const jobsQueue = new sqs.Queue(this, 'jobs');
const createJobLambda = new lambda.Function(this, 'create-job', {
  runtime: lambda.Runtime.NODEJS_18_X,
  handler: 'index.handler',
  code: lambda.Code.fromAsset('./create-job-lambda-code'),
  environment: {
    QUEUE_URL: jobsQueue.queueUrl
  }
});

Python


jobs_queue = sqs.Queue(self, "jobs")
create_job_lambda = lambda_.Function(self, "create-job",
    runtime=lambda_.Runtime.NODEJS_18_X,
    handler="index.handler",
    code=lambda_.Code.from_asset("./create-job-lambda-code"),
    environment=dict(
        QUEUE_URL=jobs_queue.queue_url
    )
)

Java


final Queue jobsQueue = new Queue(this, "jobs");
Function createJobLambda = Function.Builder.create(this, "create-job")
                .handler("index.handler")
                .code(Code.fromAsset("./create-job-lambda-code"))
                .environment(java.util.Map.of(   // Map.of is Java 9 or later
                    "QUEUE_URL", jobsQueue.getQueueUrl())
                .build();

C#


var jobsQueue = new Queue(this, "jobs");
var createJobLambda = new Function(this, "create-job", new FunctionProps
{
    Runtime = Runtime.NODEJS_18_X,
    Handler = "index.handler",
    Code = Code.FromAsset(@".\create-job-lambda-code"),
    Environment = new Dictionary<string, string>
    {
        ["QUEUE_URL"] = jobsQueue.QueueUrl
    }
});

Go


	createJobLambda := awslambda.NewFunction(stack, jsii.String("create-job"), &awslambda.FunctionProps{
		Runtime: awslambda.Runtime_NODEJS_18_X(),
		Handler: jsii.String("index.handler"),
		Code:    awslambda.Code_FromAsset(jsii.String(".\\create-job-lambda-code"), nil),
		Environment: &map[string]*string{
			"QUEUE_URL": jsii.String(*jobsQueue.QueueUrl()),
		},
	})

anchor anchor anchor anchor anchor anchor


const jobsQueue = new sqs.Queue(this, 'jobs');
const createJobLambda = new lambda.Function(this, 'create-job', {
  runtime: lambda.Runtime.NODEJS_18_X,
  handler: 'index.handler',
  code: lambda.Code.fromAsset('./create-job-lambda-code'),
  environment: {
    QUEUE_URL: jobsQueue.queueUrl
  }
});

Untuk informasi tentang pola API yang paling umum di AWS Construct Library, lihatSumber daya dan AWS CDK.

Aplikasi dan konstruksi tumpukan

StackKelas App dan dari AWS Construct Library adalah konstruksi yang unik. Dibandingkan dengan konstruksi lain, mereka tidak mengonfigurasi AWS sumber daya sendiri. Sebaliknya, mereka digunakan untuk menyediakan konteks untuk konstruksi Anda yang lain. Semua konstruksi yang mewakili AWS sumber daya harus didefinisikan, secara langsung atau tidak langsung, dalam lingkup konstruksi. Stack Stackkonstruksi didefinisikan dalam lingkup App konstruk.

Untuk mempelajari lebih lanjut tentang aplikasi CDK, lihatAWS CDK aplikasi. Untuk mempelajari lebih lanjut tentang tumpukan CDK, lihat. Pengantar AWS CDK tumpukan

Contoh berikut mendefinisikan aplikasi dengan satu tumpukan. Di dalam tumpukan, konstruksi L2 digunakan untuk mengonfigurasi sumber daya bucket Amazon S3.

TypeScript


import { App, Stack, StackProps } from 'aws-cdk-lib';
import * as s3 from 'aws-cdk-lib/aws-s3';

class HelloCdkStack extends Stack {
  constructor(scope: App, id: string, props?: StackProps) {
    super(scope, id, props);

    new s3.Bucket(this, 'MyFirstBucket', {
      versioned: true
    });
  }
}

const app = new App();
new HelloCdkStack(app, "HelloCdkStack");

JavaScript


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

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

    new s3.Bucket(this, 'MyFirstBucket', {
      versioned: true
    });
  }
}

const app = new App();
new HelloCdkStack(app, "HelloCdkStack");

Python


from aws_cdk import App, Stack
import aws_cdk.aws_s3 as s3
from constructs import Construct

class HelloCdkStack(Stack):

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

        s3.Bucket(self, "MyFirstBucket", versioned=True)

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

Java

Tumpukan didefinisikan dalam HelloCdkStack.java file:


import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.s3.*;

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);

        Bucket.Builder.create(this, "MyFirstBucket")
            .versioned(true).build();
    }
}

Aplikasi didefinisikan dalam HelloCdkApp.java file:


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

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

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

        app.synth();
    }
}

C#


using Amazon.CDK;
using Amazon.CDK.AWS.S3;

namespace HelloCdkApp
{
    internal static class Program
    {
        public static void Main(string[] args)
        {
            var app = new App();
            new HelloCdkStack(app, "HelloCdkStack");
            app.Synth();
        }
    }
    
    public class HelloCdkStack : Stack
    {
        public HelloCdkStack(Construct scope, string id, IStackProps props=null) : base(scope, id, props)
        {
            new Bucket(this, "MyFirstBucket", new BucketProps { Versioned = true });
        }
    }
}

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)

	awss3.NewBucket(stack, jsii.String("MyFirstBucket"), &awss3.BucketProps{
		Versioned: jsii.Bool(true),
	})

	return stack
}

anchor anchor anchor anchor anchor anchor


import { App, Stack, StackProps } from 'aws-cdk-lib';
import * as s3 from 'aws-cdk-lib/aws-s3';

class HelloCdkStack extends Stack {
  constructor(scope: App, id: string, props?: StackProps) {
    super(scope, id, props);

    new s3.Bucket(this, 'MyFirstBucket', {
      versioned: true
    });
  }
}

const app = new App();
new HelloCdkStack(app, "HelloCdkStack");

Bekerja dengan konstruksi

Bekerja dengan konstruksi L1

L1 membangun peta langsung ke sumber daya individu AWS CloudFormation . Anda harus menyediakan konfigurasi sumber daya yang diperlukan.

Dalam contoh ini, kita membuat bucket objek menggunakan konstruksi CfnBucket L1:

anchor anchor anchor anchor anchor anchor


const bucket = new s3.CfnBucket(this, "amzn-s3-demo-bucket", {
  bucketName: "amzn-s3-demo-bucket"
});

Properti konstruksi yang bukan Boolean sederhana, string, angka, atau kontainer ditangani secara berbeda dalam bahasa yang didukung.

TypeScript


const bucket = new s3.CfnBucket(this, "amzn-s3-demo-bucket", {
  bucketName: "amzn-s3-demo-bucket",
  corsConfiguration: {
    corsRules: [{
          allowedOrigins: ["*"],
          allowedMethods: ["GET"]
    }]
  }
});

JavaScript


const bucket = new s3.CfnBucket(this, "amzn-s3-demo-bucket", {
  bucketName: "amzn-s3-demo-bucket",
  corsConfiguration: {
    corsRules: [{
          allowedOrigins: ["*"],
          allowedMethods: ["GET"]
    }]
  }
});

Python

Dalam Python, properti ini diwakili oleh tipe yang didefinisikan sebagai kelas dalam dari konstruksi L1. Misalnya, properti opsional cors_configuration dari sebuah CfnBucket memerlukan pembungkus tipeCfnBucket.CorsConfigurationProperty. Di sini kita mendefinisikan cors_configuration sebuah CfnBucket contoh.


bucket = CfnBucket(self, "amzn-s3-demo-bucket", bucket_name="amzn-s3-demo-bucket",
    cors_configuration=CfnBucket.CorsConfigurationProperty(
        cors_rules=[CfnBucket.CorsRuleProperty(
            allowed_origins=["*"],
            allowed_methods=["GET"]
        )]
    )
)

Java

Di Jawa, properti ini diwakili oleh tipe yang didefinisikan sebagai kelas dalam dari konstruksi L1. Misalnya, properti opsional corsConfiguration dari sebuah CfnBucket memerlukan pembungkus tipeCfnBucket.CorsConfigurationProperty. Di sini kita mendefinisikan corsConfiguration sebuah CfnBucket contoh.


CfnBucket bucket = CfnBucket.Builder.create(this, "amzn-s3-demo-bucket")
                        .bucketName("amzn-s3-demo-bucket")
                        .corsConfiguration(new CfnBucket.CorsConfigurationProperty.Builder()
                            .corsRules(Arrays.asList(new CfnBucket.CorsRuleProperty.Builder()
                                .allowedOrigins(Arrays.asList("*"))
                                .allowedMethods(Arrays.asList("GET"))
                                .build()))
                            .build())
                        .build();

C#

Dalam C #, properti ini diwakili oleh tipe yang didefinisikan sebagai kelas dalam dari konstruksi L1. Misalnya, properti opsional CorsConfiguration dari sebuah CfnBucket memerlukan pembungkus tipeCfnBucket.CorsConfigurationProperty. Di sini kita mendefinisikan CorsConfiguration sebuah CfnBucket contoh.


var bucket = new CfnBucket(this, "amzn-s3-demo-bucket", new CfnBucketProps
{
    BucketName = "amzn-s3-demo-bucket",
    CorsConfiguration = new CfnBucket.CorsConfigurationProperty
    {
        CorsRules = new object[] {
            new CfnBucket.CorsRuleProperty
            {
                AllowedOrigins = new string[] { "*" },
                AllowedMethods = new string[] { "GET" },
            }
        }
    }
});

Go

Di Go, jenis ini diberi nama menggunakan nama konstruksi L1, garis bawah, dan nama properti. Misalnya, properti opsional CorsConfiguration dari sebuah CfnBucket memerlukan pembungkus tipeCfnBucket_CorsConfigurationProperty. Di sini kita mendefinisikan CorsConfiguration sebuah CfnBucket contoh.


	awss3.NewCfnBucket(stack, jsii.String("amzn-s3-demo-bucket"), &awss3.CfnBucketProps{
		BucketName: jsii.String("amzn-s3-demo-bucket"),
		CorsConfiguration: &awss3.CfnBucket_CorsConfigurationProperty{
			CorsRules: []awss3.CorsRule{
				awss3.CorsRule{
					AllowedOrigins: jsii.Strings("*"),
					AllowedMethods: &[]awss3.HttpMethods{"GET"},
				},
			},
		},
	})

anchor anchor anchor anchor anchor anchor


const bucket = new s3.CfnBucket(this, "amzn-s3-demo-bucket", {
  bucketName: "amzn-s3-demo-bucket",
  corsConfiguration: {
    corsRules: [{
          allowedOrigins: ["*"],
          allowedMethods: ["GET"]
    }]
  }
});

penting

Anda tidak dapat menggunakan tipe properti L2 dengan konstruksi L1, atau sebaliknya. Saat bekerja dengan konstruksi L1, selalu gunakan tipe yang ditentukan untuk konstruksi L1 yang Anda gunakan. Jangan gunakan tipe dari konstruksi L1 lainnya (beberapa mungkin memiliki nama yang sama, tetapi tipenya bukan tipe yang sama).

Beberapa referensi API khusus bahasa kami saat ini memiliki kesalahan di jalur ke tipe properti L1, atau tidak mendokumentasikan kelas ini sama sekali. Kami berharap untuk segera memperbaikinya. Sementara itu, ingatlah bahwa tipe seperti itu selalu merupakan kelas dalam dari konstruksi L1 yang digunakan.

Bekerja dengan konstruksi L2

Dalam contoh berikut, kita mendefinisikan bucket Amazon S3 dengan membuat objek dari konstruksi BucketL2:

anchor anchor anchor anchor anchor anchor


import * as s3 from 'aws-cdk-lib/aws-s3';

// "this" is HelloCdkStack
new s3.Bucket(this, 'MyFirstBucket', {
  versioned: true
});

MyFirstBucketbukan nama ember yang AWS CloudFormation menciptakan. Ini adalah pengidentifikasi logis yang diberikan ke konstruksi baru dalam konteks aplikasi CDK Anda. Nilai PhysicalName akan digunakan untuk memberi nama sumber daya. AWS CloudFormation

Bekerja dengan konstruksi pihak ketiga

Construct Hub adalah sumber daya untuk membantu Anda menemukan konstruksi tambahan dari AWS, pihak ketiga, dan komunitas CDK sumber terbuka.

Menulis konstruksi Anda sendiri

Selain menggunakan konstruksi yang ada, Anda juga dapat menulis konstruksi Anda sendiri dan membiarkan siapa pun menggunakannya di aplikasi mereka. Semua konstruksi sama di. AWS CDK Konstruksi dari Perpustakaan AWS Konstruksi diperlakukan sama seperti konstruksi dari pustaka pihak ketiga yang diterbitkan melalui NPM, Maven, atau PyPI. Konstruksi yang dipublikasikan ke repositori paket internal perusahaan Anda juga diperlakukan dengan cara yang sama.

Untuk mendeklarasikan konstruksi baru, buat kelas yang memperluas kelas dasar Construct, dalam constructs paket, lalu ikuti pola untuk argumen penginisialisasi.

Contoh berikut menunjukkan cara mendeklarasikan konstruksi yang mewakili bucket Amazon S3. Bucket S3 mengirimkan notifikasi Amazon Simple Notification Service (Amazon SNS) setiap kali seseorang mengunggah file ke dalamnya.

TypeScript


export interface NotifyingBucketProps {
  prefix?: string;
}

export class NotifyingBucket extends Construct {
  constructor(scope: Construct, id: string, props: NotifyingBucketProps = {}) {
    super(scope, id);
    const bucket = new s3.Bucket(this, 'bucket');
    const topic = new sns.Topic(this, 'topic');
    bucket.addObjectCreatedNotification(new s3notify.SnsDestination(topic),
      { prefix: props.prefix });
  }
}

JavaScript


class NotifyingBucket extends Construct {
  constructor(scope, id, props = {}) {
    super(scope, id);
    const bucket = new s3.Bucket(this, 'bucket');
    const topic = new sns.Topic(this, 'topic');
    bucket.addObjectCreatedNotification(new s3notify.SnsDestination(topic),
      { prefix: props.prefix });
  }
}

module.exports = { NotifyingBucket }

Python


class NotifyingBucket(Construct):

    def __init__(self, scope: Construct, id: str, *, prefix=None):
        super().__init__(scope, id)
        bucket = s3.Bucket(self, "bucket")
        topic = sns.Topic(self, "topic")
        bucket.add_object_created_notification(s3notify.SnsDestination(topic),
            s3.NotificationKeyFilter(prefix=prefix))

Java


public class NotifyingBucket extends Construct {

    public NotifyingBucket(final Construct scope, final String id) {
        this(scope, id, null, null);
    }
    
    public NotifyingBucket(final Construct scope, final String id, final BucketProps props) {
        this(scope, id, props, null);
    }
    
    public NotifyingBucket(final Construct scope, final String id, final String prefix) {
        this(scope, id, null, prefix);
    }

    public NotifyingBucket(final Construct scope, final String id, final BucketProps props, final String prefix) {
        super(scope, id);

        Bucket bucket = new Bucket(this, "bucket");
        Topic topic = new Topic(this, "topic");
        if (prefix != null)
            bucket.addObjectCreatedNotification(new SnsDestination(topic),
                NotificationKeyFilter.builder().prefix(prefix).build());
     }
}

C#


public class NotifyingBucketProps : BucketProps
{
    public string Prefix { get; set; }
}

public class NotifyingBucket : Construct
{
    public NotifyingBucket(Construct scope, string id, NotifyingBucketProps props = null) : base(scope, id)
    {
        var bucket = new Bucket(this, "bucket");
        var topic = new Topic(this, "topic");
        bucket.AddObjectCreatedNotification(new SnsDestination(topic), new NotificationKeyFilter
        {
            Prefix = props?.Prefix
        });
    }
}

Go


type NotifyingBucketProps struct {
	awss3.BucketProps
	Prefix *string
}

func NewNotifyingBucket(scope constructs.Construct, id *string, props *NotifyingBucketProps) awss3.Bucket {
	var bucket awss3.Bucket
	if props == nil {
		bucket = awss3.NewBucket(scope, jsii.String(*id+"Bucket"), nil)
	} else {
		bucket = awss3.NewBucket(scope, jsii.String(*id+"Bucket"), &props.BucketProps)
	}
	topic := awssns.NewTopic(scope, jsii.String(*id+"Topic"), nil)
	if props == nil {
		bucket.AddObjectCreatedNotification(awss3notifications.NewSnsDestination(topic))
	} else {
		bucket.AddObjectCreatedNotification(awss3notifications.NewSnsDestination(topic), &awss3.NotificationKeyFilter{
			Prefix: props.Prefix,
		})
	}
	return bucket
}

anchor anchor anchor anchor anchor anchor


export interface NotifyingBucketProps {
  prefix?: string;
}

export class NotifyingBucket extends Construct {
  constructor(scope: Construct, id: string, props: NotifyingBucketProps = {}) {
    super(scope, id);
    const bucket = new s3.Bucket(this, 'bucket');
    const topic = new sns.Topic(this, 'topic');
    bucket.addObjectCreatedNotification(new s3notify.SnsDestination(topic),
      { prefix: props.prefix });
  }
}

catatan

NotifyingBucketKonstruksi kami mewarisi bukan dari Bucket melainkan dari. Construct Kami menggunakan komposisi, bukan pewarisan, untuk menggabungkan bucket Amazon S3 dan topik Amazon SNS bersama-sama. Secara umum, komposisi lebih disukai daripada pewarisan ketika mengembangkan AWS CDK konstruksi.

NotifyingBucketKonstruktor memiliki tanda tangan konstruksi yang khas:scope,id, dan. props Argumen terakhir,props, adalah opsional (mendapat nilai default{}) karena semua alat peraga adalah opsional. (ConstructKelas dasar tidak mengambil props argumen.) Anda dapat menentukan instance konstruksi ini di aplikasi Anda tanpaprops, misalnya:

anchor anchor anchor anchor anchor anchor


new NotifyingBucket(this, 'MyNotifyingBucket');

Atau Anda dapat menggunakan props (di Java, parameter tambahan) untuk menentukan awalan jalur untuk difilter, misalnya:

anchor anchor anchor anchor anchor anchor


new NotifyingBucket(this, 'MyNotifyingBucket', { prefix: 'images/' });

Biasanya, Anda juga ingin mengekspos beberapa properti atau metode pada konstruksi Anda. Ini tidak terlalu berguna untuk memiliki topik tersembunyi di balik konstruksi Anda, karena pengguna konstruksi Anda tidak dapat berlangganan ke sana. Menambahkan topic properti memungkinkan konsumen mengakses topik batin, seperti yang ditunjukkan pada contoh berikut:

TypeScript


export class NotifyingBucket extends Construct {
  public readonly topic: sns.Topic;

  constructor(scope: Construct, id: string, props: NotifyingBucketProps) {
    super(scope, id);
    const bucket = new s3.Bucket(this, 'bucket');
    this.topic = new sns.Topic(this, 'topic');
    bucket.addObjectCreatedNotification(new s3notify.SnsDestination(this.topic), { prefix: props.prefix });
  }
}

JavaScript


class NotifyingBucket extends Construct {

  constructor(scope, id, props) {
    super(scope, id);
    const bucket = new s3.Bucket(this, 'bucket');
    this.topic = new sns.Topic(this, 'topic');
    bucket.addObjectCreatedNotification(new s3notify.SnsDestination(this.topic), { prefix: props.prefix });
  }
}

module.exports = { NotifyingBucket };

Python


class NotifyingBucket(Construct):

    def __init__(self, scope: Construct, id: str, *, prefix=None, **kwargs):
        super().__init__(scope, id)
        bucket = s3.Bucket(self, "bucket")
        self.topic = sns.Topic(self, "topic")
        bucket.add_object_created_notification(s3notify.SnsDestination(self.topic),
            s3.NotificationKeyFilter(prefix=prefix))

Java


public class NotifyingBucket extends Construct {

    public Topic topic = null;
    
    public NotifyingBucket(final Construct scope, final String id) {
        this(scope, id, null, null);
    }
    
    public NotifyingBucket(final Construct scope, final String id, final BucketProps props) {
        this(scope, id, props, null);
    }
    
    public NotifyingBucket(final Construct scope, final String id, final String prefix) {
        this(scope, id, null, prefix);
    }

    public NotifyingBucket(final Construct scope, final String id, final BucketProps props, final String prefix) {
        super(scope, id);

        Bucket bucket = new Bucket(this, "bucket");
        topic = new Topic(this, "topic");
        if (prefix != null)
            bucket.addObjectCreatedNotification(new SnsDestination(topic),
                NotificationKeyFilter.builder().prefix(prefix).build());
     }
}

C#


public class NotifyingBucket : Construct
{
    public readonly Topic topic;

    public NotifyingBucket(Construct scope, string id, NotifyingBucketProps props = null) : base(scope, id)
    {
        var bucket = new Bucket(this, "bucket");
        topic = new Topic(this, "topic");
        bucket.AddObjectCreatedNotification(new SnsDestination(topic), new NotificationKeyFilter
        {
            Prefix = props?.Prefix
        });
    }
}

Go

Untuk melakukan ini di Go, kita perlu sedikit pipa tambahan. NewNotifyingBucketFungsi asli kami mengembalikan fileawss3.Bucket. Kita perlu memperluas Bucket untuk menyertakan topic anggota dengan membuat NotifyingBucket struct. Fungsi kita kemudian akan mengembalikan tipe ini.


type NotifyingBucket struct {
	awss3.Bucket
	topic awssns.Topic
}

func NewNotifyingBucket(scope constructs.Construct, id *string, props *NotifyingBucketProps) NotifyingBucket {
	var bucket awss3.Bucket
	if props == nil {
		bucket = awss3.NewBucket(scope, jsii.String(*id+"Bucket"), nil)
	} else {
		bucket = awss3.NewBucket(scope, jsii.String(*id+"Bucket"), &props.BucketProps)
	}
	topic := awssns.NewTopic(scope, jsii.String(*id+"Topic"), nil)
	if props == nil {
		bucket.AddObjectCreatedNotification(awss3notifications.NewSnsDestination(topic))
	} else {
		bucket.AddObjectCreatedNotification(awss3notifications.NewSnsDestination(topic), &awss3.NotificationKeyFilter{
			Prefix: props.Prefix,
		})
	}
	var nbucket NotifyingBucket
	nbucket.Bucket = bucket
	nbucket.topic = topic
	return nbucket
}

anchor anchor anchor anchor anchor anchor


export class NotifyingBucket extends Construct {
  public readonly topic: sns.Topic;

  constructor(scope: Construct, id: string, props: NotifyingBucketProps) {
    super(scope, id);
    const bucket = new s3.Bucket(this, 'bucket');
    this.topic = new sns.Topic(this, 'topic');
    bucket.addObjectCreatedNotification(new s3notify.SnsDestination(this.topic), { prefix: props.prefix });
  }
}

Sekarang, konsumen dapat berlangganan topik, misalnya:

anchor anchor anchor anchor anchor anchor


const queue = new sqs.Queue(this, 'NewImagesQueue');
const images = new NotifyingBucket(this, '/images');
images.topic.addSubscription(new sns_sub.SqsSubscription(queue));

Pelajari selengkapnya

Video berikut memberikan ikhtisar komprehensif tentang konstruksi CDK, dan menjelaskan bagaimana Anda dapat menggunakannya di aplikasi CDK Anda.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Tahapan CDK

Lingkungan

Topik berikutnya:

Lingkungan

Topik sebelumnya:

Tahapan CDK

Perlu bantuan?

Di halaman ini

Apakah halaman ini membantu Anda?

Berikan umpan balik

Privasi Syarat situs Preferensi cookie

Pilih preferensi cookie Anda

Sesuaikan preferensi cookie

Penting

Kinerja

Fungsional

Iklan

Tidak dapat menyimpan preferensi cookie

AWS CDK Membangun

Impor dan gunakan konstruksi

Membangun tingkat

Mendefinisikan konstruksi

Komposisi

Inisialisasi

Konfigurasi

Berinteraksi dengan konstruksi

Aplikasi dan konstruksi tumpukan

Bekerja dengan konstruksi

Bekerja dengan konstruksi L1

penting

Bekerja dengan konstruksi L2

Bekerja dengan konstruksi pihak ketiga

Menulis konstruksi Anda sendiri

catatan

Pelajari selengkapnya

Topik berikutnya:

Topik sebelumnya:

Perlu bantuan?

Di halaman ini

Apakah halaman ini membantu Anda?