@pulumi/hcloud
Version:
A Pulumi package for creating and managing hcloud cloud resources.
156 lines • 4.22 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Provides details about a Hetzner Cloud Zone Resource Record Set (RRSet).
*
* See the [Zone RRSets API documentation](https://docs.hetzner.cloud/reference/cloud#zone-rrsets) for more details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as hcloud from "@pulumi/hcloud";
*
* const example = hcloud.getZone({
* name: "example.com",
* });
* const byId = example.then(example => hcloud.getZoneRrset({
* zone: example.name,
* id: "www/A",
* }));
* const byNameAndType = example.then(example => hcloud.getZoneRrset({
* zone: example.name,
* name: "www",
* type: "A",
* }));
* const byLabel = example.then(example => hcloud.getZoneRrset({
* zone: example.name,
* withSelector: "key=value",
* }));
* ```
*/
export declare function getZoneRrset(args: GetZoneRrsetArgs, opts?: pulumi.InvokeOptions): Promise<GetZoneRrsetResult>;
/**
* A collection of arguments for invoking getZoneRrset.
*/
export interface GetZoneRrsetArgs {
/**
* ID of the Zone RRSet.
*/
id?: string;
/**
* Name of the Zone RRSet.
*/
name?: string;
/**
* Type of the Zone RRSet.
*/
type?: string;
/**
* Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/cloud#label-selector).
*/
withSelector?: string;
/**
* ID or Name of the parent Zone.
*/
zone: string;
}
/**
* A collection of values returned by getZoneRrset.
*/
export interface GetZoneRrsetResult {
/**
* Whether change protection is enabled.
*/
readonly changeProtection: boolean;
/**
* ID of the Zone RRSet.
*/
readonly id?: string;
/**
* User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
*/
readonly labels: {
[key: string]: string;
};
/**
* Name of the Zone RRSet.
*/
readonly name?: string;
/**
* Records of the Zone RRSet.
*/
readonly records: outputs.GetZoneRrsetRecord[];
/**
* Time To Live (TTL) of the Zone RRSet.
*/
readonly ttl: number;
/**
* Type of the Zone RRSet.
*/
readonly type?: string;
/**
* Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/cloud#label-selector).
*/
readonly withSelector?: string;
/**
* ID or Name of the parent Zone.
*/
readonly zone: string;
}
/**
* Provides details about a Hetzner Cloud Zone Resource Record Set (RRSet).
*
* See the [Zone RRSets API documentation](https://docs.hetzner.cloud/reference/cloud#zone-rrsets) for more details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as hcloud from "@pulumi/hcloud";
*
* const example = hcloud.getZone({
* name: "example.com",
* });
* const byId = example.then(example => hcloud.getZoneRrset({
* zone: example.name,
* id: "www/A",
* }));
* const byNameAndType = example.then(example => hcloud.getZoneRrset({
* zone: example.name,
* name: "www",
* type: "A",
* }));
* const byLabel = example.then(example => hcloud.getZoneRrset({
* zone: example.name,
* withSelector: "key=value",
* }));
* ```
*/
export declare function getZoneRrsetOutput(args: GetZoneRrsetOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetZoneRrsetResult>;
/**
* A collection of arguments for invoking getZoneRrset.
*/
export interface GetZoneRrsetOutputArgs {
/**
* ID of the Zone RRSet.
*/
id?: pulumi.Input<string | undefined>;
/**
* Name of the Zone RRSet.
*/
name?: pulumi.Input<string | undefined>;
/**
* Type of the Zone RRSet.
*/
type?: pulumi.Input<string | undefined>;
/**
* Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/cloud#label-selector).
*/
withSelector?: pulumi.Input<string | undefined>;
/**
* ID or Name of the parent Zone.
*/
zone: pulumi.Input<string>;
}
//# sourceMappingURL=getZoneRrset.d.ts.map