@pulumi/yandex
Version:
A Pulumi package for creating and managing yandex cloud resources.
101 lines (100 loc) • 2.81 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Get information about a Yandex Compute Placement group. For more information, see
* [the official documentation](https://cloud.yandex.com/docs/compute/concepts/placement-groups).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as yandex from "@pulumi/yandex";
*
* const myGroup = pulumi.output(yandex.getComputePlacementGroup({
* groupId: "some_group_id",
* }));
*
* export const placementGroupName = myGroup.name!;
* ```
*/
export declare function getComputePlacementGroup(args?: GetComputePlacementGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetComputePlacementGroupResult>;
/**
* A collection of arguments for invoking getComputePlacementGroup.
*/
export interface GetComputePlacementGroupArgs {
/**
* Description of the group.
*/
description?: string;
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: string;
/**
* The ID of a specific group.
*/
groupId?: string;
/**
* A set of key/value label pairs assigned to the group.
*/
labels?: {
[key: string]: string;
};
/**
* Name of the group.
*/
name?: string;
}
/**
* A collection of values returned by getComputePlacementGroup.
*/
export interface GetComputePlacementGroupResult {
/**
* Placement group creation timestamp.
*/
readonly createdAt: string;
/**
* Description of the group.
*/
readonly description?: string;
readonly folderId: string;
readonly groupId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* A set of key/value label pairs assigned to the group.
*/
readonly labels?: {
[key: string]: string;
};
readonly name?: string;
}
export declare function getComputePlacementGroupOutput(args?: GetComputePlacementGroupOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetComputePlacementGroupResult>;
/**
* A collection of arguments for invoking getComputePlacementGroup.
*/
export interface GetComputePlacementGroupOutputArgs {
/**
* Description of the group.
*/
description?: pulumi.Input<string>;
/**
* Folder that the resource belongs to. If value is omitted, the default provider folder is used.
*/
folderId?: pulumi.Input<string>;
/**
* The ID of a specific group.
*/
groupId?: pulumi.Input<string>;
/**
* A set of key/value label pairs assigned to the group.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the group.
*/
name?: pulumi.Input<string>;
}