コンストラクトをインポートして使用する構築レベルコンストラクトの定義コンストラクトの使用サードパーティーのコンストラクトの使用詳細

AWS CDK 構築

構築は、 AWS Cloud Development Kit (AWS CDK) アプリケーションの基本的な構成要素です。コンストラクトは、1 つ以上の AWS CloudFormation リソースとその設定を表すアプリケーション内のコンポーネントです。コンストラクトをインポートして設定することで、アプリケーションを個別に構築します。

コンストラクトをインポートして使用する

構築は、AWS 構築ライブラリからCDKアプリケーションにインポートするクラスです。また、独自のコンストラクトを作成および配布したり、サードパーティーのデベロッパーによって作成されたコンストラクトを使用したりできます。

構築は、構築プログラミングモデル () の一部ですCPM。などの他のツールで使用できますCDK。Terraform （CDKtf）、 CDK 用 Kubernetes （CDK8s）、および Projen.

多数のサードパーティーが、と互換性のあるコンストラクトも公開しています AWS CDK。Construct Hub にアクセスして、 AWS CDK 構築パートナーエコシステムを確認してください。

構築レベル

コンストラクトライブラリからのコンストラクトは 3 AWS つのレベルに分類されます。各レベルは、抽象化のレベルを引き上げます。抽象化が高いほど、設定が容易になり、専門知識も少なくなります。抽象化が低いほど、より多くのカスタマイズが可能になり、より多くの専門知識が必要になります。

レベル 1 (L1) コンストラクト

リソースとも呼ばれる L1 コンストラクトは、最下位のコンストラクトであり、抽象化は行いません。 CFN 各 L1 コンストラクトは、単一の AWS CloudFormation リソースに直接マッピングされます。L1 コンストラクトでは、特定の AWS CloudFormation リソースを表すコンストラクトをインポートします。次に、コンストラクトインスタンス内でリソースのプロパティを定義します。

L1 コンストラクトは、 AWS リソースプロパティの定義に精通し AWS CloudFormation ており、完全に制御する必要がある場合に最適です。

構築ライブラリでは、L1 AWS コンストラクトの名前はで始まりCfn、その後にそれが表す AWS CloudFormation リソースの識別子が続きます。例えば、 CfnBucketコンストラクトはリソースを表す L1 コンストラクトですAWS::S3::Bucket AWS CloudFormation 。

L1 コンストラクトは、AWS CloudFormation リソース仕様から生成されます。リソースがに存在する場合 AWS CloudFormation、L1 コンストラクト AWS CDK としてで使用できます。新しいリソースまたはプロパティが AWS 構築ライブラリで利用可能になるまでに最大 1 週間かかる場合があります。詳細については、「ユーザーガイド」のAWS 「リソースタイプとプロパティタイプのリファレンス」を参照してください。 AWS CloudFormation

レベル 2 (L2) コンストラクト

キュレーションされたコンストラクトとも呼ばれる L2 コンストラクトは、CDKチームによって慎重に開発され、通常は最も広く使用されているコンストラクトタイプです。L2 コンストラクトは、L1 コンストラクトと同様に、単一の AWS CloudFormation リソースに直接マッピングされます。L1 コンストラクトと比較して、L2 コンストラクトは直感的なインテントベースのを通じてより高度な抽象化を提供しますAPI。L2 コンストラクトには、賢明なデフォルトプロパティ設定、ベストプラクティスのセキュリティポリシーが含まれ、多くのボイラープレートコードとグルーロジックを生成します。

L2 コンストラクトは、ほとんどのリソースにヘルパーメソッドも提供します。これにより、プロパティ、アクセス許可、リソース間のイベントベースのインタラクションなどをより簡単かつ迅速に定義できます。

s3.Bucket クラスは、Amazon Simple Storage Service (Amazon S3) バケットリソースの L2 コンストラクトの例です。

構築ライブラリには、安定しており、本番稼働用に指定された L2 AWS 構築が含まれています。開発中の L2 コンストラクトは実験的なものとして指定され、別のモジュールで提供されます。

