1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ClusterPlacementGroups
  5. getClusterPlacementGroup
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

oci.ClusterPlacementGroups.getClusterPlacementGroup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

    This data source provides details about a specific Cluster Placement Group resource in Oracle Cloud Infrastructure Cluster Placement Groups service.

    Gets the specified cluster placement group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testClusterPlacementGroup = oci.ClusterPlacementGroups.getClusterPlacementGroup({
        clusterPlacementGroupId: testClusterPlacementGroupOciClusterPlacementGroupsClusterPlacementGroup.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_cluster_placement_group = oci.ClusterPlacementGroups.get_cluster_placement_group(cluster_placement_group_id=test_cluster_placement_group_oci_cluster_placement_groups_cluster_placement_group["id"])
    
    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.GetClusterPlacementGroup(ctx, &clusterplacementgroups.GetClusterPlacementGroupArgs{
    			ClusterPlacementGroupId: testClusterPlacementGroupOciClusterPlacementGroupsClusterPlacementGroup.Id,
    		}, 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 testClusterPlacementGroup = Oci.ClusterPlacementGroups.GetClusterPlacementGroup.Invoke(new()
        {
            ClusterPlacementGroupId = testClusterPlacementGroupOciClusterPlacementGroupsClusterPlacementGroup.Id,
        });
    
    });
    
    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.GetClusterPlacementGroupArgs;
    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 testClusterPlacementGroup = ClusterPlacementGroupsFunctions.getClusterPlacementGroup(GetClusterPlacementGroupArgs.builder()
                .clusterPlacementGroupId(testClusterPlacementGroupOciClusterPlacementGroupsClusterPlacementGroup.id())
                .build());
    
        }
    }
    
    variables:
      testClusterPlacementGroup:
        fn::invoke:
          Function: oci:ClusterPlacementGroups:getClusterPlacementGroup
          Arguments:
            clusterPlacementGroupId: ${testClusterPlacementGroupOciClusterPlacementGroupsClusterPlacementGroup.id}
    

    Using getClusterPlacementGroup

    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 getClusterPlacementGroup(args: GetClusterPlacementGroupArgs, opts?: InvokeOptions): Promise<GetClusterPlacementGroupResult>
    function getClusterPlacementGroupOutput(args: GetClusterPlacementGroupOutputArgs, opts?: InvokeOptions): Output<GetClusterPlacementGroupResult>
    def get_cluster_placement_group(cluster_placement_group_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetClusterPlacementGroupResult
    def get_cluster_placement_group_output(cluster_placement_group_id: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetClusterPlacementGroupResult]
    func GetClusterPlacementGroup(ctx *Context, args *GetClusterPlacementGroupArgs, opts ...InvokeOption) (*GetClusterPlacementGroupResult, error)
    func GetClusterPlacementGroupOutput(ctx *Context, args *GetClusterPlacementGroupOutputArgs, opts ...InvokeOption) GetClusterPlacementGroupResultOutput

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

    public static class GetClusterPlacementGroup 
    {
        public static Task<GetClusterPlacementGroupResult> InvokeAsync(GetClusterPlacementGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterPlacementGroupResult> Invoke(GetClusterPlacementGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterPlacementGroupResult> getClusterPlacementGroup(GetClusterPlacementGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:ClusterPlacementGroups/getClusterPlacementGroup:getClusterPlacementGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ClusterPlacementGroupId string
    A unique cluster placement group identifier.
    ClusterPlacementGroupId string
    A unique cluster placement group identifier.
    clusterPlacementGroupId String
    A unique cluster placement group identifier.
    clusterPlacementGroupId string
    A unique cluster placement group identifier.
    cluster_placement_group_id str
    A unique cluster placement group identifier.
    clusterPlacementGroupId String
    A unique cluster placement group identifier.

    getClusterPlacementGroup Result

    The following output properties are available:

    AvailabilityDomain string
    The availability domain of the cluster placement group.
    Capabilities List<GetClusterPlacementGroupCapability>
    A list of resources that you can create in a cluster placement group.
    ClusterPlacementGroupId string
    ClusterPlacementGroupType string
    The type of cluster placement group.
    CompartmentId string
    The OCID of the compartment that contains the cluster placement group.
    DefinedTags 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.
    FreeformTags 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
    The OCID of the cluster placement group.
    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
    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.
    OpcDryRun bool
    PlacementInstructions List<GetClusterPlacementGroupPlacementInstruction>
    Details that inform cluster placement group provisioning.
    State string
    The current state of the ClusterPlacementGroup.
    SystemTags 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 []GetClusterPlacementGroupCapability
    A list of resources that you can create in a cluster placement group.
    ClusterPlacementGroupId string
    ClusterPlacementGroupType string
    The type of cluster placement group.
    CompartmentId string
    The OCID of the compartment that contains the cluster placement group.
    DefinedTags 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.
    FreeformTags 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
    The OCID of the cluster placement group.
    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
    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.
    OpcDryRun bool
    PlacementInstructions []GetClusterPlacementGroupPlacementInstruction
    Details that inform cluster placement group provisioning.
    State string
    The current state of the ClusterPlacementGroup.
    SystemTags 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<GetClusterPlacementGroupCapability>
    A list of resources that you can create in a cluster placement group.
    clusterPlacementGroupId String
    clusterPlacementGroupType String
    The type of cluster placement group.
    compartmentId String
    The OCID of the compartment that contains the cluster placement group.
    definedTags 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.
    freeformTags 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
    The OCID of the cluster placement group.
    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
    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.
    opcDryRun Boolean
    placementInstructions List<GetClusterPlacementGroupPlacementInstruction>
    Details that inform cluster placement group provisioning.
    state String
    The current state of the ClusterPlacementGroup.
    systemTags 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 GetClusterPlacementGroupCapability[]
    A list of resources that you can create in a cluster placement group.
    clusterPlacementGroupId string
    clusterPlacementGroupType string
    The type of cluster placement group.
    compartmentId string
    The OCID of the compartment that contains the cluster placement group.
    definedTags {[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.
    freeformTags {[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
    The OCID of the cluster placement group.
    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
    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.
    opcDryRun boolean
    placementInstructions GetClusterPlacementGroupPlacementInstruction[]
    Details that inform cluster placement group provisioning.
    state string
    The current state of the ClusterPlacementGroup.
    systemTags {[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.GetClusterPlacementGroupCapability]
    A list of resources that you can create in a cluster placement group.
    cluster_placement_group_id str
    cluster_placement_group_type str
    The type of cluster placement group.
    compartment_id str
    The OCID of the compartment that contains the cluster placement group.
    defined_tags 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.
    freeform_tags 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
    The OCID of the cluster placement group.
    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
    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.
    opc_dry_run bool
    placement_instructions Sequence[clusterplacementgroups.GetClusterPlacementGroupPlacementInstruction]
    Details that inform cluster placement group provisioning.
    state str
    The current state of the ClusterPlacementGroup.
    system_tags 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.
    clusterPlacementGroupId String
    clusterPlacementGroupType String
    The type of cluster placement group.
    compartmentId String
    The OCID of the compartment that contains the cluster placement group.
    definedTags 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.
    freeformTags 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
    The OCID of the cluster placement group.
    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
    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.
    opcDryRun Boolean
    placementInstructions List<Property Map>
    Details that inform cluster placement group provisioning.
    state String
    The current state of the ClusterPlacementGroup.
    systemTags 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.

    Supporting Types

    GetClusterPlacementGroupCapability

    items List<Property Map>
    The supported resources.

    GetClusterPlacementGroupCapabilityItem

    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.
    Service string
    The service that the resource is part of.
    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.
    Service string
    The service that the resource is part of.
    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.
    service String
    The service that the resource is part of.
    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.
    service string
    The service that the resource is part of.
    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.
    service str
    The service that the resource is part of.
    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.
    service String
    The service that the resource is part of.

    GetClusterPlacementGroupPlacementInstruction

    Type string
    The type of placement instruction.
    Value string
    The value of the token designated for placement of the cluster placement group upon creation.
    Type string
    The type of placement instruction.
    Value string
    The value of the token designated for placement of the cluster placement group upon creation.
    type String
    The type of placement instruction.
    value String
    The value of the token designated for placement of the cluster placement group upon creation.
    type string
    The type of placement instruction.
    value string
    The value of the token designated for placement of the cluster placement group upon creation.
    type str
    The type of placement instruction.
    value str
    The value of the token designated for placement of the cluster placement group upon creation.
    type String
    The type of placement instruction.
    value String
    The value of the token designated for placement of the cluster placement group upon creation.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi