pulumi-aws-kotlin/com.pulumi.aws.route53.kotlin/Route53Functions/getRecords

getRecords

suspend fun getRecords(argument: GetRecordsPlainArgs): GetRecordsResult

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,
}));
Content copied to clipboard
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)
Content copied to clipboard
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),
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}
Content copied to clipboard
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.List;
import java.util.ArrayList;
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());
    }
}
Content copied to clipboard
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}
Content copied to clipboard

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",
}));
Content copied to clipboard
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")
Content copied to clipboard
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",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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
	})
}
Content copied to clipboard
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.List;
import java.util.ArrayList;
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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

Return

A collection of values returned by getRecords.

Parameters

argument

A collection of arguments for invoking getRecords.

suspend fun getRecords(nameRegex: String? = null, zoneId: String): GetRecordsResult

Return

A collection of values returned by getRecords.

Parameters

nameRegex

Regex string to apply to the resource record names returned by AWS.

zoneId

The ID of the hosted zone that contains the resource record sets that you want to list.

See also

.

suspend fun getRecords(argument: suspend GetRecordsPlainArgsBuilder.() -> Unit): GetRecordsResult

Return

A collection of values returned by getRecords.

Parameters

argument

Builder for com.pulumi.aws.route53.kotlin.inputs.GetRecordsPlainArgs.

See also

.