community.aws.stepfunctions_state_machine 模块 – 管理 AWS Step Functions 状态机

注意

此模块是 community.aws 集合（版本 9.0.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.aws。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：community.aws.stepfunctions_state_machine。

community.aws 1.0.0 中的新增功能

概要

  • 在 AWS Step Functions 中创建、更新和删除状态机。

  • 在现有 AWS Step Functions 状态机上调用 state=present 中的模块将尝试使用提供的数据更新状态机定义、IAM 角色或标签。

  • 在 5.0.0 版本之前，此模块称为 community.aws.aws_step_functions_state_machine。用法没有改变。

别名：aws_step_functions_state_machine

要求

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

  • 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_access_key_id 别名在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。

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

definition

json

状态机的 Amazon 状态语言定义。有关 Amazon 状态语言的更多信息，请参阅 https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html。

当 state=present 时是必需的。

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 之后的版本中删除。

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 选项互斥。

purge_tags

布尔值

如果 purge_tags=true 且设置了 tags，则现有标签将从资源中清除，以精确匹配 tags 参数的定义。

如果未设置 tags 参数，则即使 purge_tags=True，标签也不会被修改。

以 aws: 开头的标签键由 Amazon 保留，无法修改。因此，在 purge_tags 参数中将被忽略。有关更多信息，请参阅 Amazon 文档 https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions。

选项

  • false

  • true ← (默认)

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-01 之后的版本中删除

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

role_arn

字符串

状态机执行将使用的 IAM 角色的 ARN。

当 state=present 时是必需的。

secret_key

别名：aws_secret_access_key, aws_secret_key, ec2_secret_key

字符串

AWS secret access key。

有关访问令牌的更多信息，请参阅 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 保持一致，aws_secret_access_key 别名在 5.1.0 版本中添加。

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

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

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 选项互斥。

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

security_token、aws_security_token 和 access_token 别名已弃用，将在 2024-12-01 之后的版本中删除。

对 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。

state

字符串

状态机的期望状态。

选项

  • "present" ← (默认)

  • "absent"

tags

别名：resource_tags

字典

一个表示要应用于资源的标签的字典。

如果未设置 tags 参数，则标签不会被修改。

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。

示例

# Create a new AWS Step Functions state machine
- name: Setup HelloWorld state machine
  community.aws.stepfunctions_state_machine:
    name: "HelloWorldStateMachine"
    definition: "{{ lookup('file','state_machine.json') }}"
    role_arn: arn:aws:iam::123456789012:role/service-role/invokeLambdaStepFunctionsRole
    tags:
      project: helloWorld

# Update an existing state machine
- name: Change IAM Role and tags of HelloWorld state machine
  community.aws.stepfunctions_state_machine:
    name: HelloWorldStateMachine
    definition: "{{ lookup('file','state_machine.json') }}"
    role_arn: arn:aws:iam::123456789012:role/service-role/anotherStepFunctionsRole
    tags:
      otherTag: aDifferentTag

# Remove the AWS Step Functions state machine
- name: Delete HelloWorld state machine
  community.aws.stepfunctions_state_machine:
    name: HelloWorldStateMachine
    state: absent

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

state_machine_arn

字符串

AWS Step Functions 状态机的 ARN

返回：始终

作者

  • Tom De Keyser (@tdekeyser)