Linode v4.35.0 published on Wednesday, Mar 12, 2025 by Pulumi
linode.getPlacementGroup
Explore with Pulumi AI
linode.PlacementGroup provides details about a Linode placement group.
For more information, see the Linode APIv4 docs.
Example Usage
The following example shows how the resource might be used to obtain additional information about a Linode placement group.
import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";
const pg = linode.getPlacementGroup({
    id: 12345,
});
import pulumi
import pulumi_linode as linode
pg = linode.get_placement_group(id=12345)
package main
import (
	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := linode.LookupPlacementGroup(ctx, &linode.LookupPlacementGroupArgs{
			Id: 12345,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;
return await Deployment.RunAsync(() => 
{
    var pg = Linode.GetPlacementGroup.Invoke(new()
    {
        Id = 12345,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetPlacementGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var pg = LinodeFunctions.getPlacementGroup(GetPlacementGroupArgs.builder()
            .id(12345)
            .build());
    }
}
variables:
  pg:
    fn::invoke:
      function: linode:getPlacementGroup
      arguments:
        id: 12345
Using getPlacementGroup
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPlacementGroup(args: GetPlacementGroupArgs, opts?: InvokeOptions): Promise<GetPlacementGroupResult>
function getPlacementGroupOutput(args: GetPlacementGroupOutputArgs, opts?: InvokeOptions): Output<GetPlacementGroupResult>def get_placement_group(id: Optional[int] = None,
                        members: Optional[Sequence[GetPlacementGroupMember]] = None,
                        migrations: Optional[GetPlacementGroupMigrations] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPlacementGroupResult
def get_placement_group_output(id: Optional[pulumi.Input[int]] = None,
                        members: Optional[pulumi.Input[Sequence[pulumi.Input[GetPlacementGroupMemberArgs]]]] = None,
                        migrations: Optional[pulumi.Input[GetPlacementGroupMigrationsArgs]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPlacementGroupResult]func LookupPlacementGroup(ctx *Context, args *LookupPlacementGroupArgs, opts ...InvokeOption) (*LookupPlacementGroupResult, error)
func LookupPlacementGroupOutput(ctx *Context, args *LookupPlacementGroupOutputArgs, opts ...InvokeOption) LookupPlacementGroupResultOutput> Note: This function is named LookupPlacementGroup in the Go SDK.
public static class GetPlacementGroup 
{
    public static Task<GetPlacementGroupResult> InvokeAsync(GetPlacementGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPlacementGroupResult> Invoke(GetPlacementGroupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPlacementGroupResult> getPlacementGroup(GetPlacementGroupArgs args, InvokeOptions options)
public static Output<GetPlacementGroupResult> getPlacementGroup(GetPlacementGroupArgs args, InvokeOptions options)
fn::invoke:
  function: linode:index/getPlacementGroup:getPlacementGroup
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Id int
- The ID of the Placement Group.
- Members
List<GetPlacement Group Member> 
- A set of Linodes currently assigned to this Placement Group.
- Migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- Id int
- The ID of the Placement Group.
- Members
[]GetPlacement Group Member 
- A set of Linodes currently assigned to this Placement Group.
- Migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- id Integer
- The ID of the Placement Group.
- members
List<GetPlacement Group Member> 
- A set of Linodes currently assigned to this Placement Group.
- migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- id number
- The ID of the Placement Group.
- members
GetPlacement Group Member[] 
- A set of Linodes currently assigned to this Placement Group.
- migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- id int
- The ID of the Placement Group.
- members
Sequence[GetPlacement Group Member] 
- A set of Linodes currently assigned to this Placement Group.
- migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- id Number
- The ID of the Placement Group.
- members List<Property Map>
- A set of Linodes currently assigned to this Placement Group.
- migrations Property Map
- Any Linodes that are being migrated to or from the placement group.
getPlacementGroup Result
The following output properties are available:
- Id int
- IsCompliant bool
- Whether this Linode is currently compliant with the group's placement group type.
- Label string
- The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
- PlacementGroup stringPolicy 
- Whether Linodes must be able to become compliant during assignment. (Default strict)
- PlacementGroup stringType 
- The placement group type to use when placing Linodes in this group.
- Region string
- The region of the Placement Group.
- Members
List<GetPlacement Group Member> 
- A set of Linodes currently assigned to this Placement Group.
- Migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- Id int
- IsCompliant bool
- Whether this Linode is currently compliant with the group's placement group type.
- Label string
- The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
- PlacementGroup stringPolicy 
- Whether Linodes must be able to become compliant during assignment. (Default strict)
- PlacementGroup stringType 
- The placement group type to use when placing Linodes in this group.
- Region string
- The region of the Placement Group.
- Members
[]GetPlacement Group Member 
- A set of Linodes currently assigned to this Placement Group.
- Migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- id Integer
- isCompliant Boolean
- Whether this Linode is currently compliant with the group's placement group type.
- label String
- The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
- placementGroup StringPolicy 
- Whether Linodes must be able to become compliant during assignment. (Default strict)
- placementGroup StringType 
- The placement group type to use when placing Linodes in this group.
- region String
- The region of the Placement Group.
- members
List<GetPlacement Group Member> 
- A set of Linodes currently assigned to this Placement Group.
- migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- id number
- isCompliant boolean
- Whether this Linode is currently compliant with the group's placement group type.
- label string
- The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
- placementGroup stringPolicy 
- Whether Linodes must be able to become compliant during assignment. (Default strict)
- placementGroup stringType 
- The placement group type to use when placing Linodes in this group.
- region string
- The region of the Placement Group.
- members
GetPlacement Group Member[] 
- A set of Linodes currently assigned to this Placement Group.
- migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- id int
- is_compliant bool
- Whether this Linode is currently compliant with the group's placement group type.
- label str
- The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
- placement_group_ strpolicy 
- Whether Linodes must be able to become compliant during assignment. (Default strict)
- placement_group_ strtype 
- The placement group type to use when placing Linodes in this group.
- region str
- The region of the Placement Group.
- members
Sequence[GetPlacement Group Member] 
- A set of Linodes currently assigned to this Placement Group.
- migrations
GetPlacement Group Migrations 
- Any Linodes that are being migrated to or from the placement group.
- id Number
- isCompliant Boolean
- Whether this Linode is currently compliant with the group's placement group type.
- label String
- The label of the Placement Group. This field can only contain ASCII letters, digits and dashes.
- placementGroup StringPolicy 
- Whether Linodes must be able to become compliant during assignment. (Default strict)
- placementGroup StringType 
- The placement group type to use when placing Linodes in this group.
- region String
- The region of the Placement Group.
- members List<Property Map>
- A set of Linodes currently assigned to this Placement Group.
- migrations Property Map
- Any Linodes that are being migrated to or from the placement group.
Supporting Types
GetPlacementGroupMember   
- IsCompliant bool
- Whether this Linode is currently compliant with the group's placement group type.
- LinodeId int
- The ID of the Linode.
- IsCompliant bool
- Whether this Linode is currently compliant with the group's placement group type.
- LinodeId int
- The ID of the Linode.
- isCompliant Boolean
- Whether this Linode is currently compliant with the group's placement group type.
- linodeId Integer
- The ID of the Linode.
- isCompliant boolean
- Whether this Linode is currently compliant with the group's placement group type.
- linodeId number
- The ID of the Linode.
- is_compliant bool
- Whether this Linode is currently compliant with the group's placement group type.
- linode_id int
- The ID of the Linode.
- isCompliant Boolean
- Whether this Linode is currently compliant with the group's placement group type.
- linodeId Number
- The ID of the Linode.
GetPlacementGroupMigrations   
- Inbounds
List<GetPlacement Group Migrations Inbound> 
- A list of the Linodes the system is migrating into the placement group.
- Outbounds
List<GetPlacement Group Migrations Outbound> 
- A list of the Linodes the system is migrating out of the placement group.
- Inbounds
[]GetPlacement Group Migrations Inbound 
- A list of the Linodes the system is migrating into the placement group.
- Outbounds
[]GetPlacement Group Migrations Outbound 
- A list of the Linodes the system is migrating out of the placement group.
- inbounds
List<GetPlacement Group Migrations Inbound> 
- A list of the Linodes the system is migrating into the placement group.
- outbounds
List<GetPlacement Group Migrations Outbound> 
- A list of the Linodes the system is migrating out of the placement group.
- inbounds
GetPlacement Group Migrations Inbound[] 
- A list of the Linodes the system is migrating into the placement group.
- outbounds
GetPlacement Group Migrations Outbound[] 
- A list of the Linodes the system is migrating out of the placement group.
- inbounds
Sequence[GetPlacement Group Migrations Inbound] 
- A list of the Linodes the system is migrating into the placement group.
- outbounds
Sequence[GetPlacement Group Migrations Outbound] 
- A list of the Linodes the system is migrating out of the placement group.
- inbounds List<Property Map>
- A list of the Linodes the system is migrating into the placement group.
- outbounds List<Property Map>
- A list of the Linodes the system is migrating out of the placement group.
GetPlacementGroupMigrationsInbound    
- LinodeId int
- The ID of the Linode.
- LinodeId int
- The ID of the Linode.
- linodeId Integer
- The ID of the Linode.
- linodeId number
- The ID of the Linode.
- linode_id int
- The ID of the Linode.
- linodeId Number
- The ID of the Linode.
GetPlacementGroupMigrationsOutbound    
- LinodeId int
- The ID of the Linode.
- LinodeId int
- The ID of the Linode.
- linodeId Integer
- The ID of the Linode.
- linodeId number
- The ID of the Linode.
- linode_id int
- The ID of the Linode.
- linodeId Number
- The ID of the Linode.
Package Details
- Repository
- Linode pulumi/pulumi-linode
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the linodeTerraform Provider.