レベル 3 (L3) コンストラクト

パターンとも呼ばれる L3 コンストラクトは、最高レベルの抽象化です。各 L3 コンストラクトには、アプリケーション内の特定のタスクまたはサービスを達成するために連携するように設定されたリソースのコレクションを含めることができます。L3 コンストラクトは、アプリケーション内の特定のユースケースの AWS アーキテクチャ全体を作成するために使用されます。

完全なシステム設計、または大規模なシステムの大部分を提供するために、L3 コンストラクトはオピニオンされたデフォルトプロパティ設定を提供します。これらは、問題を解決し、解決策を提供するための特定のアプローチを中心に構築されています。L3 コンストラクトを使用すると、入力とコードの量を最小限に抑えながら、複数のリソースをすばやく作成して設定できます。

ecsPatterns.ApplicationLoadBalancedFargateService クラスは、Amazon Elastic Container Service (Amazon ECS) クラスターで実行され、アプリケーションロードバランサーが先頭にある AWS Fargate サービスを表す L3 コンストラクトの例です。

L2 コンストラクトと同様に、本番稼働用の準備ができている L3 AWS コンストラクトは、コンストラクトライブラリに含まれています。開発中のものは、別のモジュールで提供されます。

コンストラクトの定義

コンポジション

コンポジションは、コンストラクトを通じて高レベルの抽象化を定義するためのキーパターンです。高レベルのコンストラクトは、任意の数の低レベルのコンストラクトから構成できます。ボトムアップの観点からは、コンストラクトを使用してデプロイする個々の AWS リソースを整理します。必要な数のレベルで、目的に便利な抽象化を使用します。

コンポジションでは、再利用可能なコンポーネントを定義し、他のコードと同様に共有します。例えば、チームは、バックアップ、グローバルレプリケーション、自動スケーリング、モニタリングなど、Amazon DynamoDB テーブルに対する会社のベストプラクティスを実装するコンストラクトを定義できます。チームは、構築を他のチーム社内で共有することも、公開することもできます。

Teams は、他のライブラリパッケージのようなコンストラクトを使用できます。ライブラリが更新されると、デベロッパーは他のコードライブラリと同様に、新しいバージョンの改善とバグ修正にアクセスできます。

初期化

コンストラクトは、Construct 基本クラスを拡張するクラスで実装されます。クラスをインスタンス化してコンストラクトを定義します。すべてのコンストラクトは、初期化時に次の 3 つのパラメータを取ります。

scope – コンストラクトの親または所有者。これはスタックでも別のコンストラクトでもかまいません。スコープは、コンストラクトツリー内のコンストラクトの場所を決定します。通常、 this (self の Python）。これはスコープの現在のオブジェクトを表します。
id – スコープ内で一意識別子と AWS CDKである必要があります。識別子は、コンストラクト内で定義されているすべての名前空間として機能します。リソース名や AWS CloudFormation 論理などの一意の識別子を生成するために使用されますIDs。

識別子は、スコープ内でのみ一意である必要があります。これにより、含まれる可能性のあるコンストラクトと識別子を気にせずにコンストラクトをインスタンス化して再利用でき、コンストラクトを高レベルの抽象化に構成できます。さらに、スコープを使用すると、コンストラクトのグループを一度に参照できます。例としては、にタグ付けしたり、コンストラクトをデプロイする場所を指定したりする場合などがあります。
props – 言語に応じて、コンストラクトの初期設定を定義するプロパティまたはキーワード引数のセット。高レベルのコンストラクトはより多くのデフォルトを提供し、すべての prop 要素がオプションの場合は、props パラメータを完全に省略できます。

構成

ほとんどのコンストラクトは、3 props番目の引数 (または Python ではキーワード引数) として、コンストラクトの設定を定義する名前/値のコレクションを受け入れます。次の例では、 AWS Key Management Service （AWS KMS) 暗号化と静的ウェブサイトホスティングが有効になっているバケットを定義します。暗号化キーを明示的に指定しないため、 Bucket コンストラクトは新しいを定義kms.Keyし、バケットに関連付けます。

