getRecords function

Future<GetRecordsResult> getRecords(
  1. GetRecordsArgs args, {
  2. InvokeOptions? options,
})

Use this data source to get the details of resource records in a Route 53 hosted zone.

Example Usage

Basic Usage

Return all records in the zone.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const selected = aws.route53.getZone({
    name: "test.com.",
    privateZone: true,
});
const example = selected.then(selected => aws.route53.getRecords({
    zoneId: selected.zoneId,
}));
import pulumi
import pulumi_aws as aws

selected = aws.route53.get_zone(name="test.com.",
    private_zone=True)
example = aws.route53.get_records(zone_id=selected.zone_id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var selected = Aws.Route53.GetZone.Invoke(new()
    {
        Name = "test.com.",
        PrivateZone = true,
    });

    var example = Aws.Route53.GetRecords.Invoke(new()
    {
        ZoneId = selected.Apply(getZoneResult => getZoneResult.ZoneId),
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		selected, err := route53.LookupZone(ctx, &route53.LookupZoneArgs{
			Name:        pulumi.StringRef("test.com."),
			PrivateZone: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = route53.GetRecords(ctx, &route53.GetRecordsArgs{
			ZoneId: selected.ZoneId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_route53_getzone" "selected" {
  name         = "test.com."
  private_zone = true
}
data "aws_route53_getrecords" "example" {
  zone_id = data.aws_route53_getzone.selected.zone_id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.Route53Functions;
import com.pulumi.aws.route53.inputs.GetZoneArgs;
import com.pulumi.aws.route53.inputs.GetRecordsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var selected = Route53Functions.getZone(GetZoneArgs.builder()
            .name("test.com.")
            .privateZone(true)
            .build());

        final var example = Route53Functions.getRecords(GetRecordsArgs.builder()
            .zoneId(selected.zoneId())
            .build());

    }
}
variables:
  selected:
    fn::invoke:
      function: aws:route53:getZone
      arguments:
        name: test.com.
        privateZone: true
  example:
    fn::invoke:
      function: aws:route53:getRecords
      arguments:
        zoneId: ${selected.zoneId}

Basic Usage with filter

Return the records that starts with www.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const selected = aws.route53.getZone({
    name: "test.com.",
    privateZone: true,
});
const example = selected.then(selected => aws.route53.getRecords({
    zoneId: selected.zoneId,
    nameRegex: "^www",
}));
import pulumi
import pulumi_aws as aws

selected = aws.route53.get_zone(name="test.com.",
    private_zone=True)
example = aws.route53.get_records(zone_id=selected.zone_id,
    name_regex="^www")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var selected = Aws.Route53.GetZone.Invoke(new()
    {
        Name = "test.com.",
        PrivateZone = true,
    });

    var example = Aws.Route53.GetRecords.Invoke(new()
    {
        ZoneId = selected.Apply(getZoneResult => getZoneResult.ZoneId),
        NameRegex = "^www",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		selected, err := route53.LookupZone(ctx, &route53.LookupZoneArgs{
			Name:        pulumi.StringRef("test.com."),
			PrivateZone: pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		_, err = route53.GetRecords(ctx, &route53.GetRecordsArgs{
			ZoneId:    selected.ZoneId,
			NameRegex: pulumi.StringRef("^www"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_route53_getzone" "selected" {
  name         = "test.com."
  private_zone = true
}
data "aws_route53_getrecords" "example" {
  zone_id    = data.aws_route53_getzone.selected.zone_id
  name_regex = "^www"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.Route53Functions;
import com.pulumi.aws.route53.inputs.GetZoneArgs;
import com.pulumi.aws.route53.inputs.GetRecordsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var selected = Route53Functions.getZone(GetZoneArgs.builder()
            .name("test.com.")
            .privateZone(true)
            .build());

        final var example = Route53Functions.getRecords(GetRecordsArgs.builder()
            .zoneId(selected.zoneId())
            .nameRegex("^www")
            .build());

    }
}
variables:
  selected:
    fn::invoke:
      function: aws:route53:getZone
      arguments:
        name: test.com.
        privateZone: true
  example:
    fn::invoke:
      function: aws:route53:getRecords
      arguments:
        zoneId: ${selected.zoneId}
        nameRegex: ^www

args Arguments passed to this invoke. Arguments for getRecords. options Invoke options controlling this call.

Implementation

Future<GetRecordsResult> getRecords(
  GetRecordsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:route53/getRecords:getRecords',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetRecordsResult.fromMap(result);
}