amazon.aws.lambda_alias 模块 – 创建、更新或删除 AWS Lambda 函数别名

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，有关详细信息，请参见 要求。

要在 playbook 中使用它，请指定：amazon.aws.lambda_alias。

amazon.aws 5.0.0 中的新增功能

概要

  • 此模块允许通过 Ansible 框架管理 AWS Lambda 函数别名。它是幂等的，并支持“检查”模式。使用模块 amazon.aws.lambda 管理 lambda 函数本身，并使用 amazon.aws.lambda_event 管理事件源映射。

  • 此模块最初在版本 1.0.0 中添加到 community.aws。

要求

执行此模块的主机需要以下要求。

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

参数

参数

注释

access_key

别名：aws_access_key_id、aws_access_key、ec2_access_key

字符串

AWS 访问密钥 ID。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

还可以按优先级递减的顺序使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量。

aws_access_key 和 profile 选项是互斥的。

为与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。

ec2_access_key 别名已弃用，并将在 2024-12-01 之后的一个版本中删除。

EC2_ACCESS_KEY 环境变量的支持已弃用，并将在 2024-12-01 之后的一个版本中删除。

aws_ca_bundle

路径

验证 SSL 证书时使用的 CA 证书包的位置。

还可以使用 AWS_CA_BUNDLE 环境变量。

aws_config

字典

用于修改 botocore 配置的字典。

可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。

还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选项

  • false ← (默认)

  • true

description

字符串

简短的用户定义函数别名描述。

endpoint_url

别名：ec2_url、aws_endpoint_url、s3_url

字符串

连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。

还可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。

ec2_url 和 s3_url 别名已弃用，并将在 2024-12-01 之后的一个版本中删除。

EC2_URL 环境变量的支持已弃用，并将在 2024-12-01 之后的一个版本中删除。

function_name

字符串 / 必需

函数别名名称。

function_version

别名：version

整数

与 Lambda 函数别名关联的版本。0 值（或省略的参数）将别名设置为 $LATEST 版本。

默认值： 0

name

别名：alias_name

字符串 / 必需

函数别名名称。

profile

别名：aws_profile

字符串

用于身份验证的命名 AWS 配置文件。

有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。

也可以使用 AWS_PROFILE 环境变量。

profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。

region

别名：aws_region、ec2_region

字符串

要使用的 AWS 区域。

对于 IAM、Route53 和 CloudFront 等全局服务，将忽略 region。

也可以使用 AWS_REGION 或 EC2_REGION 环境变量。

有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。

ec2_region 别名已弃用，将在 2024 年 12 月 1 日之后的版本中移除。

对 EC2_REGION 环境变量的支持已弃用，将在 2024 年 12 月 1 日之后的版本中移除。

secret_key

别名：aws_secret_access_key、aws_secret_key、ec2_secret_key

字符串

AWS 密钥访问密钥。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以按优先级递减顺序使用 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY 环境变量。

secret_key 和 profile 选项互斥。

为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。

ec2_secret_key 别名已弃用，将在 2024 年 12 月 1 日之后的版本中移除。

对 EC2_SECRET_KEY 环境变量的支持已弃用，将在 2024 年 12 月 1 日之后的版本中移除。

session_token

别名：aws_session_token、security_token、aws_security_token、access_token

字符串

用于临时凭证的 AWS STS 会话令牌。

有关访问令牌的更多信息，请参见 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。

也可以按优先级递减顺序使用 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN 环境变量。

security_token 和 profile 选项互斥。

在 3.2.0 版本中添加了 aws_session_token 和 session_token 别名，在 6.0.0 版本中将参数名称从 security_token 重命名为 session_token。

security_token、aws_security_token 和 access_token 别名已弃用，将在 2024 年 12 月 1 日之后的版本中移除。

对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024 年 12 月 1 日之后的版本中移除。

state

字符串

描述所需状态。

选项

  • "present" ← (默认)

  • "absent"

validate_certs

布尔值

设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。

强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。

选项

  • false

  • true ← (默认)

注释

注意

  • 警告：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文读取的，而不是“控制器”上下文。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文读取的，而不是“主机”上下文。

  • Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的配置文件（通常为 ~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

---
# Simple example to create a lambda function and publish a version
- hosts: localhost
  gather_facts: false
  vars:
    state: present
    project_folder: /path/to/deployment/package
    deployment_package: lambda.zip
    account: 123456789012
    production_version: 5
  tasks:
    - name: AWS Lambda Function
      amazon.aws.lambda:
        state: "{{ state | default('present') }}"
        name: myLambdaFunction
        publish: true
        description: lambda function description
        code_s3_bucket: package-bucket
        code_s3_key: "lambda/{{ deployment_package }}"
        local_path: "{{ project_folder }}/{{ deployment_package }}"
        runtime: python2.7
        timeout: 5
        handler: lambda.handler
        memory_size: 128
        role: "arn:aws:iam::{{ account }}:role/API2LambdaExecRole"

    - name: Get information
      amazon.aws.lambda_info:
        name: myLambdaFunction
      register: lambda_info
    - name: show results
      ansible.builtin.debug:
        msg: "{{ lambda_info['lambda_facts'] }}"

    # The following will set the Dev alias to the latest version ($LATEST) since version is omitted (or = 0)
    - name: "alias 'Dev' for function {{ lambda_info.lambda_facts.FunctionName }} "
      amazon.aws.lambda_alias:
        state: "{{ state | default('present') }}"
        function_name: "{{ lambda_info.lambda_facts.FunctionName }}"
        name: Dev
        description: Development is $LATEST version

    # The QA alias will only be created when a new version is published (i.e. not = '$LATEST')
    - name: "alias 'QA' for function {{ lambda_info.lambda_facts.FunctionName }} "
      amazon.aws.lambda_alias:
        state: "{{ state | default('present') }}"
        function_name: "{{ lambda_info.lambda_facts.FunctionName }}"
        name: QA
        version: "{{ lambda_info.lambda_facts.Version }}"
        description: "QA is version {{ lambda_info.lambda_facts.Version }}"
      when: lambda_info.lambda_facts.Version != "$LATEST"

    # The Prod alias will have a fixed version based on a variable
    - name: "alias 'Prod' for function {{ lambda_info.lambda_facts.FunctionName }} "
      amazon.aws.lambda_alias:
        state: "{{ state | default('present') }}"
        function_name: "{{ lambda_info.lambda_facts.FunctionName }}"
        name: Prod
        version: "{{ production_version }}"
        description: "Production is version {{ production_version }}"

返回值

常见的返回值已在 此处 记录，以下是此模块独有的字段

键

描述

alias_arn

字符串

函数的完整 ARN，包括别名。

已返回：成功

示例："arn:aws:lambda:us-west-2:123456789012:function:myFunction:dev"

description

字符串

别名的简短描述。

已返回：成功

示例："The development stage for my hot new app."

function_version

字符串

别名引用的限定符。

已返回：成功

示例："$LATEST"

name

字符串

分配的别名名称。

已返回：成功

示例："dev"

revision_id

字符串

更新别名时会更改的唯一标识符。

已返回：成功

示例："12345678-1234-1234-1234-123456789abc"

作者

  • Pierre Jodouin (@pjodouin)

  • Ryan Scott Brown (@ryansb)