Terraform AWS Provider 中 aws_route53_zones 数据源详解：获取 Route 53 Hosted Zone ID 列表

Terraform AWS Provider 中 aws_route53_zones 数据源详解获取 Route 53 Hosted Zone ID 列表【免费下载链接】terraform-provider-awsThe AWS Provider enables Terraform to manage AWS resources.项目地址: https://gitcode.com/GitHub_Trending/te/terraform-provider-awsaws_route53_zones是 Terraform AWS Provider 中用于枚举 Route 53 Hosted Zone 的数据源可在配置阶段批量获取账号下所有 Hosted Zone 的 ID 列表典型场景包括批量管理 DNS 记录、为多个 Zone 统一配置资源记录集、或在脚本中动态发现 Zone 依赖。读完本文你将掌握该数据源的使用方式、导出属性含义以及它在 Provider 源码中的分页拉取、ID 清洗与分页器实现细节从而理解返回结果与 API 原始响应之间的差异。官方用法一条配置获取全部 Zone ID官方文档 website/docs/d/route53_zones.html.markdown 对该数据源的描述非常简洁This resource can be useful for getting back a list of Route53 Hosted Zone IDs for a Region.文档给出的标准用法如下创建一个空的 data 块并输出ids属性即可data aws_route53_zones all {} output example { value data.aws_route53_zones.all.ids }该数据源不支持任何参数官方文档在 Argument Reference 一节明确说明 This data source does not support any arguments。它导出的属性只有一个属性说明ids找到的所有 Route 53 Hosted Zone ID 组成的列表源码剖析Plugin Framework 数据源实现在 Provider 中该数据源由 internal/service/route53/zones_data_source.go 实现是基于 Terraform Plugin Framework 构建的区别于同目录下大量基于 SDKv2 的旧式资源。Schema 定义只有 id 与 ids 两个属性zonesDataSource的 Schema 极其精简只声明两个 Computed 属性func (d *zonesDataSource) Schema(ctx context.Context, request datasource.SchemaRequest, response *datasource.SchemaResponse) { response.Schema schema.Schema{ Attributes: map[string]schema.Attribute{ names.AttrID: framework.IDAttribute(), names.AttrIDs: schema.ListAttribute{ CustomType: fwtypes.ListOfStringType, ElementType: types.StringType, Computed: true, }, }, } }id是框架统一要求的标识属性framework.IDAttribute()ids是计算属性使用 Provider 自定义的fwtypes.ListOfStringType底层为字符串列表与文档中承诺的唯一导出属性一一对应。Read 流程拉取全部 Zone 并清洗 IDRead方法的完整调用链可以概括为三步见 zones_data_source.go#L46-L72获取 Route 53 客户端通过d.Meta().Route53Client(ctx)取得 SDK 客户端该客户端由 internal/conns/awsclient_gen.go#L1143-L1145 中的Route53Client方法按服务名统一构造无过滤条件分页拉取以空的route53.ListHostedZonesInput{}调用共享的findHostedZones函数过滤谓词为tfslices.PredicateTrue[*awstypes.HostedZone]()即不过滤任何 Zone公有和私有 Zone 全部返回input : route53.ListHostedZonesInput{} output, err : findHostedZones(ctx, conn, input, tfslices.PredicateTrue[*awstypes.HostedZone]())ID 清洗与状态写入对每个HostedZone调用cleanZoneID去掉前缀然后把当前 Provider 配置的 Region写入id属性zoneIDs : tfslices.ApplyToAll(output, func(v awstypes.HostedZone) string { return cleanZoneID(aws.ToString(v.Id)) }) data.ID types.StringValue(d.Meta().Region(ctx)) data.ZoneIDs fwflex.FlattenFrameworkStringValueListOfString(ctx, zoneIDs)这里有一个容易被忽略的细节id属性的值并不是某个具体的 Zone ID而是Provider 配置的 Region 名称。这是 Plugin Framework 数据源对id属性的常规约定需要一个稳定标识理解这一点可以避免在刷新状态时产生困惑。分页拉取findHostedZones 的 paginator 实现findHostedZones定义在 internal/service/route53/zone_data_source.go#L285-L304是单 Zone 数据源aws_route53_zone与aws_route53_zones共用的查询函数func findHostedZones(ctx context.Context, conn *route53.Client, input *route53.ListHostedZonesInput, filter tfslices.Predicate[*awstypes.HostedZone]) ([]awstypes.HostedZone, error) { var output []awstypes.HostedZone pages : route53.NewListHostedZonesPaginator(conn, input) for pages.HasMorePages() { page, err : pages.NextPage(ctx) if err ! nil { return nil, err } for _, v : range page.HostedZones { if filter(v) { output append(output, v) } } } return output, nil }从源码结构看这里使用 SDK v2 的NewListHostedZonesPaginator自动翻页因此即使账号下 Hosted Zone 数量超过单页上限Route 53ListHostedZonesAPI 单页返回有上限aws_route53_zones也能拿到完整列表而不会只返回第一页。aws_route53_zones传入的是恒真过滤器等价于全量收集而单 Zone 数据源则在收集后经tfresource.AssertSingleValueResult断言结果唯一。ID 格式为什么返回的 ID 没有 /hostedzone/ 前缀Route 53 API 返回的 Zone ID 原始形态是/hostedzone/ZXXXXXXXXX这样的路径式字符串。Provider 在 internal/service/route53/clean.go#L19-L22 中统一做了前缀剥离// cleanZoneID is used to remove the leading /hostedzone/ from a hosted zone ID func cleanZoneID(id string) string { return strings.TrimPrefix(id, /hostedzone/) }因此ids列表中每一项都是干净的Z...形式 ID可以直接与aws_route53_record、aws_route53_zone_association等资源的zone_id参数对接无需再次处理。验收测试如何验证该数据源internal/service/route53/zones_data_source_test.go 中的TestAccRoute53ZonesDataSource_basic给出了该数据源最贴近真实用法的方式先创建一个 Zone再声明无参数 data 块并用depends_on保证 Zone 先于查询创建resource aws_route53_zone test { name %[1]s. } data aws_route53_zones test { depends_on [aws_route53_zone.test] }测试断言为ids.#列表长度大于等于 1。这段配置也揭示了实际使用中的一个关键点data 块不会自动感知资源的创建时序如果在同一 plan 中既要新建 Zone、又要确保它出现在查询结果里必须显式写depends_on。与单 Zone 数据源 aws_route53_zone 的分工如果只需定位某一个 Zone更适合使用单 Zone 数据源aws_route53_zone实现见 internal/service/route53/zone_data_source.go。从源码中的 Schema 可以看出它支持按zone_id、name、vpc_id过滤并可通过private_zone参数控制是否只查私有 Zone且导出name_servers、primary_name_server、resource_record_set_count等更丰富的属性。两者的分工可以概括为aws_route53_zones无参数全量 ID 列表适合枚举与批量处理aws_route53_zone按条件精确查找单个 Zone适合引用某个已知 Zone 的详细信息。适用前提与注意事项查询范围是账号级而非严格 Region 级ListHostedZones是 Route 53 的全局 API返回当前凭据所属账号下所有可见的 Hosted Zone含私有 Zone。文档描述中的 for a Region 更多指 Provider 客户端所配置的上下文id属性写入的 Region 值也不应被理解为结果集按 Region 做了过滤。权限要求调用ListHostedZones需要 IAM 具备相应的 Route 53 只读权限否则Read会直接返回 reading Route 53 Hosted Zones 错误。结果无排序保证源码中未对收集到的 Zone 做显式排序ids的顺序取决于 API 分页返回顺序消费方不应假设其有序。小结aws_route53_zones虽然只有零参数、一属性但它的实现展示了 Provider 中数据源的标准范式Plugin Framework Schema 声明zones_data_source.go→ 共享分页查询函数zone_data_source.go 中的findHostedZones→ ID 归一化clean.go 中的cleanZoneID。理解这条链路后你就能准确预期该数据源的返回值形态无前缀的 Zone ID 列表并在需要全量 Zone 信息时与单 Zone 数据源正确搭配使用。【免费下载链接】terraform-provider-awsThe AWS Provider enables Terraform to manage AWS resources.项目地址: https://gitcode.com/GitHub_Trending/te/terraform-provider-aws创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考