サポートされているプログラミング言語で AWS CDK の の操作

TypeScript では、名前空間全体、または名前空間からの個々のオブジェクトのインポートがサポートされています。各名前空間には、特定の AWS サービスで使用するコンストラクトやその他のクラスが含まれます。

// Import main CDK library as cdk
import * as cdk from 'aws-cdk-lib';   // ES6 import preferred in TS
const cdk = require('aws-cdk-lib');   // Node.js require() preferred in JS

// Import specific core CDK classes
import { Stack, App } from 'aws-cdk-lib';
const { Stack, App } = require('aws-cdk-lib');

// Import AWS S3 namespace as s3 into current namespace
import { aws_s3 as s3 } from 'aws-cdk-lib';   // TypeScript
const s3 = require('aws-cdk-lib/aws-s3');     // JavaScript

// Having imported cdk already as above, this is also valid
const s3 = cdk.aws_s3;

// Now use s3 to access the S3 types
const bucket = s3.Bucket(...);

// Selective import of s3.Bucket
import { Bucket } from 'aws-cdk-lib/aws-s3';        // TypeScript
const { Bucket } = require('aws-cdk-lib/aws-s3');   // JavaScript

// Now use Bucket to instantiate an S3 bucket
const bucket = Bucket(...);

と同様に TypeScript、Python は名前空間モジュールのインポートと選択的インポートをサポートしています。Python の名前空間は aws_cdk.xxx のようになります。xxx は Amazon S3 の s3 などの AWS サービス名を表します。（これらの例では Amazon S3 を使用しています）。

# Import main CDK library as cdk
import aws_cdk as cdk

# Selective import of specific core classes
from aws_cdk import Stack, App
            
# Import entire module as s3 into current namespace
import aws_cdk.aws_s3 as s3

# s3 can now be used to access classes it contains
bucket = s3.Bucket(...)

# Selective import of s3.Bucket into current namespace
from aws_cdk.s3 import Bucket

# Bucket can now be used to instantiate a bucket
bucket = Bucket(...)

