Python에서 AWS CDK 검증

AWS CDK 애플리케이션 수명 주기에는 공식 문서의 CDK 애플리케이션 종합 장에 설명된 확인 단계가 포함되어 있습니다.

validate 메소드를 구현하는 모든 구성은 자체 검증을 통해 올바른 배포 상태인지 확인할 수 있습니다. 이 단계에서 유효성 검사에 실패하면 알림이 전송됩니다. 일반적으로 검증을 최대한 빨리 수행하고(보통 일부 입력을 얻은 즉시) 최대한 빨리 예외를 발생시키는 것이 좋습니다. 조기에 확인을 수행하면 스택 추적이 더 정확해지고 코드가 안전하게 계속 실행될 수 있으므로 안정성이 향상됩니다.

TypeScript에서 AWS CDK 검증을 처리하는 방법에 대한 훌륭한 기사가 있지만(아래 링크) 해당 Python 예제를 찾을 수 없었습니다. Python에서 몇 가지 유효성 검사를 만든 후 다음 예제는 이 문서의 예제를 보완합니다.

• AWS CDK 구성의 유효성 검사
• 검증을 위해 AWS CDK 사용(addValidation)

다음 예제는 AWS CDK v2.176.0 및 Python 3.13.1을 사용하여 개발되었습니다.

검증 예시

유효성 검사 구현은 오류 메시지 목록을 반환하는 유효성 검사 메서드를 사용하여 수행됩니다. 목록이 비어 있으면 오류가 없습니다. 여러 항목이 이 유효성 검사에 실패한 다양한 유효성 검사에 해당합니다. 유효성 검사 논리는 @jsii.implements(IValidation) 주석이 달린 클래스에 캡슐화되어 유효성 검사에 적합한 유형임을 나타냅니다. 이 예에서는 확인을 위해 전달된 Amazon S3 버킷이 사용자 지정 AWS KMS 키를 사용하는지 확인합니다. 이는 Amazon S3에서 사용하는 기본 암호화에 비해 암호화 프로세스에 대한 더 많은 제어를 제공합니다.

@jsii.implements(IValidation)
class KodlotS3KmsValidator:
    """检查S3存储桶是否使用自定义KMS密钥加密。"""

    def __init__(self, s3_bucket: s3.Bucket):
        self.s3_bucket = s3_bucket

    def validate(self) -> List[str]:
        error_messages: List[str] = []
        if self.s3_bucket.encryption_key is None:
            error_messages.append(f"存储桶必须使用自定义KMS密钥加密")
        return error_messages

AWS CDK 구축 예시

범위 트리에서 생성자 노드의 add_validation 메서드를 사용하여 단일 검증을 추가하는 AWS CDK 구성의 기본 예입니다. 사용자 지정 AWS KMS 키가 생성되었지만 Amazon S3 버킷 구성의 암호화 키 매개 변수로 전달되지 않은 구현 중에 버그가 있었습니다.

class KodlotS3Bucket(Construct):
    """带有验证的S3存储桶。"""

    def __init__(self, scope: Construct, construct_id: str, bucket_name: str) -> None:
        super().__init__(scope, construct_id)

        s3_kms_key = kms.Key(self, f"KodlotS3KmsKey{bucket_name.title()}")
        self.s3_bucket = s3.Bucket(
            self,
            f"KodlotS3{bucket_name.title()}",
            bucket_name=bucket_name,
            encryption_key=None,
        )

        self.node.add_validation(KodlotS3KmsValidator(self.s3_bucket))

이러한 유형의 오류는 쉽게 간과되는데, 여기서 유효성 검사가 중요합니다. 이 예제를 사용하여 CDK 구성 또는 배포를 실행하면 다음 오류가 발생합니다.

<code>RuntimeError: Error: 验证失败，错误如下：
  [KodlotS3Stack/KodlotBucket1] 存储桶必须使用自定义KMS密钥加密</code>

다중 검증

여러 유효성 검사기가 구성의 다양한 측면을 테스트하도록 하는 것이 가능하며, 이와 같은 공통 패턴을 찾으면 다양한 구성에 재사용할 수 있습니다. 이 예에서는 Amazon S3 버킷이 실수로 정적 웹 사이트 호스팅용으로 구성되지 않았는지 확인하기 위해 유효성 검사가 추가되었습니다. 이 경우 오류가 발생합니다.

@jsii.implements(IValidation)
class KodlotS3NotWebsiteValidator:
    """检查S3存储桶未配置为静态网站托管。"""

    def __init__(self, s3_bucket: s3.Bucket):
        self.s3_bucket = s3_bucket

    def validate(self) -> List[str]:
        error_messages: List[str] = []
        if self.s3_bucket.is_website:
            error_messages.append(f"存储桶不能用于静态网站托管")
        return error_messages

업데이트된 AWS CDK 구축 예시

추가 검사기를 사용하여 웹사이트 호스팅이 Amazon S3 버킷에 대해 구성되어 있는지 확인하려면 아래와 같이 샘플 CDK 구성을 업데이트하세요. 이번에는 사용자 지정 AWS KMS 키를 전달하지 않는 원래 오류가 유지됩니다. 또한 이제 website_index_document가 Amazon S3 버킷 구성에 잘못 전달되어 정적 웹 사이트 호스팅에 사용될 것임을 나타냅니다.

@jsii.implements(IValidation)
class KodlotS3KmsValidator:
    """检查S3存储桶是否使用自定义KMS密钥加密。"""

    def __init__(self, s3_bucket: s3.Bucket):
        self.s3_bucket = s3_bucket

    def validate(self) -> List[str]:
        error_messages: List[str] = []
        if self.s3_bucket.encryption_key is None:
            error_messages.append(f"存储桶必须使用自定义KMS密钥加密")
        return error_messages

이번에는 Amazon S3 버킷에 두 가지 다른 문제가 있으며, 둘 다 아래와 같은 확인 메커니즘에 의해 보고됩니다. 이 예제를 사용하여 CDK 구성 또는 배포를 실행하면 다음 오류가 발생합니다.

class KodlotS3Bucket(Construct):
    """带有验证的S3存储桶。"""

    def __init__(self, scope: Construct, construct_id: str, bucket_name: str) -> None:
        super().__init__(scope, construct_id)

        s3_kms_key = kms.Key(self, f"KodlotS3KmsKey{bucket_name.title()}")
        self.s3_bucket = s3.Bucket(
            self,
            f"KodlotS3{bucket_name.title()}",
            bucket_name=bucket_name,
            encryption_key=None,
        )

        self.node.add_validation(KodlotS3KmsValidator(self.s3_bucket))

클라우드 인프라에서 다양한 구성 문제를 수집하여 다시 실행하고 수정할 필요 없이 모두 해결할 수 있다는 점에서 이는 매우 강력합니다.

AWS CDK 스택 확인

검증은 AWS CDK 구성에만 국한되지 않고 AWS CDK 스택 수준에도 추가될 수 있다는 점을 기억할 가치가 있습니다. 예를 들어 여기서는 특정 스택에 원치 않는 리소스가 포함되어 있지 않은지 확인할 수 있습니다. 스택에 AWS Lambda 리소스가 포함되어서는 안 된다는 요구 사항이 있는 경우 아래 설명된 검증을 사용하여 해당 요구 사항을 시뮬레이션할 수 있습니다. 노드 구성의 하위 항목을 사용하면 Python에 내장된 isinstance 함수를 사용하여 리소스가 AWS CDK 함수의 인스턴스인지 확인할 수 있습니다.

<code>RuntimeError: Error: 验证失败，错误如下：
  [KodlotS3Stack/KodlotBucket1] 存储桶必须使用自定义KMS密钥加密</code>

AWS CDK 스택 예시

