Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
oci.ClusterPlacementGroups.getClusterPlacementGroups
Explore with Pulumi AI
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
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/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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:ClusterPlacementGroups/getClusterPlacementGroups:getClusterPlacementGroups
arguments:
# arguments dictionary
The following arguments are supported:
- Ad string
- A filter to return only the resources that match the specified availability domain.
- Compartment
Id string - 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
List<Get
Cluster 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.
- Compartment
Id string - 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
[]Get
Cluster 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.
- compartment
Id String - A filter to return only the resources that match the specified compartment OCID.
- compartment
Id 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<Get
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.
- compartment
Id string - A filter to return only the resources that match the specified compartment OCID.
- compartment
Id booleanIn Subtree - When set to
true
, cluster placement groups in all compartments under the specified compartment are returned. The default is set tofalse
. - filters
Get
Cluster 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.
- compartment
Id String - A filter to return only the resources that match the specified compartment OCID.
- compartment
Id 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:
- Cluster
Placement List<GetGroup Collections Cluster Placement Groups Cluster Placement Group Collection> - The list of cluster_placement_group_collection.
- Ad string
- Compartment
Id string - The OCID of the compartment that contains the cluster placement group.
- Compartment
Id boolIn Subtree - Filters
List<Get
Cluster 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 []GetGroup Collections Cluster Placement Groups Cluster Placement Group Collection - The list of cluster_placement_group_collection.
- Ad string
- Compartment
Id string - The OCID of the compartment that contains the cluster placement group.
- Compartment
Id boolIn Subtree - Filters
[]Get
Cluster 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 List<GetGroup Collections Cluster Placement Group Collection> - The list of cluster_placement_group_collection.
- ad String
- compartment
Id String - The OCID of the compartment that contains the cluster placement group.
- compartment
Id BooleanIn Subtree - filters
List<Get
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 GetGroup Collections Cluster Placement Groups Cluster Placement Group Collection[] - The list of cluster_placement_group_collection.
- ad string
- compartment
Id string - The OCID of the compartment that contains the cluster placement group.
- compartment
Id booleanIn Subtree - filters
Get
Cluster 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.
- cluster
Placement List<Property Map>Group Collections - The list of cluster_placement_group_collection.
- ad String
- compartment
Id String - The OCID of the compartment that contains the cluster placement group.
- compartment
Id 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<Get
Cluster Placement Groups Cluster Placement Group Collection Item> - The supported resources.
- Items
[]Get
Cluster Placement Groups Cluster Placement Group Collection Item - The supported resources.
- items
List<Get
Cluster Placement Group Collection Item> - The supported resources.
- items
Get
Cluster 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
- Availability
Domain string - The availability domain of the cluster placement group.
- Capabilities
List<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 stringGroup Type - The type of cluster placement group.
- Compartment
Id string - A filter to return only the resources that match the specified compartment OCID.
- Dictionary<string, object>
- 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, object>
- 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.
- Lifecycle
Details 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.
- Opc
Dry boolRun - Placement
Instructions 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, object>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- Time
Updated string - The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
- Availability
Domain string - The availability domain of the cluster placement group.
- Capabilities
[]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 stringGroup Type - The type of cluster placement group.
- Compartment
Id string - A filter to return only the resources that match the specified compartment OCID.
- map[string]interface{}
- 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]interface{}
- 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.
- Lifecycle
Details 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.
- Opc
Dry boolRun - Placement
Instructions []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]interface{}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- Time
Updated string - The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
- availability
Domain String - The availability domain of the cluster placement group.
- capabilities
List<Get
Cluster Placement Group Collection Item Capability> - A list of resources that you can create in a cluster placement group.
- cluster
Placement StringGroup Type - The type of cluster placement group.
- compartment
Id String - A filter to return only the resources that match the specified compartment OCID.
- Map<String,Object>
- 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,Object>
- 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.
- lifecycle
Details 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.
- opc
Dry BooleanRun - placement
Instructions 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,Object>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- time
Updated String - The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
- availability
Domain string - The availability domain of the cluster placement group.
- capabilities
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 stringGroup Type - The type of cluster placement group.
- compartment
Id string - A filter to return only the resources that match the specified compartment OCID.
- {[key: string]: any}
- 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]: any}
- 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.
- lifecycle
Details 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.
- opc
Dry booleanRun - placement
Instructions 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]: any}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- time
Updated 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, Any]
- 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, Any]
- 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, Any]
- 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.
- availability
Domain 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.
- cluster
Placement StringGroup Type - The type of cluster placement group.
- compartment
Id String - A filter to return only the resources that match the specified compartment OCID.
- Map<Any>
- 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<Any>
- 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.
- lifecycle
Details 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.
- opc
Dry BooleanRun - placement
Instructions 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<Any>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - The time the cluster placement group was created, expressed in RFC 3339 timestamp format.
- time
Updated String - The time the cluster placement group was updated, expressed in RFC 3339 timestamp format.
GetClusterPlacementGroupsClusterPlacementGroupCollectionItemCapability
- Items
List<Get
Cluster Placement Groups Cluster Placement Group Collection Item Capability Item> - The supported resources.
- Items
[]Get
Cluster Placement Groups Cluster Placement Group Collection Item Capability Item - The supported resources.
- items
List<Get
Cluster Placement Group Collection Item Capability Item> - The supported resources.
- items
Get
Cluster 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
oci
Terraform Provider.
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi