側面 - AWS Cloud Development Kit (AWS CDK) v2
アスペクトの詳細例

これはAWS CDK v2 開発者ガイドです。古いCDK v1は2022年6月1日にメンテナンスを開始し、今後は重大なバグ修正とセキュリティパッチのみが提供されます。新機能はCDK v2専用に開発されます。CDK v1 Support は、2023 年 6 月 1 日に完全に終了します。

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

側面

アスペクトは、特定のスコープ内のすべての構成に操作を適用する方法です。このアスペクトは、タグを追加するなどして構成を変更する可能性があります。あるいは、すべてのバケットが暗号化されていることを確認するなど、構成の状態について何かを検証することもできます。

同じスコープ内の構成とすべての構成にアスペクトを適用するには、次の例に示すように、Aspects.of(SCOPE).add()新しいアスペクトを使用してを呼び出します。

TypeScript
Aspects.of(myConstruct).add(new SomeAspect(...));
JavaScript
Aspects.of(myConstruct).add(new SomeAspect(...));
Python
Aspects.of(my_construct).add(SomeAspect(...))
Java
Aspects.of(myConstruct).add(new SomeAspect(...));
C#
Aspects.Of(myConstruct).add(new SomeAspect(...));

AWS CDKはアスペクトを使用してリソースにタグを付けますが、フレームワークは他の目的にも使用できます。たとえば、これを使用して、AWS CloudFormation上位レベルの構成によって自動的に定義されているリソースを検証または変更できます。

アスペクトの詳細

アスペクトはビジターパターンを採用しています。アスペクトは、以下のインターフェースを実装するクラスです。

TypeScript
interface IAspect {
   visit(node: IConstruct): void;}
JavaScript

JavaScript 言語機能としてのインターフェースはありません。したがって、アスペクトとは、visit操作対象のノードを受け入れるメソッドを持つクラスのインスタンスにすぎません。

Python

Python には言語機能としてのインターフェースはありません。したがって、アスペクトとは、visit操作対象のノードを受け入れるメソッドを持つクラスのインスタンスにすぎません。

Java
public interface IAspect {
    public void visit(Construct node);
}
C#
public interface IAspect
{
    void Visit(IConstruct node);
}

呼び出すとAspects.of(SCOPE).add(...)、コンストラクトはアスペクトの内部リストにアスペクトを追加します。リストは次の方法で取得できますAspects.of(SCOPE)。

準備段階では、AWS CDKvisitは構成とその各子オブジェクトのメソッドをトップダウン順に呼び出します。

visitメソッドは、コンストラクト内の内容を変更できるようになります。厳密に型指定された言語では、受信した構造をより具体的な型にキャストしてから、構造固有のプロパティまたはメソッドにアクセスします。

Stagesアスペクトは自己完結型であり、定義後は変更できないため、Stage構成の境界を越えて伝播することはありません。Stage内部の構成にアクセスしてもらいたい場合は、構成自体 (またはそれ以下) にアスペクトを適用しますStage。

例

次の例では、スタックに作成されたすべてのバケットでバージョニングが有効になっていることを検証します。このアスペクトは、検証に失敗した構成にエラー注釈を追加します。その結果、synth操作が失敗し、作成されたクラウドアセンブリをデプロイできなくなります。

TypeScript
class BucketVersioningChecker implements IAspect {
  public visit(node: IConstruct): void {
    // See that we're dealing with a CfnBucket
    if (node instanceof s3.CfnBucket) {

      // Check for versioning property, exclude the case where the property
      // can be a token (IResolvable).
      if (!node.versioningConfiguration
        || (!Tokenization.isResolvable(node.versioningConfiguration)
            && node.versioningConfiguration.status !== 'Enabled') {
        Annotations.of(node).addError('Bucket versioning is not enabled');
      }
    }
  }
}

// Later, apply to the stack
Aspects.of(stack).add(new BucketVersioningChecker());
JavaScript
class BucketVersioningChecker {
   visit(node) {
    // See that we're dealing with a CfnBucket
    if ( node instanceof s3.CfnBucket) {

      // Check for versioning property, exclude the case where the property
      // can be a token (IResolvable).
      if (!node.versioningConfiguration
        || !Tokenization.isResolvable(node.versioningConfiguration)
            && node.versioningConfiguration.status !== 'Enabled') {
        Annotations.of(node).addError('Bucket versioning is not enabled');
      }
    }
  }
}

// Later, apply to the stack
Aspects.of(stack).add(new BucketVersioningChecker());
Python
@jsii.implements(cdk.IAspect)
class BucketVersioningChecker:

  def visit(self, node):
    # See that we're dealing with a CfnBucket
    if isinstance(node, s3.CfnBucket):

      # Check for versioning property, exclude the case where the property
      # can be a token (IResolvable).
      if (not node.versioning_configuration or
              not Tokenization.is_resolvable(node.versioning_configuration)
                  and node.versioning_configuration.status != "Enabled"):
          Annotations.of(node).add_error('Bucket versioning is not enabled')

# Later, apply to the stack
Aspects.of(stack).add(BucketVersioningChecker())
Java
public class BucketVersioningChecker implements IAspect
{
    @Override
    public void visit(Construct node)
    {
        // See that we're dealing with a CfnBucket
        if (node instanceof CfnBucket)
        {
            CfnBucket bucket = (CfnBucket)node;
            Object versioningConfiguration = bucket.getVersioningConfiguration();
            if (versioningConfiguration == null ||
                    !Tokenization.isResolvable(versioningConfiguration.toString()) &&
                    !versioningConfiguration.toString().contains("Enabled"))
                Annotations.of(bucket.getNode()).addError("Bucket versioning is not enabled");
        }
    }
}


// Later, apply to the stack
Aspects.of(stack).add(new BucketVersioningChecker());
C#
class BucketVersioningChecker : Amazon.Jsii.Runtime.Deputy.DeputyBase, IAspect
{
    public void Visit(IConstruct node)
    {
        // See that we're dealing with a CfnBucket
        if (node is CfnBucket)
        {
            var bucket = (CfnBucket)node;
            if (bucket.VersioningConfiguration is null ||
                    !Tokenization.IsResolvable(bucket.VersioningConfiguration) &&
                    !bucket.VersioningConfiguration.ToString().Contains("Enabled"))
                Annotations.Of(bucket.Node).AddError("Bucket versioning is not enabled");
        }
    }
}

// Later, apply to the stack
Aspects.Of(stack).add(new BucketVersioningChecker());