Java のインポートは、 TypeScriptのインポートとは動作が異なります。各インポートステートメントは、特定のパッケージから単一のクラス名、またはそのパッケージで定義されているすべてのクラスをインポートします ( を使用*）。クラスには、インポートされている場合はクラス名自体、またはそのパッケージを含む修飾クラス名を使用してアクセスできます。

ライブラリは AWS 、 コンストラクトライブラリsoftware.amazon.awscdk.services.xxxの のように名前が付けられています (メインライブラリは ですsoftware.amazon.awscdk）。 AWS CDK パッケージの Maven グループ ID は ですsoftware.amazon.awscdk。

// Make certain core classes available
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.App;

// Make all Amazon S3 construct library classes available
import software.amazon.awscdk.services.s3.*;

// Make only Bucket and EventType classes available
import software.amazon.awscdk.services.s3.Bucket;
import software.amazon.awscdk.services.s3.EventType;

// An imported class may now be accessed using the simple class name (assuming that name
// does not conflict with another class)
Bucket bucket = Bucket.Builder.create(...).build();

// We can always use the qualified name of a class (including its package) even without an
// import directive
software.amazon.awscdk.services.s3.Bucket bucket = 
    software.amazon.awscdk.services.s3.Bucket.Builder.create(...)
        .build();
          
// Java 10 or later can use var keyword to avoid typing the type twice
var bucket = 
    software.amazon.awscdk.services.s3.Bucket.Builder.create(...)
        .build();

C# では、 using ディレクティブを使用してタイプをインポートします。2 つのスタイルがあります。1 つの では、プレーン名を使用して、指定された名前空間のすべてのタイプにアクセスできます。もう 1 つは、エイリアスを使用して名前空間自体を参照できます。

パッケージの名前は AWS 、 構成ライブラリパッケージAmazon.CDK.AWS.xxxの のような名前です。（コアモジュールは ですAmazon.CDK。）

// Make CDK base classes available under cdk
using cdk = Amazon.CDK;

// Make all Amazon S3 construct library classes available
using Amazon.CDK.AWS.S3;

// Now we can access any S3 type using its name
var bucket = new Bucket(...);

// Import the S3 namespace under an alias
using s3 = Amazon.CDK.AWS.S3;

// Now we can access an S3 type through the namespace alias
var bucket = new s3.Bucket(...);

// We can always use the qualified name of a type (including its namespace) even without a
// using directive
var bucket = new Amazon.CDK.AWS.S3.Bucket(...)

各 AWS Construct Library モジュールは Go パッケージとして提供されます。

import (
    "github.com/aws/aws-cdk-go/awscdk/v2"           // CDK core package
    "github.com/aws/aws-cdk-go/awscdk/v2/awss3"     // AWS S3 construct library module
)

// now instantiate a bucket
bucket := awss3.NewBucket(...)

// use aliases for brevity/clarity
import (
    cdk "github.com/aws/aws-cdk-go/awscdk/v2"           // CDK core package
    s3  "github.com/aws/aws-cdk-go/awscdk/v2/awss3"     // AWS S3 construct library module
)

bucket := s3.NewBucket(...)

// Instantiate default Bucket
const bucket = new s3.Bucket(this, 'MyBucket');

// Instantiate Bucket with bucketName and versioned properties
const bucket = new s3.Bucket(this, 'MyBucket', {
  bucketName: 'my-bucket',
   versioned: true,
});

// Instantiate Bucket with websiteRedirect, which has its own sub-properties
const bucket = new s3.Bucket(this, 'MyBucket', {
  websiteRedirect: {host: 'aws.amazon.com'}});

Python は、クラスのインスタンス化時にnewキーワードを使用しません。properties 引数はキーワード引数を使用して表され、引数は を使用して名前が付けられますsnake_case。

props 値がそれ自体が属性のバンドルである場合、サブプロパティのキーワード引数を受け入れる プロパティにちなんだ という名前のクラスによって表されます。

Python では、現在のインスタンスは、規則selfによって名前が付けられた最初の引数として メソッドに渡されます。

# Instantiate default Bucket
bucket = s3.Bucket(self, "MyBucket")

# Instantiate Bucket with bucket_name and versioned properties
bucket = s3.Bucket(self, "MyBucket", bucket_name="my-bucket", versioned=true)

# Instantiate Bucket with website_redirect, which has its own sub-properties
bucket = s3.Bucket(self, "MyBucket", website_redirect=s3.WebsiteRedirect(
            host_name="aws.amazon.com"))

Java では、props 引数は という名前のクラスで表されます XxxxProps (たとえば、Bucketコンストラクトのprops BucketPropsの場合は )。props 引数は、ビルダーパターンを使用して構築します。

各XxxxPropsクラスにはビルダーがあります。また、次の例に示すように、1 つのステップで props と コンストラクトを構築する各コンストラクトに便利なビルダーもあります。

Props の名前は、 を使用して TypeScriptと同じですcamelCase。

// Instantiate default Bucket
Bucket bucket = Bucket(self, "MyBucket");

// Instantiate Bucket with bucketName and versioned properties
Bucket bucket = Bucket.Builder.create(self, "MyBucket")
                      .bucketName("my-bucket").versioned(true)
                      .build();

# Instantiate Bucket with websiteRedirect, which has its own sub-properties
Bucket bucket = Bucket.Builder.create(self, "MyBucket")
                      .websiteRedirect(new websiteRedirect.Builder()
                          .hostName("aws.amazon.com").build())
                      .build();

C# では、props は という名前のクラスへのオブジェクトイニシャライザを使用して指定されます XxxxProps (たとえば、Bucketコンストラクトのprops BucketPropsの場合）。

Props の名前は、 を使用する場合を除き TypeScript、 と似ていますPascalCase。

コンストラクトをインスタンス化するときに varキーワードを使用する方が便利なため、クラス名を 2 回入力する必要はありません。ただし、ローカルコードスタイルガイドは異なる場合があります。

// Instantiate default Bucket
var bucket = Bucket(self, "MyBucket");

// Instantiate Bucket with BucketName and Versioned properties
var bucket =  Bucket(self, "MyBucket", new BucketProps {
                      BucketName = "my-bucket",
                      Versioned  = true});

// Instantiate Bucket with WebsiteRedirect, which has its own sub-properties
var bucket = Bucket(self, "MyBucket", new BucketProps {
                      WebsiteRedirect = new WebsiteRedirect {
                              HostName = "aws.amazon.com"
                      }});

Go でコンストラクトを作成するには、 関数を呼び出します。NewXxxxxxここで、 Xxxxxxxはコンストラクトの名前です。コンストラクトのプロパティは構造体として定義されます。

Go では、数値、ブール値、文字列などの値を含むすべてのコンストラクトパラメータがポインタです。などの便利な関数jsii.Stringを使用して、これらのポインタを作成します。

	// Instantiate default Bucket
	bucket := awss3.NewBucket(stack, jsii.String("MyBucket"), nil)

	// Instantiate Bucket with BucketName and Versioned properties
	bucket1 := awss3.NewBucket(stack, jsii.String("MyBucket"), &awss3.BucketProps{
		BucketName: jsii.String("my-bucket"),
		Versioned:  jsii.Bool(true),
	})

	// Instantiate Bucket with WebsiteRedirect, which has its own sub-properties
	bucket2 := awss3.NewBucket(stack, jsii.String("MyBucket"), &awss3.BucketProps{
		WebsiteRedirect: &awss3.RedirectTarget{
			HostName: jsii.String("aws.amazon.com"),
		}})

名前は ですcamelCase。

bucket.bucketArn

名前は ですsnake_case。

bucket.bucket_arn

プロパティごとに getter メソッドが用意されています。これらの名前は ですcamelCase。

bucket.getBucketArn()

名前は ですPascalCase。

bucket.BucketArn

名前は ですPascalCase。

bucket.BucketArn

import { IAspect, IConstruct } from 'aws-cdk-lib';

class MyAspect implements IAspect {
  public visit(node: IConstruct) {
    console.log('Visited', node.node.path);
  }
}

Python にはインターフェイス機能はありません。ただし、 では AWS CDK 、クラスを で修飾することで、インターフェイスの実装を示すことができます@jsii.implements(interface)。

from aws_cdk import IAspect, IConstruct
import jsii

@jsii.implements(IAspect)
class MyAspect():
  def visit(self, node: IConstruct) -> None:
    print("Visited", node.node.path)

import software.amazon.awscdk.IAspect;
import software.amazon.awscdk.IConstruct;

public class MyAspect implements IAspect {
    public void visit(IConstruct node) {
        System.out.format("Visited %s", node.getNode().getPath());
    }
}

using Amazon.CDK;

public class MyAspect : IAspect
{
    public void Visit(IConstruct node)
    {
        System.Console.WriteLine($"Visited ${node.Node.Path}");
    }
}

Go 構造体は、実装するインターフェイスを明示的に宣言する必要はありません。Go コンパイラは、 構造で使用できるメソッドとプロパティに基づいて実装を決定します。例えば、次のコードでは、 は コンストラクトを使用するVisitメソッドを提供するため、 IAspectインターフェイスMyAspectを実装しています。

type MyAspect struct {
}

func (a MyAspect) Visit(node constructs.IConstruct) {
	fmt.Println("Visited", *node.Node().Path())
}