amazon.aws.ec2_vpc_nacl 模块 – 创建和删除网络 ACL

注意

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

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

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

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

community.aws 1.0.0 中的新增功能

概要

要求

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

  • 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

egress

列表 / 元素=列表

出站流量规则列表。每个规则必须指定为列表。每个规则可以包含规则编号（整数 1-32766）、协议（[‘tcp’，‘udp’，‘icmp’，‘ipv6-icmp’，‘-1’，‘all’] 之一）、规则操作（‘allow’ 或 ‘deny’）、允许或拒绝的 IPv4 或 IPv6 网络范围的 CIDR、ICMP 类型（-1 表示所有类型）、ICMP 代码（-1 表示所有代码）、TCP 或 UDP 协议的范围内的最后一个端口以及 TCP 或 UDP 协议的范围内的第一个端口。请参阅示例。

默认值： []

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

ingress

列表 / 元素=列表

入站流量规则列表。每个规则必须指定为一个列表。每个规则可能包含规则编号（整数 1-32766）、协议（[‘tcp’，‘udp’，‘icmp’，‘ipv6-icmp’，‘-1’，‘all’] 之一）、规则操作（‘allow’ 或 ‘deny’）、允许或拒绝的 IPv4 或 IPv6 网络范围的 CIDR、ICMP 类型（-1 表示所有类型）、ICMP 代码（-1 表示所有代码）、TCP 或 UDP 协议的范围内的最后一个端口以及 TCP 或 UDP 协议的范围内的第一个端口。请参见示例。

默认值： []

nacl_id

字符串

标识网络 ACL 的 NACL ID。

需要且仅需要一个 name 或 nacl_id。

与 name 互斥。

name

字符串

标记名称，用于标识网络 ACL。

需要且仅需要一个 name 或 nacl_id。

与 nacl_id 互斥。

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

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

已弃用 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

字符串

创建或修改现有的 NACL。

删除 NACL 并将子网重新关联到默认 NACL。

选项

  • "present" ← (默认)

  • "absent"

subnets

列表 / 元素=字符串

应与网络 ACL 关联的子网列表。

必须指定为列表

每个子网可以指定为子网 ID 或其标记名称。

默认值： []

tags

别名：resource_tags

字典

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

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

vpc_id

字符串

请求 VPC 的 VPC ID。

state 为 present 时必需。

注释

注意

  • 在 4.0.0 版本中添加了对 purge_tags 的支持。

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

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

示例

# Complete example to create and delete a network ACL
# that allows SSH, HTTP and ICMP in, and all traffic out.
- name: "Create and associate production DMZ network ACL with DMZ subnets"
  amazon.aws.ec2_vpc_nacl:
    vpc_id: vpc-12345678
    name: prod-dmz-nacl
    region: ap-southeast-2
    subnets: ['prod-dmz-1', 'prod-dmz-2']
    tags:
      CostCode: CC1234
      Project: phoenix
      Description: production DMZ
    ingress:
      # rule no, protocol, allow/deny, cidr, icmp_type, icmp_code,
      #                                             port from, port to
      - [100, 'tcp', 'allow', '0.0.0.0/0', null, null, 22, 22]
      - [200, 'tcp', 'allow', '0.0.0.0/0', null, null, 80, 80]
      - [205, 'tcp', 'allow', '::/0', null, null, 80, 80]
      - [300, 'icmp', 'allow', '0.0.0.0/0', 0, 8]
      - [305, 'ipv6-icmp', 'allow', '::/0', 0, 8]
    egress:
      - [100, 'all', 'allow', '0.0.0.0/0', null, null, null, null]
      - [105, 'all', 'allow', '::/0', null, null, null, null]
    state: 'present'

- name: "Remove the ingress and egress rules - defaults to deny all"
  amazon.aws.ec2_vpc_nacl:
    vpc_id: vpc-12345678
    name: prod-dmz-nacl
    region: ap-southeast-2
    subnets:
      - prod-dmz-1
      - prod-dmz-2
    tags:
      CostCode: CC1234
      Project: phoenix
      Description: production DMZ
    state: present

- name: "Remove the NACL subnet associations and tags"
  amazon.aws.ec2_vpc_nacl:
    vpc_id: 'vpc-12345678'
    name: prod-dmz-nacl
    region: ap-southeast-2
    state: present

- name: "Delete nacl and subnet associations"
  amazon.aws.ec2_vpc_nacl:
    vpc_id: vpc-12345678
    name: prod-dmz-nacl
    state: absent

- name: "Delete nacl by its id"
  amazon.aws.ec2_vpc_nacl:
    nacl_id: acl-33b4ee5b
    state: absent

返回值

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

键

描述

nacl_id

字符串

NACL 的 ID（在创建或更新 ACL 时）。

返回：成功

示例："acl-123456789abcdef01"

作者

  • Mike Mochan (@mmochan)