Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
oci.ClusterPlacementGroups.getClusterPlacementGroups
Explore with Pulumi AI
This data source provides the list of Cluster Placement Groups in Oracle Cloud Infrastructure Cluster Placement Groups service.
Gets a list of all cluster placement groups in the specified compartment.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testClusterPlacementGroups = oci.ClusterPlacementGroups.getClusterPlacementGroups({
    ad: clusterPlacementGroupAd,
    compartmentId: compartmentId,
    compartmentIdInSubtree: clusterPlacementGroupCompartmentIdInSubtree,
    id: clusterPlacementGroupId,
    name: clusterPlacementGroupName,
    state: clusterPlacementGroupState,
});
import pulumi
import pulumi_oci as oci
test_cluster_placement_groups = oci.ClusterPlacementGroups.get_cluster_placement_groups(ad=cluster_placement_group_ad,
    compartment_id=compartment_id,
    compartment_id_in_subtree=cluster_placement_group_compartment_id_in_subtree,
    id=cluster_placement_group_id,
    name=cluster_placement_group_name,
    state=cluster_placement_group_state)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/clusterplacementgroups"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := clusterplacementgroups.GetClusterPlacementGroups(ctx, &clusterplacementgroups.GetClusterPlacementGroupsArgs{
			Ad:                     pulumi.StringRef(clusterPlacementGroupAd),
			CompartmentId:          pulumi.StringRef(compartmentId),
			CompartmentIdInSubtree: pulumi.BoolRef(clusterPlacementGroupCompartmentIdInSubtree),
			Id:                     pulumi.StringRef(clusterPlacementGroupId),
			Name:                   pulumi.StringRef(clusterPlacementGroupName),
			State:                  pulumi.StringRef(clusterPlacementGroupState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testClusterPlacementGroups = Oci.ClusterPlacementGroups.GetClusterPlacementGroups.Invoke(new()
    {
        Ad = clusterPlacementGroupAd,
        CompartmentId = compartmentId,
        CompartmentIdInSubtree = clusterPlacementGroupCompartmentIdInSubtree,
        Id = clusterPlacementGroupId,
        Name = clusterPlacementGroupName,
        State = clusterPlacementGroupState,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ClusterPlacementGroups.ClusterPlacementGroupsFunctions;
import com.pulumi.oci.ClusterPlacementGroups.inputs.GetClusterPlacementGroupsArgs;
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 testClusterPlacementGroups = ClusterPlacementGroupsFunctions.getClusterPlacementGroups(GetClusterPlacementGroupsArgs.builder()
            .ad(clusterPlacementGroupAd)
            .compartmentId(compartmentId)
            .compartmentIdInSubtree(clusterPlacementGroupCompartmentIdInSubtree)
            .id(clusterPlacementGroupId)
            .name(clusterPlacementGroupName)
            .state(clusterPlacementGroupState)
            .build());
    }
}
variables:
  testClusterPlacementGroups:
    fn::invoke:
      function: oci:ClusterPlacementGroups:getClusterPlacementGroups
      arguments:
        ad: ${clusterPlacementGroupAd}
        compartmentId: ${compartmentId}
        compartmentIdInSubtree: ${clusterPlacementGroupCompartmentIdInSubtree}
        id: ${clusterPlacementGroupId}
        name: ${clusterPlacementGroupName}
        state: ${clusterPlacementGroupState}
Using getClusterPlacementGroups
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 getClusterPlacementGroups(args: GetClusterPlacementGroupsArgs, opts?: InvokeOptions): Promise<GetClusterPlacementGroupsResult>
function getClusterPlacementGroupsOutput(args: GetClusterPlacementGroupsOutputArgs, opts?: InvokeOptions): Output<GetClusterPlacementGroupsResult>def get_cluster_placement_groups(ad: Optional[str] = None,
                                 compartment_id: Optional[str] = None,
                                 compartment_id_in_subtree: Optional[bool] = None,
                                 filters: Optional[Sequence[_clusterplacementgroups.GetClusterPlacementGroupsFilter]] = None,
                                 id: Optional[str] = None,
                                 name: Optional[str] = None,
                                 state: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetClusterPlacementGroupsResult
def get_cluster_placement_groups_output(ad: Optional[pulumi.Input[str]] = None,
                                 compartment_id: Optional[pulumi.Input[str]] = None,
                                 compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_clusterplacementgroups.GetClusterPlacementGroupsFilterArgs]]]] = None,
                                 id: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 state: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetClusterPlacementGroupsResult]func GetClusterPlacementGroups(ctx *Context, args *GetClusterPlacementGroupsArgs, opts ...InvokeOption) (*GetClusterPlacementGroupsResult, error)
func GetClusterPlacementGroupsOutput(ctx *Context, args *GetClusterPlacementGroupsOutputArgs, opts ...InvokeOption) GetClusterPlacementGroupsResultOutput> Note: This function is named GetClusterPlacementGroups in the Go SDK.
public static class GetClusterPlacementGroups 
{
    public static Task<GetClusterPlacementGroupsResult> InvokeAsync(GetClusterPlacementGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterPlacementGroupsResult> Invoke(GetClusterPlacementGroupsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetClusterPlacementGroupsResult> getClusterPlacementGroups(GetClusterPlacementGroupsArgs args, InvokeOptions options)
public static Output<GetClusterPlacementGroupsResult> getClusterPlacementGroups(GetClusterPlacementGroupsArgs args, InvokeOptions options)
fn::invoke:
  function: oci:ClusterPlacementGroups/getClusterPlacementGroups:getClusterPlacementGroups
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Ad string
- A filter to return only the resources that match the specified availability domain.
- CompartmentId string
- A filter to return only the resources that match the specified compartment OCID.
- CompartmentId boolIn Subtree 
- When set to true, cluster placement groups in all compartments under the specified compartment are returned. The default is set tofalse.
- Filters
List<GetCluster Placement Groups Filter> 
- Id string
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- Name string
- A filter to return only the resources that match the entire display name specified.
- State string
- A filter to return only the resources that match the specified lifecycle state.
- Ad string
- A filter to return only the resources that match the specified availability domain.
- CompartmentId string
- A filter to return only the resources that match the specified compartment OCID.
- CompartmentId boolIn Subtree 
- When set to true, cluster placement groups in all compartments under the specified compartment are returned. The default is set tofalse.
- Filters
[]GetCluster Placement Groups Filter 
- Id string
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- Name string
- A filter to return only the resources that match the entire display name specified.
- State string
- A filter to return only the resources that match the specified lifecycle state.
- ad String
- A filter to return only the resources that match the specified availability domain.
- compartmentId String
- A filter to return only the resources that match the specified compartment OCID.
- compartmentId BooleanIn Subtree 
- When set to true, cluster placement groups in all compartments under the specified compartment are returned. The default is set tofalse.
- filters
List<GetFilter> 
- id String
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- name String
- A filter to return only the resources that match the entire display name specified.
- state String
- A filter to return only the resources that match the specified lifecycle state.
- ad string
- A filter to return only the resources that match the specified availability domain.
- compartmentId string
- A filter to return only the resources that match the specified compartment OCID.
- compartmentId booleanIn Subtree 
- When set to true, cluster placement groups in all compartments under the specified compartment are returned. The default is set tofalse.
- filters
GetCluster Placement Groups Filter[] 
- id string
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- name string
- A filter to return only the resources that match the entire display name specified.
- state string
- A filter to return only the resources that match the specified lifecycle state.
- ad str
- A filter to return only the resources that match the specified availability domain.
- compartment_id str
- A filter to return only the resources that match the specified compartment OCID.
- compartment_id_ boolin_ subtree 
- When set to true, cluster placement groups in all compartments under the specified compartment are returned. The default is set tofalse.
- filters
Sequence[clusterplacementgroups.Get Cluster Placement Groups Filter] 
- id str
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- name str
- A filter to return only the resources that match the entire display name specified.
- state str
- A filter to return only the resources that match the specified lifecycle state.
- ad String
- A filter to return only the resources that match the specified availability domain.
- compartmentId String
- A filter to return only the resources that match the specified compartment OCID.
- compartmentId BooleanIn Subtree 
- When set to true, cluster placement groups in all compartments under the specified compartment are returned. The default is set tofalse.
- filters List<Property Map>
- id String
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- name String
- A filter to return only the resources that match the entire display name specified.
- state String
- A filter to return only the resources that match the specified lifecycle state.
getClusterPlacementGroups Result
The following output properties are available:
- ClusterPlacement List<GetGroup Collections Cluster Placement Groups Cluster Placement Group Collection> 
- The list of cluster_placement_group_collection.
- Ad string
- CompartmentId string
- The OCID of the compartment that contains the cluster placement group.
- CompartmentId boolIn Subtree 
- Filters
List<GetCluster Placement Groups Filter> 
- Id string
- The OCID of the cluster placement group.
- Name string
- The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.
- State string
- The current state of the ClusterPlacementGroup.
- ClusterPlacement []GetGroup Collections Cluster Placement Groups Cluster Placement Group Collection 
- The list of cluster_placement_group_collection.
- Ad string
- CompartmentId string
- The OCID of the compartment that contains the cluster placement group.
- CompartmentId boolIn Subtree 
- Filters
[]GetCluster Placement Groups Filter 
- Id string
- The OCID of the cluster placement group.
- Name string
- The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.
- State string
- The current state of the ClusterPlacementGroup.
- clusterPlacement List<GetGroup Collections Cluster Placement Group Collection> 
- The list of cluster_placement_group_collection.
- ad String
- compartmentId String
- The OCID of the compartment that contains the cluster placement group.
- compartmentId BooleanIn Subtree 
- filters
List<GetFilter> 
- id String
- The OCID of the cluster placement group.
- name String
- The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.
- state String
- The current state of the ClusterPlacementGroup.
- clusterPlacement GetGroup Collections Cluster Placement Groups Cluster Placement Group Collection[] 
- The list of cluster_placement_group_collection.
- ad string
- compartmentId string
- The OCID of the compartment that contains the cluster placement group.
- compartmentId booleanIn Subtree 
- filters
GetCluster Placement Groups Filter[] 
- id string
- The OCID of the cluster placement group.
- name string
- The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.
- state string
- The current state of the ClusterPlacementGroup.
- cluster_placement_ Sequence[clusterplacementgroups.group_ collections Get Cluster Placement Groups Cluster Placement Group Collection] 
- The list of cluster_placement_group_collection.
- ad str
- compartment_id str
- The OCID of the compartment that contains the cluster placement group.
- compartment_id_ boolin_ subtree 
- filters
Sequence[clusterplacementgroups.Get Cluster Placement Groups Filter] 
- id str
- The OCID of the cluster placement group.
- name str
- The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.
- state str
- The current state of the ClusterPlacementGroup.
- clusterPlacement List<Property Map>Group Collections 
- The list of cluster_placement_group_collection.
- ad String
- compartmentId String
- The OCID of the compartment that contains the cluster placement group.
- compartmentId BooleanIn Subtree 
- filters List<Property Map>
- id String
- The OCID of the cluster placement group.
- name String
- The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.
- state String
- The current state of the ClusterPlacementGroup.
Supporting Types
GetClusterPlacementGroupsClusterPlacementGroupCollection       
- Items
List<GetCluster Placement Groups Cluster Placement Group Collection Item> 
- The supported resources.
- Items
[]GetCluster Placement Groups Cluster Placement Group Collection Item 
- The supported resources.
- items
List<GetCluster Placement Group Collection Item> 
- The supported resources.
- items
GetCluster Placement Groups Cluster Placement Group Collection Item[] 
- The supported resources.
- items
Sequence[clusterplacementgroups.Get Cluster Placement Groups Cluster Placement Group Collection Item] 
- The supported resources.
- items List<Property Map>
- The supported resources.
GetClusterPlacementGroupsClusterPlacementGroupCollectionItem        
- AvailabilityDomain string
- The availability domain of the cluster placement group.
- Capabilities
List<GetCluster Placement Groups Cluster Placement Group Collection Item Capability> 
- A list of resources that you can create in a cluster placement group.
- ClusterPlacement stringGroup Type 
- The type of cluster placement group.
- CompartmentId string
- A filter to return only the resources that match the specified compartment OCID.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- A description of the cluster placement group.
- Dictionary<string, string>
- Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- Id string
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- LifecycleDetails string
- A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
- Name string
- A filter to return only the resources that match the entire display name specified.
- OpcDry boolRun 
- PlacementInstructions List<GetCluster Placement Groups Cluster Placement Group Collection Item Placement Instruction> 
- Details that inform cluster placement group provisioning.
- State string
- A filter to return only the resources that match the specified lifecycle state.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- TimeUpdated string
- The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
- AvailabilityDomain string
- The availability domain of the cluster placement group.
- Capabilities
[]GetCluster Placement Groups Cluster Placement Group Collection Item Capability 
- A list of resources that you can create in a cluster placement group.
- ClusterPlacement stringGroup Type 
- The type of cluster placement group.
- CompartmentId string
- A filter to return only the resources that match the specified compartment OCID.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- Description string
- A description of the cluster placement group.
- map[string]string
- Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- Id string
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- LifecycleDetails string
- A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
- Name string
- A filter to return only the resources that match the entire display name specified.
- OpcDry boolRun 
- PlacementInstructions []GetCluster Placement Groups Cluster Placement Group Collection Item Placement Instruction 
- Details that inform cluster placement group provisioning.
- State string
- A filter to return only the resources that match the specified lifecycle state.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- TimeCreated string
- The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- TimeUpdated string
- The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
- availabilityDomain String
- The availability domain of the cluster placement group.
- capabilities
List<GetCluster Placement Group Collection Item Capability> 
- A list of resources that you can create in a cluster placement group.
- clusterPlacement StringGroup Type 
- The type of cluster placement group.
- compartmentId String
- A filter to return only the resources that match the specified compartment OCID.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- A description of the cluster placement group.
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id String
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- lifecycleDetails String
- A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
- name String
- A filter to return only the resources that match the entire display name specified.
- opcDry BooleanRun 
- placementInstructions List<GetCluster Placement Group Collection Item Placement Instruction> 
- Details that inform cluster placement group provisioning.
- state String
- A filter to return only the resources that match the specified lifecycle state.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- timeUpdated String
- The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
- availabilityDomain string
- The availability domain of the cluster placement group.
- capabilities
GetCluster Placement Groups Cluster Placement Group Collection Item Capability[] 
- A list of resources that you can create in a cluster placement group.
- clusterPlacement stringGroup Type 
- The type of cluster placement group.
- compartmentId string
- A filter to return only the resources that match the specified compartment OCID.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description string
- A description of the cluster placement group.
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id string
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- lifecycleDetails string
- A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
- name string
- A filter to return only the resources that match the entire display name specified.
- opcDry booleanRun 
- placementInstructions GetCluster Placement Groups Cluster Placement Group Collection Item Placement Instruction[] 
- Details that inform cluster placement group provisioning.
- state string
- A filter to return only the resources that match the specified lifecycle state.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated string
- The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- timeUpdated string
- The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
- availability_domain str
- The availability domain of the cluster placement group.
- capabilities
Sequence[clusterplacementgroups.Get Cluster Placement Groups Cluster Placement Group Collection Item Capability] 
- A list of resources that you can create in a cluster placement group.
- cluster_placement_ strgroup_ type 
- The type of cluster placement group.
- compartment_id str
- A filter to return only the resources that match the specified compartment OCID.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description str
- A description of the cluster placement group.
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id str
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- lifecycle_details str
- A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
- name str
- A filter to return only the resources that match the entire display name specified.
- opc_dry_ boolrun 
- placement_instructions Sequence[clusterplacementgroups.Get Cluster Placement Groups Cluster Placement Group Collection Item Placement Instruction] 
- Details that inform cluster placement group provisioning.
- state str
- A filter to return only the resources that match the specified lifecycle state.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- time_created str
- The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- time_updated str
- The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
- availabilityDomain String
- The availability domain of the cluster placement group.
- capabilities List<Property Map>
- A list of resources that you can create in a cluster placement group.
- clusterPlacement StringGroup Type 
- The type of cluster placement group.
- compartmentId String
- A filter to return only the resources that match the specified compartment OCID.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- description String
- A description of the cluster placement group.
- Map<String>
- Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id String
- A filter to return only the resources that match the specified unique cluster placement group identifier.
- lifecycleDetails String
- A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.
- name String
- A filter to return only the resources that match the entire display name specified.
- opcDry BooleanRun 
- placementInstructions List<Property Map>
- Details that inform cluster placement group provisioning.
- state String
- A filter to return only the resources that match the specified lifecycle state.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
- timeCreated String
- The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- timeUpdated String
- The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapability         
- Items
List<GetCluster Placement Groups Cluster Placement Group Collection Item Capability Item> 
- The supported resources.
- Items
[]GetCluster Placement Groups Cluster Placement Group Collection Item Capability Item 
- The supported resources.
- items
List<GetCluster Placement Group Collection Item Capability Item> 
- The supported resources.
- items
GetCluster Placement Groups Cluster Placement Group Collection Item Capability Item[] 
- The supported resources.
- items List<Property Map>
- The supported resources.
GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItem          
GetClusterPlacementGroupsClusterPlacementGroupCollectionItemPlacementInstruction          
GetClusterPlacementGroupsFilter    
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.