Linode v4.27.2, Sep 24 24

Linode v4.27.2 published on Tuesday, Sep 24, 2024 by Pulumi

linode.getPlacementGroups

Explore with Pulumi AI

Linode v4.27.2 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-linode

Example Usage

The following example shows how one might use this data source to list Placement Groups.

import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

export = async () => {
    const all = await linode.getPlacementGroups({});
    const filtered = await linode.getPlacementGroups({
        filters: [{
            name: "label",
            values: ["my-label"],
        }],
    });
    return {
        "all-pgs": all.placementGroups,
        "filtered-pgs": filtered.placementGroups,
    };
}

import pulumi
import pulumi_linode as linode

all = linode.get_placement_groups()
filtered = linode.get_placement_groups(filters=[{
    "name": "label",
    "values": ["my-label"],
}])
pulumi.export("all-pgs", all.placement_groups)
pulumi.export("filtered-pgs", filtered.placement_groups)

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 {
		all, err := linode.GetPlacementGroups(ctx, nil, nil)
		if err != nil {
			return err
		}
		filtered, err := linode.GetPlacementGroups(ctx, &linode.GetPlacementGroupsArgs{
			Filters: []linode.GetPlacementGroupsFilter{
				{
					Name: "label",
					Values: []string{
						"my-label",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("all-pgs", all.PlacementGroups)
		ctx.Export("filtered-pgs", filtered.PlacementGroups)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var all = Linode.GetPlacementGroups.Invoke();

    var filtered = Linode.GetPlacementGroups.Invoke(new()
    {
        Filters = new[]
        {
            new Linode.Inputs.GetPlacementGroupsFilterInputArgs
            {
                Name = "label",
                Values = new[]
                {
                    "my-label",
                },
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["all-pgs"] = all.Apply(getPlacementGroupsResult => getPlacementGroupsResult.PlacementGroups),
        ["filtered-pgs"] = filtered.Apply(getPlacementGroupsResult => getPlacementGroupsResult.PlacementGroups),
    };
});

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.GetPlacementGroupsArgs;
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 all = LinodeFunctions.getPlacementGroups();

        final var filtered = LinodeFunctions.getPlacementGroups(GetPlacementGroupsArgs.builder()
            .filters(GetPlacementGroupsFilterArgs.builder()
                .name("label")
                .values("my-label")
                .build())
            .build());

        ctx.export("all-pgs", all.applyValue(getPlacementGroupsResult -> getPlacementGroupsResult.placementGroups()));
        ctx.export("filtered-pgs", filtered.applyValue(getPlacementGroupsResult -> getPlacementGroupsResult.placementGroups()));
    }
}

variables:
  all:
    fn::invoke:
      Function: linode:getPlacementGroups
      Arguments: {}
  filtered:
    fn::invoke:
      Function: linode:getPlacementGroups
      Arguments:
        filters:
          - name: label
            values:
              - my-label
outputs:
  all-pgs: ${all.placementGroups}
  filtered-pgs: ${filtered.placementGroups}

Filterable Fields

id
label
region
placement_group_type
placement_group_policy
is_compliant

Using getPlacementGroups

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 getPlacementGroups(args: GetPlacementGroupsArgs, opts?: InvokeOptions): Promise<GetPlacementGroupsResult>
function getPlacementGroupsOutput(args: GetPlacementGroupsOutputArgs, opts?: InvokeOptions): Output<GetPlacementGroupsResult>

def get_placement_groups(filters: Optional[Sequence[GetPlacementGroupsFilter]] = None,
                         order: Optional[str] = None,
                         order_by: Optional[str] = None,
                         placement_groups: Optional[Sequence[GetPlacementGroupsPlacementGroup]] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPlacementGroupsResult
def get_placement_groups_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPlacementGroupsFilterArgs]]]] = None,
                         order: Optional[pulumi.Input[str]] = None,
                         order_by: Optional[pulumi.Input[str]] = None,
                         placement_groups: Optional[pulumi.Input[Sequence[pulumi.Input[GetPlacementGroupsPlacementGroupArgs]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPlacementGroupsResult]

func GetPlacementGroups(ctx *Context, args *GetPlacementGroupsArgs, opts ...InvokeOption) (*GetPlacementGroupsResult, error)
func GetPlacementGroupsOutput(ctx *Context, args *GetPlacementGroupsOutputArgs, opts ...InvokeOption) GetPlacementGroupsResultOutput

> Note: This function is named GetPlacementGroups in the Go SDK.

public static class GetPlacementGroups 
{
    public static Task<GetPlacementGroupsResult> InvokeAsync(GetPlacementGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetPlacementGroupsResult> Invoke(GetPlacementGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPlacementGroupsResult> getPlacementGroups(GetPlacementGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: linode:index/getPlacementGroups:getPlacementGroups
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetPlacementGroupsFilter>
Order string
OrderBy string
PlacementGroups List<GetPlacementGroupsPlacementGroup>

Filters []GetPlacementGroupsFilter
Order string
OrderBy string
PlacementGroups []GetPlacementGroupsPlacementGroup

filters List<GetPlacementGroupsFilter>
order String
orderBy String
placementGroups List<GetPlacementGroupsPlacementGroup>

filters GetPlacementGroupsFilter[]
order string
orderBy string
placementGroups GetPlacementGroupsPlacementGroup[]

filters Sequence[GetPlacementGroupsFilter]
order str
order_by str
placement_groups Sequence[GetPlacementGroupsPlacementGroup]

filters List<Property Map>
order String
orderBy String
placementGroups List<Property Map>

getPlacementGroups Result

The following output properties are available:

Id string
Filters List<GetPlacementGroupsFilter>
Order string
OrderBy string
PlacementGroups List<GetPlacementGroupsPlacementGroup>

Id string
Filters []GetPlacementGroupsFilter
Order string
OrderBy string
PlacementGroups []GetPlacementGroupsPlacementGroup

id String
filters List<GetPlacementGroupsFilter>
order String
orderBy String
placementGroups List<GetPlacementGroupsPlacementGroup>

id string
filters GetPlacementGroupsFilter[]
order string
orderBy string
placementGroups GetPlacementGroupsPlacementGroup[]

id str
filters Sequence[GetPlacementGroupsFilter]
order str
order_by str
placement_groups Sequence[GetPlacementGroupsPlacementGroup]

id String
filters List<Property Map>
order String
orderBy String
placementGroups List<Property Map>

Supporting Types

GetPlacementGroupsFilter

Name string: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
Values List<string>: A list of values for the filter to allow. These values should all be in string form.
MatchBy string: The method to match the field by. (exact, regex, substring; default exact)

Name string: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
Values []string: A list of values for the filter to allow. These values should all be in string form.
MatchBy string: The method to match the field by. (exact, regex, substring; default exact)

name String: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
values List<String>: A list of values for the filter to allow. These values should all be in string form.
matchBy String: The method to match the field by. (exact, regex, substring; default exact)

name string: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
values string[]: A list of values for the filter to allow. These values should all be in string form.
matchBy string: The method to match the field by. (exact, regex, substring; default exact)

name str: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
values Sequence[str]: A list of values for the filter to allow. These values should all be in string form.
match_by str: The method to match the field by. (exact, regex, substring; default exact)

name String: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
values List<String>: A list of values for the filter to allow. These values should all be in string form.
matchBy String: The method to match the field by. (exact, regex, substring; default exact)

GetPlacementGroupsPlacementGroup

Id int: The ID of the placement group.
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<GetPlacementGroupsPlacementGroupMember>: A set of Linodes currently assigned to this Placement Group.

Id int: The ID of the placement group.
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 []GetPlacementGroupsPlacementGroupMember: A set of Linodes currently assigned to this Placement Group.

id Integer: The ID of the placement group.
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<GetPlacementGroupsPlacementGroupMember>: A set of Linodes currently assigned to this Placement Group.

id number: The ID of the placement group.
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 GetPlacementGroupsPlacementGroupMember[]: A set of Linodes currently assigned to this Placement Group.

id int: The ID of the placement group.
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[GetPlacementGroupsPlacementGroupMember]: A set of Linodes currently assigned to this Placement Group.

id Number: The ID of the placement group.
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.

GetPlacementGroupsPlacementGroupMember

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.

Package Details

Repository: Linode pulumi/pulumi-linode
License: Apache-2.0
Notes: This Pulumi package is based on the linode Terraform Provider.

Linode v4.27.2 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-linode

linode.getPlacementGroups

On this page

On this page

Example Usage

Filterable Fields

Using getPlacementGroups

getPlacementGroups Result

Supporting Types

GetPlacementGroupsFilter

GetPlacementGroupsPlacementGroup

GetPlacementGroupsPlacementGroupMember

Package Details

On this page

On this page