@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
108 lines (107 loc) • 4.04 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a single assignment between a Linode and a Placement Group.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/post-group-add-linode).
*
* To prevent update conflicts, Linodes managed through the `linode.Instance` resource should specify `placementGroupExternallyManaged`:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_instance = new linode.Instance("my-instance", {placementGroupExternallyManaged: true});
* ```
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_pg = new linode.PlacementGroup("my-pg", {
* label: "my-pg",
* region: "us-east",
* placementGroupType: "anti_affinity:local",
* });
* const my_inst = new linode.Instance("my-inst", {
* label: "my-inst",
* region: "us-east",
* type: "g6-nanode-1",
* placementGroupExternallyManaged: true,
* });
* const my_assignment = new linode.PlacementGroupAssignment("my-assignment", {
* placementGroupId: my_pg.id,
* linodeId: my_inst.id,
* });
* ```
*
* ## Import
*
* Placement Group assignments can be imported using the Placement Group's ID followed by the Linode's ID separated by a comma, e.g.
*
* ```sh
* $ pulumi import linode:index/placementGroupAssignment:PlacementGroupAssignment my-assignment 1234567,7654321
* ```
*/
export declare class PlacementGroupAssignment extends pulumi.CustomResource {
/**
* Get an existing PlacementGroupAssignment 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?: PlacementGroupAssignmentState, opts?: pulumi.CustomResourceOptions): PlacementGroupAssignment;
/**
* Returns true if the given object is an instance of PlacementGroupAssignment. 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 PlacementGroupAssignment;
readonly compliantOnly: pulumi.Output<boolean | undefined>;
/**
* The unique ID of the Linode to assign.
*/
readonly linodeId: pulumi.Output<number>;
/**
* The unique ID of the target Placement Group.
*/
readonly placementGroupId: pulumi.Output<number>;
/**
* Create a PlacementGroupAssignment 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: PlacementGroupAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PlacementGroupAssignment resources.
*/
export interface PlacementGroupAssignmentState {
compliantOnly?: pulumi.Input<boolean>;
/**
* The unique ID of the Linode to assign.
*/
linodeId?: pulumi.Input<number>;
/**
* The unique ID of the target Placement Group.
*/
placementGroupId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a PlacementGroupAssignment resource.
*/
export interface PlacementGroupAssignmentArgs {
compliantOnly?: pulumi.Input<boolean>;
/**
* The unique ID of the Linode to assign.
*/
linodeId: pulumi.Input<number>;
/**
* The unique ID of the target Placement Group.
*/
placementGroupId: pulumi.Input<number>;
}