搜尋
首頁後端開發Python教學Python 中的 AWS CDK 驗證

AWS CDK Validation in Python

AWS CDK應用生命週期中包含驗證步驟,官方文件的CDK應用合成章節對此進行了說明:

所有已實作validate方法的建構都可以進行自驗證,以確保其處於可正確部署的狀態。此階段發生的任何驗證失敗都會通知您。通常,我們建議盡快執行驗證(通常是在獲得某些輸入後立即執行),並儘快拋出異常。儘早執行驗證可以提高可靠性,因為堆疊追蹤將更準確,並確保您的程式碼可以安全地繼續執行。

雖然有一些優秀的文章介紹瞭如何在TypeScript中處理AWS CDK驗證(連結如下),但我找不到對應的Python範例。在Python中創建了一些驗證之後,以下範例是這些文章中範例的補充。

  • AWS CDK構造中的驗證檢查
  • 使用AWS CDK進行驗證(addValidation)

以下範例使用AWS CDK v2.176.0和Python 3.13.1開發。

範例驗證

驗證的實作是使用傳回錯誤訊息清單的validate方法完成的。如果清單為空,則沒有錯誤;多個條目對應於此驗證失敗的不同驗證檢查。驗證邏輯封裝在一個用@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構造範例

這是一個AWS CDK建構的基本範例,它使用建構節點在作用域樹中的add_validation方法來新增單一驗證。在實作過程中出現了一個錯誤,其中建立了自訂AWS KMS金鑰,但未將其傳遞給Amazon S3儲存桶建構的encryption_key參數。

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已經捕獲了一些常見的驗證,因為它們是各種雲端服務和資源的基礎,應該始終進行檢查,從而減少在生產環境中遇到部署錯誤的可能性。

The code blocks are preserved and the image is referenced correctly. The overall structure and meaning remain the same, while the wording is altered for a more natural flow and to avoid direct repetition.

以上是Python 中的 AWS CDK 驗證的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
Python vs. C:了解關鍵差異Python vs. C:了解關鍵差異Apr 21, 2025 am 12:18 AM

Python和C 各有優勢,選擇應基於項目需求。 1)Python適合快速開發和數據處理,因其簡潔語法和動態類型。 2)C 適用於高性能和系統編程,因其靜態類型和手動內存管理。

Python vs.C:您的項目選擇哪種語言?Python vs.C:您的項目選擇哪種語言?Apr 21, 2025 am 12:17 AM

選擇Python還是C 取決於項目需求:1)如果需要快速開發、數據處理和原型設計,選擇Python;2)如果需要高性能、低延遲和接近硬件的控制,選擇C 。

達到python目標:每天2小時的力量達到python目標:每天2小時的力量Apr 20, 2025 am 12:21 AM

通過每天投入2小時的Python學習,可以有效提升編程技能。 1.學習新知識:閱讀文檔或觀看教程。 2.實踐:編寫代碼和完成練習。 3.複習:鞏固所學內容。 4.項目實踐:應用所學於實際項目中。這樣的結構化學習計劃能幫助你係統掌握Python並實現職業目標。

最大化2小時:有效的Python學習策略最大化2小時:有效的Python學習策略Apr 20, 2025 am 12:20 AM

在兩小時內高效學習Python的方法包括:1.回顧基礎知識,確保熟悉Python的安裝和基本語法;2.理解Python的核心概念,如變量、列表、函數等;3.通過使用示例掌握基本和高級用法;4.學習常見錯誤與調試技巧;5.應用性能優化與最佳實踐,如使用列表推導式和遵循PEP8風格指南。

在Python和C之間進行選擇:適合您的語言在Python和C之間進行選擇:適合您的語言Apr 20, 2025 am 12:20 AM

Python適合初學者和數據科學,C 適用於系統編程和遊戲開發。 1.Python簡潔易用,適用於數據科學和Web開發。 2.C 提供高性能和控制力,適用於遊戲開發和系統編程。選擇應基於項目需求和個人興趣。

Python與C:編程語言的比較分析Python與C:編程語言的比較分析Apr 20, 2025 am 12:14 AM

Python更適合數據科學和快速開發,C 更適合高性能和系統編程。 1.Python語法簡潔,易於學習,適用於數據處理和科學計算。 2.C 語法複雜,但性能優越,常用於遊戲開發和系統編程。

每天2小時:Python學習的潛力每天2小時:Python學習的潛力Apr 20, 2025 am 12:14 AM

每天投入兩小時學習Python是可行的。 1.學習新知識:用一小時學習新概念,如列表和字典。 2.實踐和練習:用一小時進行編程練習,如編寫小程序。通過合理規劃和堅持不懈,你可以在短時間內掌握Python的核心概念。

Python與C:學習曲線和易用性Python與C:學習曲線和易用性Apr 19, 2025 am 12:20 AM

Python更易學且易用,C 則更強大但複雜。 1.Python語法簡潔,適合初學者,動態類型和自動內存管理使其易用,但可能導致運行時錯誤。 2.C 提供低級控制和高級特性,適合高性能應用,但學習門檻高,需手動管理內存和類型安全。

See all articles

熱AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智慧驅動的應用程序,用於創建逼真的裸體照片

AI Clothes Remover

AI Clothes Remover

用於從照片中去除衣服的線上人工智慧工具。

Undress AI Tool

Undress AI Tool

免費脫衣圖片

Clothoff.io

Clothoff.io

AI脫衣器

Video Face Swap

Video Face Swap

使用我們完全免費的人工智慧換臉工具,輕鬆在任何影片中換臉!

熱工具

EditPlus 中文破解版

EditPlus 中文破解版

體積小,語法高亮,不支援程式碼提示功能

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

強大的PHP整合開發環境

DVWA

DVWA

Damn Vulnerable Web App (DVWA) 是一個PHP/MySQL的Web應用程序,非常容易受到攻擊。它的主要目標是成為安全專業人員在合法環境中測試自己的技能和工具的輔助工具,幫助Web開發人員更好地理解保護網路應用程式的過程,並幫助教師/學生在課堂環境中教授/學習Web應用程式安全性。 DVWA的目標是透過簡單直接的介面練習一些最常見的Web漏洞,難度各不相同。請注意,該軟體中

MantisBT

MantisBT

Mantis是一個易於部署的基於Web的缺陷追蹤工具,用於幫助產品缺陷追蹤。它需要PHP、MySQL和一個Web伺服器。請查看我們的演示和託管服務。

mPDF

mPDF

mPDF是一個PHP庫,可以從UTF-8編碼的HTML產生PDF檔案。原作者Ian Back編寫mPDF以從他的網站上「即時」輸出PDF文件,並處理不同的語言。與原始腳本如HTML2FPDF相比,它的速度較慢,並且在使用Unicode字體時產生的檔案較大,但支援CSS樣式等,並進行了大量增強。支援幾乎所有語言,包括RTL(阿拉伯語和希伯來語)和CJK(中日韓)。支援嵌套的區塊級元素(如P、DIV),