Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ClusterPlacementGroups
  5. ClusterPlacementGroup
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.ClusterPlacementGroups.ClusterPlacementGroup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Cluster Placement Group resource in Oracle Cloud Infrastructure Cluster Placement Groups service.

    Creates a new cluster placement group in the specified compartment.

    Example Usage

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

const testClusterPlacementGroup = new oci.clusterplacementgroups.ClusterPlacementGroup("test_cluster_placement_group", {
    availabilityDomain: clusterPlacementGroupAvailabilityDomain,
    clusterPlacementGroupType: clusterPlacementGroupClusterPlacementGroupType,
    compartmentId: compartmentId,
    description: clusterPlacementGroupDescription,
    name: clusterPlacementGroupName,
    capabilities: {
        items: [{
            name: clusterPlacementGroupCapabilitiesItemsName,
            service: clusterPlacementGroupCapabilitiesItemsService,
        }],
    },
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    opcDryRun: clusterPlacementGroupOpcDryRun,
    placementInstruction: {
        type: clusterPlacementGroupPlacementInstructionType,
        value: clusterPlacementGroupPlacementInstructionValue,
    },
});

    import pulumi
import pulumi_oci as oci

test_cluster_placement_group = oci.cluster_placement_groups.ClusterPlacementGroup("test_cluster_placement_group",
    availability_domain=cluster_placement_group_availability_domain,
    cluster_placement_group_type=cluster_placement_group_cluster_placement_group_type,
    compartment_id=compartment_id,
    description=cluster_placement_group_description,
    name=cluster_placement_group_name,
    capabilities={
        "items": [{
            "name": cluster_placement_group_capabilities_items_name,
            "service": cluster_placement_group_capabilities_items_service,
        }],
    },
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    opc_dry_run=cluster_placement_group_opc_dry_run,
    placement_instruction={
        "type": cluster_placement_group_placement_instruction_type,
        "value": cluster_placement_group_placement_instruction_value,
    })

    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.NewClusterPlacementGroup(ctx, "test_cluster_placement_group", &clusterplacementgroups.ClusterPlacementGroupArgs{
			AvailabilityDomain:        pulumi.Any(clusterPlacementGroupAvailabilityDomain),
			ClusterPlacementGroupType: pulumi.Any(clusterPlacementGroupClusterPlacementGroupType),
			CompartmentId:             pulumi.Any(compartmentId),
			Description:               pulumi.Any(clusterPlacementGroupDescription),
			Name:                      pulumi.Any(clusterPlacementGroupName),
			Capabilities: &clusterplacementgroups.ClusterPlacementGroupCapabilitiesArgs{
				Items: clusterplacementgroups.ClusterPlacementGroupCapabilitiesItemArray{
					&clusterplacementgroups.ClusterPlacementGroupCapabilitiesItemArgs{
						Name:    pulumi.Any(clusterPlacementGroupCapabilitiesItemsName),
						Service: pulumi.Any(clusterPlacementGroupCapabilitiesItemsService),
					},
				},
			},
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			OpcDryRun: pulumi.Any(clusterPlacementGroupOpcDryRun),
			PlacementInstruction: &clusterplacementgroups.ClusterPlacementGroupPlacementInstructionArgs{
				Type:  pulumi.Any(clusterPlacementGroupPlacementInstructionType),
				Value: pulumi.Any(clusterPlacementGroupPlacementInstructionValue),
			},
		})
		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 = new Oci.ClusterPlacementGroups.ClusterPlacementGroup("test_cluster_placement_group", new()
    {
        AvailabilityDomain = clusterPlacementGroupAvailabilityDomain,
        ClusterPlacementGroupType = clusterPlacementGroupClusterPlacementGroupType,
        CompartmentId = compartmentId,
        Description = clusterPlacementGroupDescription,
        Name = clusterPlacementGroupName,
        Capabilities = new Oci.ClusterPlacementGroups.Inputs.ClusterPlacementGroupCapabilitiesArgs
        {
            Items = new[]
            {
                new Oci.ClusterPlacementGroups.Inputs.ClusterPlacementGroupCapabilitiesItemArgs
                {
                    Name = clusterPlacementGroupCapabilitiesItemsName,
                    Service = clusterPlacementGroupCapabilitiesItemsService,
                },
            },
        },
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        OpcDryRun = clusterPlacementGroupOpcDryRun,
        PlacementInstruction = new Oci.ClusterPlacementGroups.Inputs.ClusterPlacementGroupPlacementInstructionArgs
        {
            Type = clusterPlacementGroupPlacementInstructionType,
            Value = clusterPlacementGroupPlacementInstructionValue,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ClusterPlacementGroups.ClusterPlacementGroup;
import com.pulumi.oci.ClusterPlacementGroups.ClusterPlacementGroupArgs;
import com.pulumi.oci.ClusterPlacementGroups.inputs.ClusterPlacementGroupCapabilitiesArgs;
import com.pulumi.oci.ClusterPlacementGroups.inputs.ClusterPlacementGroupPlacementInstructionArgs;
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) {
        var testClusterPlacementGroup = new ClusterPlacementGroup("testClusterPlacementGroup", ClusterPlacementGroupArgs.builder()
            .availabilityDomain(clusterPlacementGroupAvailabilityDomain)
            .clusterPlacementGroupType(clusterPlacementGroupClusterPlacementGroupType)
            .compartmentId(compartmentId)
            .description(clusterPlacementGroupDescription)
            .name(clusterPlacementGroupName)
            .capabilities(ClusterPlacementGroupCapabilitiesArgs.builder()
                .items(ClusterPlacementGroupCapabilitiesItemArgs.builder()
                    .name(clusterPlacementGroupCapabilitiesItemsName)
                    .service(clusterPlacementGroupCapabilitiesItemsService)
                    .build())
                .build())
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .opcDryRun(clusterPlacementGroupOpcDryRun)
            .placementInstruction(ClusterPlacementGroupPlacementInstructionArgs.builder()
                .type(clusterPlacementGroupPlacementInstructionType)
                .value(clusterPlacementGroupPlacementInstructionValue)
                .build())
            .build());

    }
}

    resources:
  testClusterPlacementGroup:
    type: oci:ClusterPlacementGroups:ClusterPlacementGroup
    name: test_cluster_placement_group
    properties:
      availabilityDomain: ${clusterPlacementGroupAvailabilityDomain}
      clusterPlacementGroupType: ${clusterPlacementGroupClusterPlacementGroupType}
      compartmentId: ${compartmentId}
      description: ${clusterPlacementGroupDescription}
      name: ${clusterPlacementGroupName}
      capabilities:
        items:
          - name: ${clusterPlacementGroupCapabilitiesItemsName}
            service: ${clusterPlacementGroupCapabilitiesItemsService}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      opcDryRun: ${clusterPlacementGroupOpcDryRun}
      placementInstruction:
        type: ${clusterPlacementGroupPlacementInstructionType}
        value: ${clusterPlacementGroupPlacementInstructionValue}

    Create ClusterPlacementGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterPlacementGroup(name: string, args: ClusterPlacementGroupArgs, opts?: CustomResourceOptions);
    @overload
def ClusterPlacementGroup(resource_name: str,
                          args: ClusterPlacementGroupArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def ClusterPlacementGroup(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          availability_domain: Optional[str] = None,
                          cluster_placement_group_type: Optional[str] = None,
                          compartment_id: Optional[str] = None,
                          description: Optional[str] = None,
                          capabilities: Optional[ClusterPlacementGroupCapabilitiesArgs] = None,
                          defined_tags: Optional[Mapping[str, str]] = None,
                          freeform_tags: Optional[Mapping[str, str]] = None,
                          name: Optional[str] = None,
                          opc_dry_run: Optional[bool] = None,
                          placement_instruction: Optional[ClusterPlacementGroupPlacementInstructionArgs] = None,
                          state: Optional[str] = None)
    func NewClusterPlacementGroup(ctx *Context, name string, args ClusterPlacementGroupArgs, opts ...ResourceOption) (*ClusterPlacementGroup, error)
    public ClusterPlacementGroup(string name, ClusterPlacementGroupArgs args, CustomResourceOptions? opts = null)
    public ClusterPlacementGroup(String name, ClusterPlacementGroupArgs args)
public ClusterPlacementGroup(String name, ClusterPlacementGroupArgs args, CustomResourceOptions options)

    type: oci:ClusterPlacementGroups:ClusterPlacementGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClusterPlacementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterPlacementGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterPlacementGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterPlacementGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterPlacementGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clusterPlacementGroupResource = new Oci.ClusterPlacementGroups.ClusterPlacementGroup("clusterPlacementGroupResource", new()
{
    AvailabilityDomain = "string",
    ClusterPlacementGroupType = "string",
    CompartmentId = "string",
    Description = "string",
    Capabilities = new Oci.ClusterPlacementGroups.Inputs.ClusterPlacementGroupCapabilitiesArgs
    {
        Items = new[]
        {
            new Oci.ClusterPlacementGroups.Inputs.ClusterPlacementGroupCapabilitiesItemArgs
            {
                Name = "string",
                Service = "string",
            },
        },
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    Name = "string",
    OpcDryRun = false,
    PlacementInstruction = new Oci.ClusterPlacementGroups.Inputs.ClusterPlacementGroupPlacementInstructionArgs
    {
        Type = "string",
        Value = "string",
    },
    State = "string",
});

    example, err := clusterplacementgroups.NewClusterPlacementGroup(ctx, "clusterPlacementGroupResource", &clusterplacementgroups.ClusterPlacementGroupArgs{
	AvailabilityDomain:        pulumi.String("string"),
	ClusterPlacementGroupType: pulumi.String("string"),
	CompartmentId:             pulumi.String("string"),
	Description:               pulumi.String("string"),
	Capabilities: &clusterplacementgroups.ClusterPlacementGroupCapabilitiesArgs{
		Items: clusterplacementgroups.ClusterPlacementGroupCapabilitiesItemArray{
			&clusterplacementgroups.ClusterPlacementGroupCapabilitiesItemArgs{
				Name:    pulumi.String("string"),
				Service: pulumi.String("string"),
			},
		},
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:      pulumi.String("string"),
	OpcDryRun: pulumi.Bool(false),
	PlacementInstruction: &clusterplacementgroups.ClusterPlacementGroupPlacementInstructionArgs{
		Type:  pulumi.String("string"),
		Value: pulumi.String("string"),
	},
	State: pulumi.String("string"),
})

    var clusterPlacementGroupResource = new ClusterPlacementGroup("clusterPlacementGroupResource", ClusterPlacementGroupArgs.builder()
    .availabilityDomain("string")
    .clusterPlacementGroupType("string")
    .compartmentId("string")
    .description("string")
    .capabilities(ClusterPlacementGroupCapabilitiesArgs.builder()
        .items(ClusterPlacementGroupCapabilitiesItemArgs.builder()
            .name("string")
            .service("string")
            .build())
        .build())
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .name("string")
    .opcDryRun(false)
    .placementInstruction(ClusterPlacementGroupPlacementInstructionArgs.builder()
        .type("string")
        .value("string")
        .build())
    .state("string")
    .build());

    cluster_placement_group_resource = oci.cluster_placement_groups.ClusterPlacementGroup("clusterPlacementGroupResource",
    availability_domain="string",
    cluster_placement_group_type="string",
    compartment_id="string",
    description="string",
    capabilities={
        "items": [{
            "name": "string",
            "service": "string",
        }],
    },
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    name="string",
    opc_dry_run=False,
    placement_instruction={
        "type": "string",
        "value": "string",
    },
    state="string")

    const clusterPlacementGroupResource = new oci.clusterplacementgroups.ClusterPlacementGroup("clusterPlacementGroupResource", {
    availabilityDomain: "string",
    clusterPlacementGroupType: "string",
    compartmentId: "string",
    description: "string",
    capabilities: {
        items: [{
            name: "string",
            service: "string",
        }],
    },
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    name: "string",
    opcDryRun: false,
    placementInstruction: {
        type: "string",
        value: "string",
    },
    state: "string",
});

    type: oci:ClusterPlacementGroups:ClusterPlacementGroup
properties:
    availabilityDomain: string
    capabilities:
        items:
            - name: string
              service: string
    clusterPlacementGroupType: string
    compartmentId: string
    definedTags:
        string: string
    description: string
    freeformTags:
        string: string
    name: string
    opcDryRun: false
    placementInstruction:
        type: string
        value: string
    state: string

    ClusterPlacementGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ClusterPlacementGroup resource accepts the following input properties:

    AvailabilityDomain string
    The availability domain where you want to create the cluster placement group.
    ClusterPlacementGroupType string
    ClusterPlacementGroup Identifier.
    CompartmentId string
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    Description string
    (Updatable) A description of the cluster placement group.
    Capabilities ClusterPlacementGroupCapabilities
    A list of resources that you can create in a cluster placement group.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Name string
    The friendly name of the cluster placement group.
    OpcDryRun bool
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    PlacementInstruction ClusterPlacementGroupPlacementInstruction
    Details that inform cluster placement group provisioning.
    State string

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    AvailabilityDomain string
    The availability domain where you want to create the cluster placement group.
    ClusterPlacementGroupType string
    ClusterPlacementGroup Identifier.
    CompartmentId string
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    Description string
    (Updatable) A description of the cluster placement group.
    Capabilities ClusterPlacementGroupCapabilitiesArgs
    A list of resources that you can create in a cluster placement group.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Name string
    The friendly name of the cluster placement group.
    OpcDryRun bool
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    PlacementInstruction ClusterPlacementGroupPlacementInstructionArgs
    Details that inform cluster placement group provisioning.
    State string

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availabilityDomain String
    The availability domain where you want to create the cluster placement group.
    clusterPlacementGroupType String
    ClusterPlacementGroup Identifier.
    compartmentId String
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    description String
    (Updatable) A description of the cluster placement group.
    capabilities ClusterPlacementGroupCapabilities
    A list of resources that you can create in a cluster placement group.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    name String
    The friendly name of the cluster placement group.
    opcDryRun Boolean
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    placementInstruction ClusterPlacementGroupPlacementInstruction
    Details that inform cluster placement group provisioning.
    state String

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availabilityDomain string
    The availability domain where you want to create the cluster placement group.
    clusterPlacementGroupType string
    ClusterPlacementGroup Identifier.
    compartmentId string
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    description string
    (Updatable) A description of the cluster placement group.
    capabilities ClusterPlacementGroupCapabilities
    A list of resources that you can create in a cluster placement group.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    name string
    The friendly name of the cluster placement group.
    opcDryRun boolean
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    placementInstruction ClusterPlacementGroupPlacementInstruction
    Details that inform cluster placement group provisioning.
    state string

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availability_domain str
    The availability domain where you want to create the cluster placement group.
    cluster_placement_group_type str
    ClusterPlacementGroup Identifier.
    compartment_id str
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    description str
    (Updatable) A description of the cluster placement group.
    capabilities ClusterPlacementGroupCapabilitiesArgs
    A list of resources that you can create in a cluster placement group.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    name str
    The friendly name of the cluster placement group.
    opc_dry_run bool
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    placement_instruction ClusterPlacementGroupPlacementInstructionArgs
    Details that inform cluster placement group provisioning.
    state str

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    availabilityDomain String
    The availability domain where you want to create the cluster placement group.
    clusterPlacementGroupType String
    ClusterPlacementGroup Identifier.
    compartmentId String
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    description String
    (Updatable) A description of the cluster placement group.
    capabilities Property Map
    A list of resources that you can create in a cluster placement group.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    name String
    The friendly name of the cluster placement group.
    opcDryRun Boolean
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    placementInstruction Property Map
    Details that inform cluster placement group provisioning.
    state String

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterPlacementGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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.

    Look up Existing ClusterPlacementGroup Resource

    Get an existing ClusterPlacementGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClusterPlacementGroupState, opts?: CustomResourceOptions): ClusterPlacementGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_domain: Optional[str] = None,
        capabilities: Optional[ClusterPlacementGroupCapabilitiesArgs] = None,
        cluster_placement_group_type: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        name: Optional[str] = None,
        opc_dry_run: Optional[bool] = None,
        placement_instruction: Optional[ClusterPlacementGroupPlacementInstructionArgs] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> ClusterPlacementGroup
    func GetClusterPlacementGroup(ctx *Context, name string, id IDInput, state *ClusterPlacementGroupState, opts ...ResourceOption) (*ClusterPlacementGroup, error)
    public static ClusterPlacementGroup Get(string name, Input<string> id, ClusterPlacementGroupState? state, CustomResourceOptions? opts = null)
    public static ClusterPlacementGroup get(String name, Output<String> id, ClusterPlacementGroupState state, CustomResourceOptions options)
    resources:  _:    type: oci:ClusterPlacementGroups:ClusterPlacementGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AvailabilityDomain string
    The availability domain where you want to create the cluster placement group.
    Capabilities ClusterPlacementGroupCapabilities
    A list of resources that you can create in a cluster placement group.
    ClusterPlacementGroupType string
    ClusterPlacementGroup Identifier.
    CompartmentId string
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A description of the cluster placement group.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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 friendly name of the cluster placement group.
    OpcDryRun bool
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    PlacementInstruction ClusterPlacementGroupPlacementInstruction
    Details that inform cluster placement group provisioning.
    State string

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 where you want to create the cluster placement group.
    Capabilities ClusterPlacementGroupCapabilitiesArgs
    A list of resources that you can create in a cluster placement group.
    ClusterPlacementGroupType string
    ClusterPlacementGroup Identifier.
    CompartmentId string
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    (Updatable) A description of the cluster placement group.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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 friendly name of the cluster placement group.
    OpcDryRun bool
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    PlacementInstruction ClusterPlacementGroupPlacementInstructionArgs
    Details that inform cluster placement group provisioning.
    State string

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 where you want to create the cluster placement group.
    capabilities ClusterPlacementGroupCapabilities
    A list of resources that you can create in a cluster placement group.
    clusterPlacementGroupType String
    ClusterPlacementGroup Identifier.
    compartmentId String
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A description of the cluster placement group.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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 friendly name of the cluster placement group.
    opcDryRun Boolean
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    placementInstruction ClusterPlacementGroupPlacementInstruction
    Details that inform cluster placement group provisioning.
    state String

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 where you want to create the cluster placement group.
    capabilities ClusterPlacementGroupCapabilities
    A list of resources that you can create in a cluster placement group.
    clusterPlacementGroupType string
    ClusterPlacementGroup Identifier.
    compartmentId string
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    (Updatable) A description of the cluster placement group.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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 friendly name of the cluster placement group.
    opcDryRun boolean
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    placementInstruction ClusterPlacementGroupPlacementInstruction
    Details that inform cluster placement group provisioning.
    state string

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 where you want to create the cluster placement group.
    capabilities ClusterPlacementGroupCapabilitiesArgs
    A list of resources that you can create in a cluster placement group.
    cluster_placement_group_type str
    ClusterPlacementGroup Identifier.
    compartment_id str
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    (Updatable) A description of the cluster placement group.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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 friendly name of the cluster placement group.
    opc_dry_run bool
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    placement_instruction ClusterPlacementGroupPlacementInstructionArgs
    Details that inform cluster placement group provisioning.
    state str

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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 where you want to create the cluster placement group.
    capabilities Property Map
    A list of resources that you can create in a cluster placement group.
    clusterPlacementGroupType String
    ClusterPlacementGroup Identifier.
    compartmentId String
    (Updatable) The OCID of the compartment where you want to create the cluster placement group.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    (Updatable) A description of the cluster placement group.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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 friendly name of the cluster placement group.
    opcDryRun Boolean
    When set to true, the request performs validation on the submitted data without modifying configuration item details.
    placementInstruction Property Map
    Details that inform cluster placement group provisioning.
    state String

    (Updatable) The target state for the Cluster Placement Group. Could be set to ACTIVE or INACTIVE.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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

    ClusterPlacementGroupCapabilities, ClusterPlacementGroupCapabilitiesArgs

    items List<Property Map>
    The supported resources.

    ClusterPlacementGroupCapabilitiesItem, ClusterPlacementGroupCapabilitiesItemArgs

    Name string
    The type of resource.
    Service string
    The service that the resource is part of.
    Name string
    The type of resource.
    Service string
    The service that the resource is part of.
    name String
    The type of resource.
    service String
    The service that the resource is part of.
    name string
    The type of resource.
    service string
    The service that the resource is part of.
    name str
    The type of resource.
    service str
    The service that the resource is part of.
    name String
    The type of resource.
    service String
    The service that the resource is part of.

    ClusterPlacementGroupPlacementInstruction, ClusterPlacementGroupPlacementInstructionArgs

    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.

    Import

    ClusterPlacementGroups can be imported using the id, e.g.

    $ pulumi import oci:ClusterPlacementGroups/clusterPlacementGroup:ClusterPlacementGroup test_cluster_placement_group "id"

    To learn more about importing existing cloud resources, see Importing resources.

    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.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci