@pulumi/hcloud
Version:
A Pulumi package for creating and managing hcloud cloud resources.
122 lines • 3.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides details about a specific Hetzner Cloud Placement Group.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as hcloud from "@pulumi/hcloud";
*
* const samplePlacementGroup1 = hcloud.getPlacementGroup({
* name: "sample-placement-group-1",
* });
* const samplePlacementGroup2 = hcloud.getPlacementGroup({
* id: 4711,
* });
* ```
*/
export declare function getPlacementGroup(args?: GetPlacementGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetPlacementGroupResult>;
/**
* A collection of arguments for invoking getPlacementGroup.
*/
export interface GetPlacementGroupArgs {
/**
* ID of the placement group.
*/
id?: number;
/**
* (map) User-defined labels (key-value pairs)
*/
labels?: {
[key: string]: string;
};
/**
* Return most recent placement group if multiple are found.
*/
mostRecent?: boolean;
/**
* Name of the placement group.
*/
name?: string;
/**
* (string) Type of the Placement Group.
*/
type?: string;
/**
* [Label selector](https://docs.hetzner.cloud/reference/cloud#label-selector)
*/
withSelector?: string;
}
/**
* A collection of values returned by getPlacementGroup.
*/
export interface GetPlacementGroupResult {
/**
* (int) Unique ID of the Placement Group.
*/
readonly id: number;
/**
* (map) User-defined labels (key-value pairs)
*/
readonly labels: {
[key: string]: string;
};
readonly mostRecent?: boolean;
/**
* (string) Name of the Placement Group.
*/
readonly name: string;
readonly servers: number[];
/**
* (string) Type of the Placement Group.
*/
readonly type: string;
readonly withSelector?: string;
}
/**
* Provides details about a specific Hetzner Cloud Placement Group.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as hcloud from "@pulumi/hcloud";
*
* const samplePlacementGroup1 = hcloud.getPlacementGroup({
* name: "sample-placement-group-1",
* });
* const samplePlacementGroup2 = hcloud.getPlacementGroup({
* id: 4711,
* });
* ```
*/
export declare function getPlacementGroupOutput(args?: GetPlacementGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPlacementGroupResult>;
/**
* A collection of arguments for invoking getPlacementGroup.
*/
export interface GetPlacementGroupOutputArgs {
/**
* ID of the placement group.
*/
id?: pulumi.Input<number | undefined>;
/**
* (map) User-defined labels (key-value pairs)
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Return most recent placement group if multiple are found.
*/
mostRecent?: pulumi.Input<boolean | undefined>;
/**
* Name of the placement group.
*/
name?: pulumi.Input<string | undefined>;
/**
* (string) Type of the Placement Group.
*/
type?: pulumi.Input<string | undefined>;
/**
* [Label selector](https://docs.hetzner.cloud/reference/cloud#label-selector)
*/
withSelector?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getPlacementGroup.d.ts.map