import * as pulumi from "@pulumi/pulumi"; import * as outputs from "./types/output"; /** * Use this data source to get detailed information of SiteBacker (SB) pool records. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as ultradns from "@pulumi/ultradns"; * * const sbpool = pulumi.output(ultradns.getSbPool({ * ownerName: "www", * recordType: "A", * zoneName: "example.com.", * })); * ``` */ export declare function getSbPool(args: GetSbPoolArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getSbPool. */ export interface GetSbPoolArgs { /** * (String) The domain name of the owner of the RRSet. Can be either a fully qualified domain name (FQDN) or a relative domain name. If provided as a FQDN, it must be contained within the zone name's FQDN. */ ownerName: string; /** * (String) Must be formatted as a well-known resource record type (A), or the corresponding number for the type (1).
* Below are the supported resource record types with the corresponding number:
* `A (1)` */ recordType: string; /** * (String) Name of the zone. */ zoneName: string; } /** * A collection of values returned by getSbPool. */ export interface GetSbPoolResult { /** * (Computed) (Boolean) Indicates whether or not pool records will be enabled (true) or disabled (false) when probes are run. */ readonly actOnProbes: boolean; /** * (Computed) (Block Set) List of nested blocks describing the information of backup records for the SiteBacker pool. Specifies the records to be served if all other records fail. There can be one or more A records used as backup records, or a single CNAME record. The structure of this block is described below. */ readonly backupRecords: outputs.GetSbPoolBackupRecord[]; /** * (Computed) (Integer) The minimum number of records that must fail for a pool to be labeled 'FAILED'. If the number of failed records in the pool is greater than or equal to the 'Failure Threshold' value, the pool will be labeled FAILED.
* For example, a pool with six priority records, one all-fail record, and the Failure Threshold value is set to four (4). If four or more priority records are not available to serve, the pool will be labeled FAILED, and the all-fail record will be served.
*/ readonly failureThreshold: number; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * (Computed) (Integer) Specifies the maximum number of active servers in a pool and determines when SiteBacker takes backup servers offline.
* For example, consider a pool with six servers. Setting Max Active to 4 means SiteBacker takes two servers offline and sends the four active records in the answer. */ readonly maxActive: number; /** * (Computed) (Integer) Determines the number of record answers for each query. This is typically All Active records, or a subset of Max Active. */ readonly maxServed: number; /** * (Computed) (String) Indicates the order of the records returned by the resolver for the SiteBacker pool. */ readonly order: string; readonly ownerName: string; /** * (Computed) (String) An optional description of the SiteBacker (SB) field. */ readonly poolDescription: string; /** * (Computed) (Block Set) List of nested blocks describing the pool records. The structure of this block is described below. */ readonly rdataInfos: outputs.GetSbPoolRdataInfo[]; readonly recordType: string; /** * (Computed) (Boolean) Indicates whether or not probes are run for this pool record. */ readonly runProbes: boolean; /** * (Computed) (String) Current status of the serving record. Valid values are:
* `OK`- If the number of records serving is equal to the Max Active value, and all the active records are top priority records.
* For example, if a pool has a Max Active of 1 and the Priority 1 record is serving.
* `WARNING` – If the number of records serving is equal to the Max Active value, and the active records are not top priority records.
* For example, if a pool has a Max Active of 1 and the Priority 1 records is not serving and the Priority 2 record is serving.
* `CRITICAL` – If the number of records serving is less than the Max Active value, or the All Fail record is being served.
* For example, if a pool has a Max Active of 2, and only one record is serving.
* `FAILED` - If the FailureThreshold value is 0 or null, and no records are serving, and there is no All Fail record configured.
OR
If the number of priority records not available to serve equals or exceeds the FailureThreshold’s value.
* For example, if the Failure Threshold value is 3, and there are 3 or more Priority Records that are not available to serve. */ readonly status: string; /** * (Computed) (Integer) The time to live (in seconds) for the record. Must be a value between 0 and 2147483647, inclusive. */ readonly ttl: number; readonly zoneName: string; } export declare function getSbPoolOutput(args: GetSbPoolOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output; /** * A collection of arguments for invoking getSbPool. */ export interface GetSbPoolOutputArgs { /** * (String) The domain name of the owner of the RRSet. Can be either a fully qualified domain name (FQDN) or a relative domain name. If provided as a FQDN, it must be contained within the zone name's FQDN. */ ownerName: pulumi.Input; /** * (String) Must be formatted as a well-known resource record type (A), or the corresponding number for the type (1).
* Below are the supported resource record types with the corresponding number:
* `A (1)` */ recordType: pulumi.Input; /** * (String) Name of the zone. */ zoneName: pulumi.Input; }