コンストラクトの操作

コンストラクトは、ベースコンストラクトクラスを拡張するクラスです。コンストラクトをインスタンス化すると、コンストラクトオブジェクトは一連のメソッドとプロパティを公開します。これにより、コンストラクトを操作し、システムの他の部分への参照として渡すことができます。

AWS CDK フレームワークは、コンストラクトAPIsのに制限を加えません。作成者は、任意のAPIものを定義できます。ただし、などの AWS コンストラクトライブラリに含まれているコンストラクト AWS はs3.Bucket、ガイドラインと一般的なパターンに従います。これにより、すべての AWS リソースで一貫したエクスペリエンスが得られます。

ほとんどの AWS コンストラクトには、そのコンストラクトに対する AWS Identity and Access Management （IAM) アクセス許可をプリンシパルに付与するために使用できる一連の付与メソッドがあります。次の例では、Amazon S3 バケットから読み取るアクセスdata-science許可をIAMグループに付与しますraw-data。

もう 1 つの一般的なパターンは、 AWS コンストラクトが他の場所で提供されたデータからリソースの属性の 1 つを設定することです。属性には、Amazon リソースネーム (ARNs）、名前、またはを含めることができますURLs。

次のコードは、 AWS Lambda 関数を定義し、環境変数URLのキューを介して Amazon Simple Queue Service (Amazon SQS) キューに関連付けます。

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()),
		},
	})

AWS 構築ライブラリの最も一般的なAPIパターンについては、「」を参照してくださいリソースと AWS CDK。

アプリケーションとスタックの構造

AWS コンストラクトライブラリの Appおよび Stack クラスは一意のコンストラクトです。他のコンストラクトと比較して、リソース AWS は独自に設定されません。代わりに、他のコンストラクトのコンテキストを提供するために使用されます。リソースを表す AWS すべてのコンストラクトは、直接または間接的に、Stackコンストラクトの範囲内で定義する必要があります。 Stack コンストラクトはApp、コンストラクトの範囲内で定義されます。

CDK アプリケーションの詳細については、「」を参照してくださいAWS CDK アプリ。CDK スタックの詳細については、「」を参照してくださいAWS CDK スタック。

次の例では、単一のスタックを持つアプリケーションを定義します。スタック内では、L2 コンストラクトを使用して 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

HelloCdkStack.java ファイルで定義されるスタック：


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

HelloCdkApp.java ファイルで定義されるアプリケーション：


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
}

コンストラクトの使用

L1 コンストラクトの使用

L1 コンストラクトは個々の AWS CloudFormation リソースに直接マッピングされます。リソースに必要な設定を指定する必要があります。

この例では、L1 CfnBucket コンストラクトを使用してbucketオブジェクトを作成します。

単純なブール語、文字列、数値、コンテナではないコンストラクトプロパティは、サポートされている言語で異なる方法で処理されます。

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

Python では、これらのプロパティは L1 コンストラクトの内部クラスとして定義されたタイプで表されます。例えば、のオプションプロパティにはタイプのラッパーcors_configurationCfnBucketが必要ですCfnBucket.CorsConfigurationProperty。ここでは、CfnBucketインスタンスcors_configurationでを定義します。


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

Java では、これらのプロパティは L1 コンストラクトの内部クラスとして定義されたタイプで表されます。例えば、のオプションプロパティにはタイプのラッパーcorsConfigurationCfnBucketが必要ですCfnBucket.CorsConfigurationProperty。ここでは、CfnBucketインスタンスcorsConfigurationでを定義します。


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#

C# では、これらのプロパティは L1 コンストラクトの内部クラスとして定義される型で表されます。例えば、のオプションプロパティにはタイプのラッパーCorsConfigurationCfnBucketが必要ですCfnBucket.CorsConfigurationProperty。ここでは、CfnBucketインスタンスCorsConfigurationでを定義します。


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

