community.aws.ecs_cluster 模块 – 创建或终止 ECS 集群。

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要 

创建或终止 ECS 集群。

要求 

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

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。
capacity_provider_strategy 列表 / 元素=字典在 community.aws 5.2.0 中添加	要用于集群的容量提供程序策略列表。
base 整数	至少有多少个任务应该使用指定的提供程序。默认值： `0`
capacity_provider 字符串	容量提供程序的名称。
weight 整数	应该使用指定提供程序的已启动任务总数的相对百分比。
capacity_providers 列表 / 元素=字符串在 community.aws 5.2.0 中添加	要用于集群的容量提供程序列表。
debug_botocore_endpoint_logs 布尔值	使用 `botocore.endpoint` 记录器来解析在任务期间进行的唯一（而不是总计）`"resource:action"` API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 `aws_resource_action` 回调将输出到 playbook 期间进行的总列表。也可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选项 `false` ← (默认) `true`
delay 整数	等待的秒数。默认值： `10`
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 之后的一个版本中删除。
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_capacity_providers 布尔值在 community.aws 5.2.0 中添加	切换是否覆盖现有的容量提供程序或策略。这对于向后兼容性是必需的。默认情况下，purge_capacity_providers=true。选项 `false` `true` ← (默认)
region 别名：aws_region, ec2_region 字符串	要使用的 AWS 区域。对于 IAM、Route53 和 CloudFront 等全球服务，将忽略区域。也可以使用`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 之后发布的版本中移除。
repeat 整数	等待集群拥有实例的次数。默认值： `10`
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 保持一致，别名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"` `"has_instances"`
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。

示例 

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Cluster creation
  community.aws.ecs_cluster:
    name: default
    state: present

- name: Cluster creation with capacity providers and strategies.
  community.aws.ecs_cluster:
    name: default
    state: present
    capacity_providers:
      - FARGATE
      - FARGATE_SPOT
    capacity_provider_strategy:
      - capacity_provider: FARGATE
        base: 1
        weight: 1
      - capacity_provider: FARGATE_SPOT
        weight: 100
    purge_capacity_providers: true

- name: Cluster deletion
  community.aws.ecs_cluster:
    name: default
    state: absent

- name: Wait for register
  community.aws.ecs_cluster:
    name: "{{ new_cluster }}"
    state: has_instances
    delay: 10
    repeat: 10
  register: task_output

返回值 

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

键	描述
activeServicesCount 整数	此集群中活动服务的数量返回：如果为新集群，则为 0
capacityProviders 列表 / 元素=字符串在 community.aws 5.2.0 中添加	此集群中使用的容量提供程序列表返回：始终返回
clusterArn 字符串	刚刚创建的集群的 ARN 返回：如果为新集群，则为 0 示例：`"arn:aws:ecs:us-west-2:123456789012:cluster/test-cluster"`
clusterName 字符串	刚刚创建的集群的名称（应与输入参数匹配）返回：始终返回示例：`"test-cluster"`
defaultCapacityProviderStrategy 列表 / 元素=字符串在 community.aws 5.2.0 中添加	此集群中使用的容量提供程序策略列表返回：始终返回
pendingTasksCount 整数	此集群中等待运行的任务数量返回：如果为新集群，则为 0
registeredContainerInstancesCount 整数	此集群中可用的容器实例数量返回：如果为新集群，则为 0
runningTasksCount 整数	此集群中正在运行的任务数量返回：如果为新集群，则为 0
status 字符串	新集群的状态返回：始终返回示例：`"ACTIVE"`

作者

Mark Chance (@Java1Guy)