如何使用 Python AWS-CDK 将现有资源添加到堆栈?

时间:2021-07-22 14:44:33

标签: python aws-cdk

我尝试使用以下定义进行部署,但出现 ExampleRole already exists 错误。

from aws_cdk import aws_iam as iam
from aws_cdk import core

app = core.App()
stack = core.Stack(app, "MyStack")

existing_role = iam.Role(
    stack,
    id="ExampleRole",
    assumed_by=iam.AccountPrincipal(123456789),
    role_name="ExampleRole",
)
existing_role.apply_removal_policy(core.RemovalPolicy.RETAIN)

app.synth()

仅使用 CDK 的正确步骤是什么?

2 个答案:

答案 0 :(得分:1)

您可以使用 iam.Role.from_role_arn() 通过 ARN 导入现有的 IAM 角色;

existing_role = iam.Role.from_role_arn(
    stack,
    id="ExampleRole",
    role_arn="arn:aws:iam::123456789012:role/......",
)
existing_role.apply_removal_policy(core.RemovalPolicy.RETAIN)

我见过像 SQS from_queue_arn() 这样的函数和类似的函数返回对资源的只读引用的情况,因此您实际上无法使用 CDK 代码修改它;然而,from_role_arn 有一个 mutable=True 参数表示

<块引用>

mutable (Optional[bool]) – 是否可以通过附加策略资源来修改导入的角色。默认值:真

所以我不确定它是否适合你。

答案 1 :(得分:1)

根本原因:您创建了堆栈,但您提取了它之外的角色,因此它是“孤立的”,AWS CDK 应用程序无法理解它应该用它做什么。

这个问题应该分三步解决(自下而上的方法):

  • 项目结构
  • stack.py
  • app.py
  • 部署

我使用的是 CDK v2。

0.1。 项目结构

.
├── app.py
├── cdk.json
├── requirements.txt
├── .gitignore
└── stacks
    ├── stack.py
    └── __init__.py

这是一个基本的项目结构,允许您与 AWS CDK 进行交互。

0.2。 requirements.txt

# CDK v2 update: npm install -g aws-cdk@next

aws-cdk-lib==2.0.0-rc.14
boto3

我添加了 requirements.txt 的内容只是为了确保我们在同一页面上。此外,最好将您的 AWS CDK npm 更新为最新版本。此命令应在 cmd 中运行。

  1. stack.py
import aws_cdk as cdk
from aws_cdk import aws_iam as _iam


class MyNewStack(cdk.Stack):

    def __init__(self, scope, construct_id, **kwargs) -> None:
        super().__init__(scope, construct_id, **kwargs)

        # Fetch existing resources
        role = _iam.Role.from_role_arn(self, "my_existing_role",
                                       role_arn="role_arn_copied_from_webui_as-string", 
                                       mutable=False)

在这里,我们创建了一个堆栈,我们在其中使用 CDK API 列出了我们的所有资源(新的或已经存在的)。下面提供了链接以查看所有可用选项。

  1. app.py
from stacks.Stack import *

# Initializing the CDK app
app = cdk.App()
env = cdk.Environment(account=os.getenv('CDK_DEFAULT_ACCOUNT'), region=os.getenv('CDK_DEFAULT_REGION'))

# Stacks
MyNewStack(app, "stack-name-to-be-displayed-in-cloudformation", env=env)

# Required to get files updated in cdk.out
app.synth()

这里我们初始化 CDK 应用程序并创建我们之前构建的类的实例。

  1. 部署
$cdk ls
$cdk synth
$cdk deploy stack-name-to-be-displayed-in-cloudformation

在部署之前,强烈建议运行 cdk lscdk synthcdk diff 以查看是否一切正常。

请告诉我,以便我可以为您提供更多帮助。希望你觉得它有用。干杯!

对文档和更多的引用:

  1. CDK 简介:https://docs.aws.amazon.com/cdk/latest/guide/home.html
  2. CDK API 参考:https://docs.aws.amazon.com/cdk/api/v2/python/modules.html
  3. 构建项目的更好方法:https://www.sentiatechblog.com/aws-cdk-structure-components
  4. CDK 模式(真实示例):https://cdkpatterns.com/