스택에 유효성 검사를 추가하려면 생성자와 동일한 add_validation 메서드를 사용합니다. KodlotS3Stack은 AWS Lambda 함수를 포함해서는 안 되는 스택으로 식별되므로 예제 스택의 유효성 검사를 테스트하기에 좋은 장소입니다. 개발자가 AWS Lambda 함수 리소스를 정의하는 아래 설명된 것과 같이 개발 중에 오류가 발생하면 확인이 적용됩니다.

@jsii.implements(IValidation)
class KodlotS3NotWebsiteValidator:
    """检查S3存储桶未配置为静态网站托管。"""

    def __init__(self, s3_bucket: s3.Bucket):
        self.s3_bucket = s3_bucket

    def validate(self) -> List[str]:
        error_messages: List[str] = []
        if self.s3_bucket.is_website:
            error_messages.append(f"存储桶不能用于静态网站托管")
        return error_messages

이 예제의 CDK 구성 또는 배포를 실행하면 다음 오류가 발생합니다.

class KodlotS3Bucket(Construct):
    """带有验证的S3存储桶。"""

    def __init__(self, scope: Construct, construct_id: str, bucket_name: str) -> None:
        super().__init__(scope, construct_id)

        s3_kms_key = kms.Key(self, f"KodlotS3KmsKey{bucket_name.title()}")
        self.s3_bucket = s3.Bucket(
            self,
            f"KodlotS3{bucket_name.title()}",
            bucket_name=bucket_name,
            encryption_key=None,
            website_index_document="index.html",
        )

        self.node.add_validation(KodlotS3KmsValidator(self.s3_bucket))
        self.node.add_validation(KodlotS3NotWebsiteValidator(self.s3_bucket))

내장 검증

AWS CDK가 이미 클라우드 인프라의 특정 측면에 대한 검사를 제공하는지 여부도 확인해 볼 가치가 있습니다. Amazon S3의 맥락에서 버킷 이름을 k1로 구성하여 이름 길이가 잘못되면 다음과 같은 내장 오류가 발생하는 것으로 나타났습니다.

<code>RuntimeError: Error: 验证失败，错误如下：
  [KodlotS3Stack/KodlotBucket1] 存储桶必须使用自定义KMS密钥加密
  [KodlotS3Stack/KodlotBucket1] 存储桶不能用于静态网站托管</code>

마찬가지로 버킷 이름을 k_1로 구성하여 잘못된 밑줄 문자가 포함되면 다음 내장 오류가 발생합니다.

@jsii.implements(IValidation)
class KodlotNoLambdaInStackValidator:
    """检查给定堆栈中未定义任何Lambda函数。"""

    def __init__(self, stack: cdk.Stack):
        self.stack = stack

    def validate(self) -> List[str]:
        error_messages: List[str] = []
        for construct in self.stack.node.children:
            if isinstance(construct, _lambda.Function):
                error_messages.append(f"堆栈不能包含任何Lambda函数")
        return error_messages

결론

AWS CDK 검증은 개발자가 단위 및 통합 테스트와 함께 사용하여 클라우드 컴퓨팅 인프라의 전반적인 품질을 보장할 수 있는 유용한 메커니즘입니다. 일반적인 잘못된 구성을 포착하고 표준을 정의할 수 있으면 여러 구성 요소 간에 공유할 수 있는 재사용 가능한 검증이 가능해집니다. AWS CDK 구성 및 AWS CDK 스택을 포함하여 AWS CDK에서 정의한 다양한 수준에서 검증을 추가할 수 있습니다. AWS CDK가 다양한 클라우드 서비스 및 리소스의 기본이고 항상 확인해야 하는 몇 가지 일반적인 검증을 포착하여 프로덕션 환경에서 배포 오류가 발생할 가능성을 줄인 것을 보니 반갑습니다.

코드 블록은 유지되고 이미지는 올바르게 참조됩니다. 전체적인 구조와 의미는 동일하게 유지되지만, 문구는 보다 자연스러운 흐름과 직접적인 반복을 피하기 위해 변경됩니다.

위 내용은 Python에서 AWS CDK 검증의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!