登录控制台
AWS CloudFormation
User Guide (API 版本 2010-05-15)
AWS 文档 » AWS CloudFormation » User Guide » 模板参考 » CloudFormation 帮助程序脚本参考 » cfn-init
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅中国的 AWS 服务入门。

cfn-init

说明

cfn-init 帮助程序脚本读取来自 AWS::CloudFormation::Init 密钥的模板元数据并进行相应操作：

  • 提取和解析来自 CloudFormation 的元数据

  • 安装软件包

  • 将文件写入磁盘

  • 启用/禁用以及启动/停止服务

注意

如果您使用 cfn-init 来更新现有文件，则它将在同一目录下为原始文件创建一个扩展名为 .bak 的备份副本。例如，如果更新 /path/to/file_name，则操作生成两个文件：/path/to/file_name.bak 包含原始文件的内容，而 /path/to/file_name 包含更新的内容。

有关模板元数据的信息，请参阅AWS::CloudFormation::Init。

注意

cfn-init 无需提供凭证，因此您不需要使用 --access-key、--secret-key、--role 或 --credential-file 选项。但是，如果不指定证书，则 AWS CloudFormation 会检查堆栈成员并将调用范围限制为实例所属的堆栈。

语法

cfn-init --stack|-s stack.name.or.id \
         --resource|-r logical.resource.id \
         --region region
         --access-key access.key \
         --secret-key secret.key \
         --role rolename\
         --credential-file|-f credential.file \
         --configsets|-c config.sets \
         --url|-u service.url \
         --http-proxy HTTP.proxy \
         --https-proxy HTTPS.proxy \
         --verbose|-v

选项

名称 描述 必需

-s, --stack

堆栈名称。

Type: String

默认值：无

示例: -s { "Ref" : "AWS::StackName" },

是

-r, --resource

包含元数据的资源的逻辑资源 ID。

Type: String

示例: -r WebServerHost

是

--region

要使用的 AWS CloudFormation 区域终端节点。

Type: String

默认值：us-east-1

示例: --region ", { "Ref" : "AWS::Region" },

否

--access-key

针对有权对 CloudFormation 调用 DescribeStackResource 的账户的 AWS 访问密钥。凭证文件参数取代此参数。

Type: String

否

--secret-key

对应于指定的 AWS 访问密钥的 AWS 秘密访问密钥。

Type: String

否

--role

与实例关联的 IAM 角色的名称。

Type: String

条件：凭证文件参数替代此参数。

否

-f, --credential-file

同时包含秘密访问密钥和访问密钥的文件。凭证文件参数取代 --role、--access-key 和 --secret-key 参数。

Type: String

否

-c, --configsets

待运行逗号分隔 configsets 列表（按顺序）。

Type: String

默认值：default

否

-u, --url

要使用的 AWS CloudFormation 终端节点。

Type: String

否

--http-proxy

HTTP 代理（非 SSL）。采用以下格式：http://user:password@host:port

Type: String

否

--https-proxy

HTTPS 代理。采用以下格式：https://user:password@host:port

Type: String

否

-v

详细的输出。这对于调试 cfn-init 无法初始化的案例非常有用。

注意

您应该打开 DisableRollback，以便调试初始化操作。您可以通过使用 CloudFormation 控制台完成此操作，选择 “Show Advanced Options”，然后将“失败时回滚”设定为“否”。随后您可以将 SSH 置于控制台中，读取 /var/log/cfn-init.log 上的日志。

否

示例

Amazon Linux 示例

下面的代码段演示 EC2 实例的 UserData 属性，该实例运行与 WebServerInstance 资源关联的 InstallAndRun 配置集。

有关完整示例模板，请参阅使用 AWS CloudFormation 在 Amazon EC2 上部署应用程序。

JSON

"UserData" : { "Fn::Base64" :
  { "Fn::Join" : ["", [
     "#!/bin/bash -xe\n",
     "# Install the files and packages from the metadata\n",
     "/opt/aws/bin/cfn-init -v ",
     "         --stack ", { "Ref" : "AWS::StackName" },
     "         --resource WebServerInstance ",
     "         --configsets InstallAndRun ",
     "         --region ", { "Ref" : "AWS::Region" }, "\n"
  ]]}
}

YAML

UserData: !Base64 
  'Fn::Join':
    - ''
    - - |
        #!/bin/bash -xe
      - |
        # Install the files and packages from the metadata
      - '/opt/aws/bin/cfn-init -v '
      - '         --stack '
      - !Ref 'AWS::StackName'
      - '         --resource WebServerInstance '
      - '         --configsets InstallAndRun '
      - '         --region '
      - !Ref 'AWS::Region'
      - |+

本页内容：