1. Packages
  2. Linode Provider
  3. API Docs
  4. getPlacementGroup
Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi

linode.getPlacementGroup

Explore with Pulumi AI

Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi

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,
});
Copy
import pulumi
import pulumi_linode as linode

pg = linode.get_placement_group(id=12345)
Copy
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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
variables:
  pg:
    fn::invoke:
      function: linode:getPlacementGroup
      arguments:
        id: 12345
Copy

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>
Copy
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]
Copy
func LookupPlacementGroup(ctx *Context, args *LookupPlacementGroupArgs, opts ...InvokeOption) (*LookupPlacementGroupResult, error)
func LookupPlacementGroupOutput(ctx *Context, args *LookupPlacementGroupOutputArgs, opts ...InvokeOption) LookupPlacementGroupResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPlacementGroupResult> getPlacementGroup(GetPlacementGroupArgs args, InvokeOptions options)
public static Output<GetPlacementGroupResult> getPlacementGroup(GetPlacementGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: linode:index/getPlacementGroup:getPlacementGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. int
The ID of the Placement Group.
Members List<GetPlacementGroupMember>
A set of Linodes currently assigned to this Placement Group.
Migrations GetPlacementGroupMigrations
Any Linodes that are being migrated to or from the placement group.
Id This property is required. int
The ID of the Placement Group.
Members []GetPlacementGroupMember
A set of Linodes currently assigned to this Placement Group.
Migrations GetPlacementGroupMigrations
Any Linodes that are being migrated to or from the placement group.
id This property is required. Integer
The ID of the Placement Group.
members List<GetPlacementGroupMember>
A set of Linodes currently assigned to this Placement Group.
migrations GetPlacementGroupMigrations
Any Linodes that are being migrated to or from the placement group.
id This property is required. number
The ID of the Placement Group.
members GetPlacementGroupMember[]
A set of Linodes currently assigned to this Placement Group.
migrations GetPlacementGroupMigrations
Any Linodes that are being migrated to or from the placement group.
id This property is required. int
The ID of the Placement Group.
members Sequence[GetPlacementGroupMember]
A set of Linodes currently assigned to this Placement Group.
migrations GetPlacementGroupMigrations
Any Linodes that are being migrated to or from the placement group.
id This property is required. 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.
PlacementGroupPolicy string
Whether Linodes must be able to become compliant during assignment. (Default strict)
PlacementGroupType string
The placement group type to use when placing Linodes in this group.
Region string
The region of the Placement Group.
Members List<GetPlacementGroupMember>
A set of Linodes currently assigned to this Placement Group.
Migrations GetPlacementGroupMigrations
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.
PlacementGroupPolicy string
Whether Linodes must be able to become compliant during assignment. (Default strict)
PlacementGroupType string
The placement group type to use when placing Linodes in this group.
Region string
The region of the Placement Group.
Members []GetPlacementGroupMember
A set of Linodes currently assigned to this Placement Group.
Migrations GetPlacementGroupMigrations
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.
placementGroupPolicy String
Whether Linodes must be able to become compliant during assignment. (Default strict)
placementGroupType String
The placement group type to use when placing Linodes in this group.
region String
The region of the Placement Group.
members List<GetPlacementGroupMember>
A set of Linodes currently assigned to this Placement Group.
migrations GetPlacementGroupMigrations
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.
placementGroupPolicy string
Whether Linodes must be able to become compliant during assignment. (Default strict)
placementGroupType string
The placement group type to use when placing Linodes in this group.
region string
The region of the Placement Group.
members GetPlacementGroupMember[]
A set of Linodes currently assigned to this Placement Group.
migrations GetPlacementGroupMigrations
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_policy str
Whether Linodes must be able to become compliant during assignment. (Default strict)
placement_group_type str
The placement group type to use when placing Linodes in this group.
region str
The region of the Placement Group.
members Sequence[GetPlacementGroupMember]
A set of Linodes currently assigned to this Placement Group.
migrations GetPlacementGroupMigrations
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.
placementGroupPolicy String
Whether Linodes must be able to become compliant during assignment. (Default strict)
placementGroupType String
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 This property is required. bool
Whether this Linode is currently compliant with the group's placement group type.
LinodeId This property is required. int
The ID of the Linode.
IsCompliant This property is required. bool
Whether this Linode is currently compliant with the group's placement group type.
LinodeId This property is required. int
The ID of the Linode.
isCompliant This property is required. Boolean
Whether this Linode is currently compliant with the group's placement group type.
linodeId This property is required. Integer
The ID of the Linode.
isCompliant This property is required. boolean
Whether this Linode is currently compliant with the group's placement group type.
linodeId This property is required. number
The ID of the Linode.
is_compliant This property is required. bool
Whether this Linode is currently compliant with the group's placement group type.
linode_id This property is required. int
The ID of the Linode.
isCompliant This property is required. Boolean
Whether this Linode is currently compliant with the group's placement group type.
linodeId This property is required. Number
The ID of the Linode.

GetPlacementGroupMigrations

Inbounds This property is required. List<GetPlacementGroupMigrationsInbound>
A list of the Linodes the system is migrating into the placement group.
Outbounds This property is required. List<GetPlacementGroupMigrationsOutbound>
A list of the Linodes the system is migrating out of the placement group.
Inbounds This property is required. []GetPlacementGroupMigrationsInbound
A list of the Linodes the system is migrating into the placement group.
Outbounds This property is required. []GetPlacementGroupMigrationsOutbound
A list of the Linodes the system is migrating out of the placement group.
inbounds This property is required. List<GetPlacementGroupMigrationsInbound>
A list of the Linodes the system is migrating into the placement group.
outbounds This property is required. List<GetPlacementGroupMigrationsOutbound>
A list of the Linodes the system is migrating out of the placement group.
inbounds This property is required. GetPlacementGroupMigrationsInbound[]
A list of the Linodes the system is migrating into the placement group.
outbounds This property is required. GetPlacementGroupMigrationsOutbound[]
A list of the Linodes the system is migrating out of the placement group.
inbounds This property is required. Sequence[GetPlacementGroupMigrationsInbound]
A list of the Linodes the system is migrating into the placement group.
outbounds This property is required. Sequence[GetPlacementGroupMigrationsOutbound]
A list of the Linodes the system is migrating out of the placement group.
inbounds This property is required. List<Property Map>
A list of the Linodes the system is migrating into the placement group.
outbounds This property is required. List<Property Map>
A list of the Linodes the system is migrating out of the placement group.

GetPlacementGroupMigrationsInbound

LinodeId This property is required. int
The ID of the Linode.
LinodeId This property is required. int
The ID of the Linode.
linodeId This property is required. Integer
The ID of the Linode.
linodeId This property is required. number
The ID of the Linode.
linode_id This property is required. int
The ID of the Linode.
linodeId This property is required. Number
The ID of the Linode.

GetPlacementGroupMigrationsOutbound

LinodeId This property is required. int
The ID of the Linode.
LinodeId This property is required. int
The ID of the Linode.
linodeId This property is required. Integer
The ID of the Linode.
linodeId This property is required. number
The ID of the Linode.
linode_id This property is required. int
The ID of the Linode.
linodeId This property is required. 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 linode Terraform Provider.
Linode v4.37.0 published on Thursday, Apr 10, 2025 by Pulumi