community.aws.stepfunctions_state_machine_execution 模块 – 启动或停止 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_execution。

community.aws 1.0.0 中的新功能

概要

  • 启动或停止 AWS Step Functions 中状态机的执行。

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

别名：aws_step_functions_state_machine_execution

要求

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

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

action

字符串

状态机执行的期望操作（start 或 stop）。

选择

  • "start" ←（默认）

  • "stop"

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。

cause

字符串

停止执行原因的详细说明。

默认值： ""

debug_botocore_endpoint_logs

布尔值

使用 botocore.endpoint 记录器来解析在任务期间发出的唯一（而非总数）"resource:action" API 调用，并将该集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出到 playbook 期间制作的总列表。

也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。

选择

  • false ←（默认）

  • true

endpoint_url

别名：ec2_url, aws_endpoint_url, s3_url

字符串

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

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

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

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

error

字符串

停止执行时要传入的失败错误代码。

默认值： ""

execution_arn

字符串

您希望停止的执行的 ARN。

execution_input

json

执行的 JSON 输入数据。

默认值： "{}"

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

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

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-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_machine_arn

字符串

要执行的状态机的 ARN。

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。

示例

- name: Start an execution of a state machine
  community.aws.stepfunctions_state_machine_execution:
    name: an_execution_name
    execution_input: '{ "IsHelloWorldExample": true }'
    state_machine_arn: "arn:aws:states:us-west-2:123456789012:stateMachine:HelloWorldStateMachine"

- name: Stop an execution of a state machine
  community.aws.stepfunctions_state_machine_execution:
    action: stop
    execution_arn: "arn:aws:states:us-west-2:123456789012:execution:HelloWorldStateMachineCopy:a1e8e2b5-5dfe-d40e-d9e3-6201061047c8"
    cause: "cause of task failure"
    error: "error code of the failure"

返回值

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

Key

描述

execution_arn

字符串

AWS Step Functions 状态机执行的 ARN。

返回: 如果 action == start 且 changed == True

示例: "arn:aws:states:us-west-2:123456789012:execution:HelloWorldStateMachineCopy:a1e8e2b5-5dfe-d40e-d9e3-6201061047c8"

start_date

字符串

执行开始的日期。

返回: 如果 action == start 且 changed == True

示例: "2019-11-02T22:39:49.071000-07:00"

stop_date

字符串

执行停止的日期。

返回: 如果 action == stop

示例: "2019-11-02T22:39:49.071000-07:00"

作者

  • Prasad Katti (@prasadkatti)