@pulumi/aws/route53/getRecords.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * 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.
 *
 * ```typescript
 * 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,
 * }));
 * ```
 *
 * ### Basic Usage with filter
 *
 * Return the records that starts with `www`.
 *
 * ```typescript
 * 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",
 * }));
 * ```
 */
export declare function getRecords(args: GetRecordsArgs, opts?: pulumi.InvokeOptions): Promise<GetRecordsResult>;
/**
 * A collection of arguments for invoking getRecords.
 */
export interface GetRecordsArgs {
    /**
     * Regex string to apply to the resource record names returned by AWS.
     */
    nameRegex?: string;
    /**
     * The ID of the hosted zone that contains the resource record sets that you want to list.
     */
    zoneId: string;
}
/**
 * A collection of values returned by getRecords.
 */
export interface GetRecordsResult {
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly nameRegex?: string;
    /**
     * The resource records sets.
     */
    readonly resourceRecordSets: outputs.route53.GetRecordsResourceRecordSet[];
    readonly zoneId: string;
}
/**
 * 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.
 *
 * ```typescript
 * 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,
 * }));
 * ```
 *
 * ### Basic Usage with filter
 *
 * Return the records that starts with `www`.
 *
 * ```typescript
 * 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",
 * }));
 * ```
 */
export declare function getRecordsOutput(args: GetRecordsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRecordsResult>;
/**
 * A collection of arguments for invoking getRecords.
 */
export interface GetRecordsOutputArgs {
    /**
     * Regex string to apply to the resource record names returned by AWS.
     */
    nameRegex?: pulumi.Input<string>;
    /**
     * The ID of the hosted zone that contains the resource record sets that you want to list.
     */
    zoneId: pulumi.Input<string>;
}