@pulumi/linode/placementGroup.d.ts

A Pulumi package for creating and managing linode cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * Manages a Linode Placement Group.
 * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/post-placement-group).
 *
 * ## Example Usage
 *
 * Create a Placement Group with the local anti-affinity policy:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as linode from "@pulumi/linode";
 *
 * const test = new linode.PlacementGroup("test", {
 *     label: "my-placement-group",
 *     region: "us-mia",
 *     placementGroupType: "anti_affinity:local",
 * });
 * ```
 *
 * ## Import
 *
 * Placement Groups be imported using their unique `id`, e.g.
 *
 * ```sh
 * $ pulumi import linode:index/placementGroup:PlacementGroup mygroup 1234567
 * ```
 */
export declare class PlacementGroup extends pulumi.CustomResource {
    /**
     * Get an existing PlacementGroup resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: PlacementGroupState, opts?: pulumi.CustomResourceOptions): PlacementGroup;
    /**
     * Returns true if the given object is an instance of PlacementGroup.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is PlacementGroup;
    /**
     * Whether this Linode is currently compliant with the group's placement group type.
     */
    readonly isCompliant: pulumi.Output<boolean>;
    /**
     * The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
     */
    readonly label: pulumi.Output<string>;
    /**
     * A set of Linodes currently assigned to this Placement Group.
     */
    readonly members: pulumi.Output<outputs.PlacementGroupMember[]>;
    /**
     * Whether Linodes must be able to become compliant during assignment. (Default `strict`)
     */
    readonly placementGroupPolicy: pulumi.Output<string>;
    /**
     * The placement group type to use when placing Linodes in this group.
     */
    readonly placementGroupType: pulumi.Output<string>;
    /**
     * The region of the Placement Group.
     */
    readonly region: pulumi.Output<string>;
    /**
     * Create a PlacementGroup resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: PlacementGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering PlacementGroup resources.
 */
export interface PlacementGroupState {
    /**
     * Whether this Linode is currently compliant with the group's placement group type.
     */
    isCompliant?: pulumi.Input<boolean>;
    /**
     * The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
     */
    label?: pulumi.Input<string>;
    /**
     * A set of Linodes currently assigned to this Placement Group.
     */
    members?: pulumi.Input<pulumi.Input<inputs.PlacementGroupMember>[]>;
    /**
     * Whether Linodes must be able to become compliant during assignment. (Default `strict`)
     */
    placementGroupPolicy?: pulumi.Input<string>;
    /**
     * The placement group type to use when placing Linodes in this group.
     */
    placementGroupType?: pulumi.Input<string>;
    /**
     * The region of the Placement Group.
     */
    region?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a PlacementGroup resource.
 */
export interface PlacementGroupArgs {
    /**
     * The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
     */
    label: pulumi.Input<string>;
    /**
     * Whether Linodes must be able to become compliant during assignment. (Default `strict`)
     */
    placementGroupPolicy?: pulumi.Input<string>;
    /**
     * The placement group type to use when placing Linodes in this group.
     */
    placementGroupType: pulumi.Input<string>;
    /**
     * The region of the Placement Group.
     */
    region: pulumi.Input<string>;
}