Go では、これらのタイプは L1 コンストラクトの名前、アンダースコア、プロパティ名を使用して名前が付けられます。例えば、のオプションプロパティにはタイプのラッパーCorsConfigurationCfnBucketが必要ですCfnBucket_CorsConfigurationProperty。ここでは、CfnBucketインスタンスCorsConfigurationでを定義します。


	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"},
				},
			},
		},
	})

重要

L1 コンストラクトで L2 プロパティタイプを使用することはできません。またはその逆も同様です。 L1 L1 コンストラクトを使用する場合は、使用している L1 コンストラクトに定義されているタイプを必ず使用してください。他の L1 コンストラクトの型を使用しないでください (名前が同じものもありますが、同じ型ではありません）。

言語固有のAPIリファレンスの中には、現在 L1 プロパティタイプへのパスにエラーがあるか、これらのクラスをまったく文書化していないものがあります。近いうちにこれを修正したいと考えています。その間、このようなタイプは常に、それらが使用される L1 コンストラクトの内部クラスであることに注意してください。

L2 コンストラクトの使用

次の例では、L2 コンストラクトからオブジェクトを作成して Amazon S3 Bucket バケットを定義します。

MyFirstBucket は、が AWS CloudFormation 作成するバケットの名前ではありません。これは、CDKアプリケーションのコンテキスト内で新しいコンストラクトに与えられる論理識別子です。physicalName 値はリソースに名前を付けるために使用されます AWS CloudFormation 。

サードパーティーのコンストラクトの使用

Construct Hub は、 AWS、サードパーティー、オープンソースCDKコミュニティから追加のコンストラクトを発見するのに役立つリソースです。

独自のコンストラクトの作成

既存のコンストラクトを使用するだけでなく、独自のコンストラクトを記述し、誰でもアプリで使用できるようにすることもできます。すべてのコンストラクトはで等しくなります AWS CDK。コンストラクトライブラリからの AWS コンストラクトは、を介して公開されたサードパーティーライブラリからのコンストラクトと同様に扱われます。NPM, Maven、または PyPI。社内のパッケージリポジトリに公開されたコンストラクトも同じように扱われます。

新しいコンストラクトを宣言するには、Construct ベースクラスを拡張するクラスを constructsパッケージで作成し、初期化引数のパターンに従います。

次の例は、Amazon S3 バケットを表すコンストラクトを宣言する方法を示しています。S3 バケットは、誰かがファイルをアップロードするたびに Amazon Simple Notification Service (Amazon SNS) 通知を送信します。

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
}

注記

NotifyingBucket コンストラクトはからではなくBucket、から継承しますConstruct。継承ではなく構成を使用して、Amazon S3 バケットと Amazon SNSトピックをバンドルしています。一般的に、 AWS CDK コンストラクトを開発する場合、コンポジションは継承よりも優先されます。

NotifyingBucket コンストラクターには、一般的なコンストラクト署名 scope、id、およびがありますprops。最後の引数はオプションです (デフォルト値を取得{}）。これはprops、すべての props がオプションであるためです。（ベースConstructクラスはprops引数を取りません）。このコンストラクトのインスタンスは、なしでアプリで定義できます。例えばprops、

または、 props (Java では追加のパラメータ) を使用して、フィルタリングするパスプレフィックスを指定できます。例えば、

通常、コンストラクト上のいくつかのプロパティまたはメソッドも公開する必要があります。コンストラクトのユーザーはサブスクライブできないため、コンストラクトの背後にトピックを非表示にすることはあまり役に立ちません。topic プロパティを追加すると、次の例に示すように、コンシューマーは内部トピックにアクセスできます。

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

Go でこれを行うには、少し追加の配管が必要です。元のNewNotifyingBucket関数はを返しましたawss3.Bucket。NotifyingBucket 構造体を作成してtopic、メンバーを含めるBucketように拡張する必要があります。その後、関数はこのタイプを返します。


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
}

これで、コンシューマーはトピックをサブスクライブできるようになりました。例えば、

詳細

次のビデオでは、CDKコンストラクトの包括的な概要と、アプリケーションで使用する方法について説明しますCDK。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

スタック

環境