cottonformation 0.0.8

欢迎来到棉花形成文档

完整的文档在这里

Cottonformation是一个 Python 工具，提供最佳的开发体验和最高的生产力。由现代类型提示、高级自动完成、参数提示、即时官方 AWS 文档查找提供支持。这是它在PyCharm中的样子（开箱即用的 PyCharm 支持，但您可以通过在 VSCode、Sublime、Atom 中安装扩展程序或插件来配置它）。

1. 类型提示和属性提示：告诉您哪些属性可用，类型是什么，并自动为您完成代码。rp前缀代表Required Property，p prefix 代表Optional Property，您可以使用 UP 和 DOWN 键导航属性。您还可以查看可用的属性和类型 (Cmd + P)，请参阅查看参数信息。

2. 返回值提示：告诉您可用的返回值，并让您无需查找 AWS 文档即可立即访问它。您无需记住任何 API。老实说，在https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html中查找确切的资源属性名称，然后GetAtt(resource_object, attribute_name)是真的很丑！

3. 参数提示：告诉你所有可用的参数及其类型（Cmd + P）。它适用于资源类型和复杂的属性类型。

4. 跳转到资源文档：立即在 Web 浏览器中打开有关此 AWS 资源的 AWS 文档。单击类，按 F1 并单击链接。

5. 跳转到属性文档方法 1：立即在 Web 浏览器中打开有关此资源属性的 AWS 文档。单击类，按 F1（查看文档字符串），找到属性并单击链接。

6. 跳转到属性文档方法2 ：使用resource_object.property_name语法引用资源属性，单击属性，按F1（查看文档字符串），然后单击链接。

7. 跳转到返回值文档：使用resource_object.attribute_name语法引用资源属性，单击属性，按 F1（查看文档字符串），然后单击链接。

作为代码脚本的示例基础架构可能如下所示。您可以立即从 Python 部署它：

# -*- coding: utf-8 -*-

# First, import cottonformation, I prefer to use ctf for a short name
import cottonformation as cf

# import the aws service module you need
from cottonformation.res import iam, awslambda

# create a ``Template`` object to represent your cloudformation template
tpl = cf.Template()

# create a ``Parameter`` object, and add it to template.
param_env_name = cf.Parameter(
    "EnvName",
    Type=cf.Parameter.TypeEnum.String,
)
tpl.add(param_env_name)

# create a ``Resource`` object for aws iam role
iam_role_for_lambda = iam.Role(
    "IamRoleForLambdaExecution",
    # you don't need to remember the exact name or syntax for
    # trusted entity / assume role policy, cottonformation has a helper for this
    rp_AssumeRolePolicyDocument=cf.helpers.iam.AssumeRolePolicyBuilder(
        cf.helpers.iam.ServicePrincipal.awslambda()
    ).build(),
    p_RoleName=cf.Sub("${EnvName}-iam-role-for-lambda", dict(EnvName=param_env_name.ref())),
    p_Description="Minimal iam role for lambda execution",
    # you don't need to remember the exact ARN for aws managed policy.
    # cottonformation has a helper for this
    p_ManagedPolicyArns=[
        cf.helpers.iam.AwsManagedPolicy.AWSLambdaBasicExecutionRole,
    ]
)
tpl.add(iam_role_for_lambda)


# create a ``Resource`` object for aws lambda function
lbd_source_code = """
def handler(event, context):
    return "hello cottonformation"
""".strip()

lbd_func = awslambda.Function(
    "LbdFuncHelloWorld",
    # rp_ stands for Required Property, it will gives you parameter-hint
    # for all valid required properties.
    rp_Code=awslambda.FunctionCode(
        p_ZipFile=lbd_source_code,
    ),
    # normally we need to explicitly call GetAtt(resource, attribute)
    # and you need to remember the exact attribute name
    # but cottonformation allow you to instantly reference the attribute
    # powered by auto-complete. the prefix rv_ stands for Return Value
    rp_Role=iam_role_for_lambda.rv_Arn,
    # p_ stands for Property, it will gives you parameter-hint
    # for all valid properties
    p_MemorySize=256,
    p_Timeout=3,
    # some constant value helper here too
    p_Runtime=cf.helpers.awslambda.LambdaRuntime.python37,
    p_Handler="index.handler",
    ra_DependsOn=iam_role_for_lambda,
)
tpl.add(lbd_func)

out_lambda_role_arn = cf.Output(
    "LbdRoleArn",
    Description="aws lambda basic execution iam role for reuse",
    Value=iam_role_for_lambda.rv_Arn
)
tpl.add(out_lambda_role_arn)


if __name__ == "__main__":
    # my private aws account session and bucket for testing
    from cottonformation.tests.boto_ses import boto_ses, bucket

    # define the Parameter.EnvName value
    env_name = "ctf-1-quick-start-1-basic"

    # create an environment for deployment, it is generally a boto3 session
    # and a s3 bucket to upload cloudformation template
    env = cf.Env(boto_ses=boto_ses)
    env.deploy(
        template=tpl,
        stack_name=env_name,
        stack_parameters=dict(
            EnvName=env_name,
        ),
        bucket_name=bucket,
        include_iam=True,
    )

获得帮助

1. 学习最佳实践的最简单方法是通过实例学习。您可以通过示例从棉花形成开始。然后您可以在棉花成型最佳实践中学习在生产环境中证明的最佳实践。

2. 第二种方法是提交一个 GitHub 问题。所以其他人也可能会看到讨论和解决方案。另外在 gitter 上有一个cottonformation 社区 可以直接问作者。

$ pip install cottonformation

$ pip install --upgrade cottonformation