community.aws.efs 模块 – 创建和维护 EFS 文件系统
注意
此模块是 community.aws 集合 (版本 9.0.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：community.aws.efs。
community.aws 1.0.0 中的新增功能
概要
该模块允许创建、搜索和销毁 Amazon EFS 文件系统。
要求
执行此模块的主机需要以下要求。
python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0
参数
参数 |
注释 |
|---|---|
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 和 profile 选项是互斥的。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的发行版中移除。
|
|
验证 SSL 证书时使用的 CA 证书包的位置。 也可以使用 |
|
用于修改 botocore 配置的字典。 参数可以在 AWS 文档中找到 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。 |
|
使用 也可以使用 选项
|
|
如果 encrypt=true，则创建一个加密的文件系统。创建文件系统后，无法修改此设置。 选项
|
|
连接到非默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的发行版中移除。
|
|
Amazon EFS 的 ID。删除时需要名称或 ID。 |
|
将用于保护加密文件系统的 AWS KMS CMK 的 ID。只有在要使用非默认 CMK 时才需要此参数。如果未指定此参数，则使用 Amazon EFS 的默认 CMK。密钥 ID 可以是密钥 ID、密钥 ID ARN、密钥别名或密钥别名 ARN。 |
|
Amazon EFS 文件系统的创建令牌。创建和更新时需要。删除时需要名称或 ID。 |
|
要使用的文件系统的性能模式。仅在创建期间有效。 选项
|
|
要用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 也可以使用 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。 |
|
如果 throughput_mode 为 provisioned，请选择要配置的吞吐量（以 Mibps 为单位）。 |
|
如果 如果未设置 以 选项
|
|
要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全球服务，将忽略区域 (region)。 也可以使用 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 别名 对 |
|
AWS 密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 密钥 (secret_key) 和 配置文件 (profile) 选项互斥。 为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_secret_access_key 别名。 别名 ec2_secret_key 已弃用，将在 2024-12-01 之后的发行版本中移除。 对 |
|
用于临时凭据的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用 会话令牌 (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 之后的发行版本中移除。 对 |
|
允许创建、搜索和销毁 Amazon EFS 文件系统。 选项
|
|
Amazon EFS 的标签列表。应定义为字典。在使用标签列表和现有 EFS（通过“名称”匹配）的“present”状态的情况下，将用提供的数据替换 EFS 的标签。 |
|
已挂载目标的列表。它应该是字典列表，每个字典都应包含以下属性：可以使用状态“present”和新的挂载目标列表修改现有 EFS 的此数据。 默认值： |
|
指定子网地址范围内有效的 IPv4 地址。 |
|
安全组 ID 列表，格式为“sg-xxxxxxxx”。这些必须与指定的子网位于同一 VPC 中。 |
|
要添加挂载目标的子网的 ID。 |
|
要创建的文件系统的吞吐量模式。 选项
|
|
对象转移到更低成本的 EFS Infrequent Access (IA) 存储类之前的几天数。 如果设置为字符串 如果缺少此参数，则不会影响任何现有的生命周期策略。 选项
|
|
设置为 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项
|
|
在“present”状态下，应等待 EFS 的“可用”生命周期状态（当然，如果当前状态不是“删除中”或“已删除”）。在“absent”状态下，应等待 EFS 的“已删除”生命周期状态。 选项
|
|
模块在返回之前应等待多长时间（以秒为单位）。零表示无限期等待。 默认值： |
备注
注意
注意：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要显式地将文件复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。
Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文中的配置文件（通常为
~/.aws/credentials）读取凭据和其他设置的默认值，例如区域。有关更多信息，请参阅 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。
示例
- name: EFS provisioning
community.aws.efs:
state: present
name: myTestEFS
tags:
Name: myTestNameTag
purpose: file-storage
targets:
- subnet_id: subnet-748c5d03
security_groups: ["sg-1a2b3c4d"]
- name: Modifying EFS data
community.aws.efs:
state: present
name: myTestEFS
tags:
name: myAnotherTestTag
targets:
- subnet_id: subnet-7654fdca
security_groups: ["sg-4c5d6f7a"]
- name: Set a lifecycle policy
community.aws.efs:
state: present
name: myTestEFS
transition_to_ia: 7
targets:
- subnet_id: subnet-7654fdca
security_groups: ["sg-4c5d6f7a"]
- name: Remove a lifecycle policy
community.aws.efs:
state: present
name: myTestEFS
transition_to_ia: None
targets:
- subnet_id: subnet-7654fdca
security_groups: ["sg-4c5d6f7a"]
- name: Deleting EFS
community.aws.efs:
state: absent
name: myTestEFS
返回值
常用返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
创建日期的时间戳 返回：始终 示例： |
|
EFS 创建令牌 返回：始终 示例： |
|
文件系统的 ID 返回：始终 示例： |
|
可用于挂载的文件系统 URL 返回：始终 示例： |
|
EFS 文件系统状态 返回：始终 示例： |
|
从 AWS EFS 需要向地址添加区域后缀的时间开始的文件系统 URL，前面带有点 返回：始终 示例： |
|
挂载目标列表 返回：始终 示例： |
|
文件系统名称 返回：始终 示例： |
|
已挂载的目标数量 返回：始终 示例： |
|
EFS所有者的AWS账户ID 返回：始终 示例： |
|
文件系统的性能模式 返回：始终 示例： |
|
截至某个时间戳的文件系统大小（字节） 返回：始终 示例： |
|
efs实例上的标签 返回：始终 示例： |