@pulumi/ns1/getRecord.d.ts

A Pulumi package for creating and managing ns1 cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Provides details about a NS1 Record. Use this if you would simply like to read
 * information from NS1 into your configurations. For read/write operations, you
 * should use a resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as ns1 from "@pulumi/ns1";
 *
 * // Get details about a NS1 Record.
 * const example = ns1.getRecord({
 *     zone: "example.io",
 *     domain: "terraform.example.io",
 *     type: "A",
 * });
 * ```
 */
export declare function getRecord(args: GetRecordArgs, opts?: pulumi.InvokeOptions): Promise<GetRecordResult>;
/**
 * A collection of arguments for invoking getRecord.
 */
export interface GetRecordArgs {
    /**
     * The records' domain.
     */
    domain: string;
    /**
     * The records' RR type.
     */
    type: string;
    /**
     * The zone the record belongs to.
     */
    zone: string;
}
/**
 * A collection of values returned by getRecord.
 */
export interface GetRecordResult {
    /**
     * List of NS1 answers.
     */
    readonly answers: outputs.GetRecordAnswer[];
    readonly domain: string;
    /**
     * List of NS1 filters.
     */
    readonly filters: outputs.GetRecordFilter[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * The target record this links to.
     */
    readonly link: string;
    /**
     * Map of metadata
     */
    readonly meta: {
        [key: string]: string;
    };
    readonly overrideAddressRecords: boolean;
    readonly overrideTtl: boolean;
    /**
     * List of regions.
     */
    readonly regions: outputs.GetRecordRegion[];
    readonly shortAnswers: string[];
    readonly tags: {
        [key: string]: string;
    };
    /**
     * The records' time to live (in seconds).
     */
    readonly ttl: number;
    readonly type: string;
    /**
     * Whether to use EDNS client subnet data when available (in filter chain).
     */
    readonly useClientSubnet: boolean;
    readonly zone: string;
}
/**
 * Provides details about a NS1 Record. Use this if you would simply like to read
 * information from NS1 into your configurations. For read/write operations, you
 * should use a resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as ns1 from "@pulumi/ns1";
 *
 * // Get details about a NS1 Record.
 * const example = ns1.getRecord({
 *     zone: "example.io",
 *     domain: "terraform.example.io",
 *     type: "A",
 * });
 * ```
 */
export declare function getRecordOutput(args: GetRecordOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRecordResult>;
/**
 * A collection of arguments for invoking getRecord.
 */
export interface GetRecordOutputArgs {
    /**
     * The records' domain.
     */
    domain: pulumi.Input<string>;
    /**
     * The records' RR type.
     */
    type: pulumi.Input<string>;
    /**
     * The zone the record belongs to.
     */
    zone: pulumi.Input<string>;
}