Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. VolumeGroup
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

oci.Core.VolumeGroup

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-oci

    Example Usage

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

const testVolumeGroup = new oci.core.VolumeGroup("testVolumeGroup", {
    availabilityDomain: _var.volume_group_availability_domain,
    compartmentId: _var.compartment_id,
    sourceDetails: {
        type: "volumeIds",
        volumeIds: [_var.volume_group_source_id],
    },
    backupPolicyId: data.oci_core_volume_backup_policies.test_volume_backup_policies.volume_backup_policies[0].id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: _var.volume_group_display_name,
    freeformTags: {
        Department: "Finance",
    },
    volumeGroupReplicas: [{
        availabilityDomain: _var.volume_group_volume_group_replicas_availability_domain,
        displayName: _var.volume_group_volume_group_replicas_display_name,
    }],
    volumeIds: [_var.volume_group_source_id],
});

    import pulumi
import pulumi_oci as oci

test_volume_group = oci.core.VolumeGroup("testVolumeGroup",
    availability_domain=var["volume_group_availability_domain"],
    compartment_id=var["compartment_id"],
    source_details=oci.core.VolumeGroupSourceDetailsArgs(
        type="volumeIds",
        volume_ids=[var["volume_group_source_id"]],
    ),
    backup_policy_id=data["oci_core_volume_backup_policies"]["test_volume_backup_policies"]["volume_backup_policies"][0]["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=var["volume_group_display_name"],
    freeform_tags={
        "Department": "Finance",
    },
    volume_group_replicas=[oci.core.VolumeGroupVolumeGroupReplicaArgs(
        availability_domain=var["volume_group_volume_group_replicas_availability_domain"],
        display_name=var["volume_group_volume_group_replicas_display_name"],
    )],
    volume_ids=[var["volume_group_source_id"]])

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.NewVolumeGroup(ctx, "testVolumeGroup", &Core.VolumeGroupArgs{
			AvailabilityDomain: pulumi.Any(_var.Volume_group_availability_domain),
			CompartmentId:      pulumi.Any(_var.Compartment_id),
			SourceDetails: &core.VolumeGroupSourceDetailsArgs{
				Type: pulumi.String("volumeIds"),
				VolumeIds: pulumi.StringArray{
					_var.Volume_group_source_id,
				},
			},
			BackupPolicyId: pulumi.Any(data.Oci_core_volume_backup_policies.Test_volume_backup_policies.Volume_backup_policies[0].Id),
			DefinedTags: pulumi.Map{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			DisplayName: pulumi.Any(_var.Volume_group_display_name),
			FreeformTags: pulumi.Map{
				"Department": pulumi.Any("Finance"),
			},
			VolumeGroupReplicas: core.VolumeGroupVolumeGroupReplicaArray{
				&core.VolumeGroupVolumeGroupReplicaArgs{
					AvailabilityDomain: pulumi.Any(_var.Volume_group_volume_group_replicas_availability_domain),
					DisplayName:        pulumi.Any(_var.Volume_group_volume_group_replicas_display_name),
				},
			},
			VolumeIds: pulumi.StringArray{
				_var.Volume_group_source_id,
			},
		})
		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 testVolumeGroup = new Oci.Core.VolumeGroup("testVolumeGroup", new()
    {
        AvailabilityDomain = @var.Volume_group_availability_domain,
        CompartmentId = @var.Compartment_id,
        SourceDetails = new Oci.Core.Inputs.VolumeGroupSourceDetailsArgs
        {
            Type = "volumeIds",
            VolumeIds = new[]
            {
                @var.Volume_group_source_id,
            },
        },
        BackupPolicyId = data.Oci_core_volume_backup_policies.Test_volume_backup_policies.Volume_backup_policies[0].Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = @var.Volume_group_display_name,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        VolumeGroupReplicas = new[]
        {
            new Oci.Core.Inputs.VolumeGroupVolumeGroupReplicaArgs
            {
                AvailabilityDomain = @var.Volume_group_volume_group_replicas_availability_domain,
                DisplayName = @var.Volume_group_volume_group_replicas_display_name,
            },
        },
        VolumeIds = new[]
        {
            @var.Volume_group_source_id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.VolumeGroup;
import com.pulumi.oci.Core.VolumeGroupArgs;
import com.pulumi.oci.Core.inputs.VolumeGroupSourceDetailsArgs;
import com.pulumi.oci.Core.inputs.VolumeGroupVolumeGroupReplicaArgs;
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 testVolumeGroup = new VolumeGroup("testVolumeGroup", VolumeGroupArgs.builder()        
            .availabilityDomain(var_.volume_group_availability_domain())
            .compartmentId(var_.compartment_id())
            .sourceDetails(VolumeGroupSourceDetailsArgs.builder()
                .type("volumeIds")
                .volumeIds(var_.volume_group_source_id())
                .build())
            .backupPolicyId(data.oci_core_volume_backup_policies().test_volume_backup_policies().volume_backup_policies()[0].id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(var_.volume_group_display_name())
            .freeformTags(Map.of("Department", "Finance"))
            .volumeGroupReplicas(VolumeGroupVolumeGroupReplicaArgs.builder()
                .availabilityDomain(var_.volume_group_volume_group_replicas_availability_domain())
                .displayName(var_.volume_group_volume_group_replicas_display_name())
                .build())
            .volumeIds(var_.volume_group_source_id())
            .build());

    }
}

    resources:
  testVolumeGroup:
    type: oci:Core:VolumeGroup
    properties:
      #Required
      availabilityDomain: ${var.volume_group_availability_domain}
      compartmentId: ${var.compartment_id}
      sourceDetails:
        type: volumeIds
        volumeIds:
          - ${var.volume_group_source_id}
      #Optional
      backupPolicyId: ${data.oci_core_volume_backup_policies.test_volume_backup_policies.volume_backup_policies[0].id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${var.volume_group_display_name}
      freeformTags:
        Department: Finance
      volumeGroupReplicas:
        - availabilityDomain: ${var.volume_group_volume_group_replicas_availability_domain}
          displayName: ${var.volume_group_volume_group_replicas_display_name}
      volumeIds:
        - ${var.volume_group_source_id}

    Create VolumeGroup Resource

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

    Constructor syntax

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

@overload
def VolumeGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                availability_domain: Optional[str] = None,
                compartment_id: Optional[str] = None,
                source_details: Optional[_core.VolumeGroupSourceDetailsArgs] = None,
                backup_policy_id: Optional[str] = None,
                defined_tags: Optional[Mapping[str, Any]] = None,
                display_name: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, Any]] = None,
                preserve_volume_replica: Optional[bool] = None,
                volume_group_replicas: Optional[Sequence[_core.VolumeGroupVolumeGroupReplicaArgs]] = None,
                volume_group_replicas_deletion: Optional[bool] = None,
                volume_ids: Optional[Sequence[str]] = None)
    func NewVolumeGroup(ctx *Context, name string, args VolumeGroupArgs, opts ...ResourceOption) (*VolumeGroup, error)
    public VolumeGroup(string name, VolumeGroupArgs args, CustomResourceOptions? opts = null)
    public VolumeGroup(String name, VolumeGroupArgs args)
public VolumeGroup(String name, VolumeGroupArgs args, CustomResourceOptions options)

    type: oci:Core:VolumeGroup
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 VolumeGroupArgs
    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 VolumeGroupArgs
    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 VolumeGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var volumeGroupResource = new Oci.Core.VolumeGroup("volumeGroupResource", new()
{
    AvailabilityDomain = "string",
    CompartmentId = "string",
    SourceDetails = new Oci.Core.Inputs.VolumeGroupSourceDetailsArgs
    {
        Type = "string",
        VolumeGroupBackupId = "string",
        VolumeGroupId = "string",
        VolumeGroupReplicaId = "string",
        VolumeIds = new[]
        {
            "string",
        },
    },
    DefinedTags = 
    {
        { "string", "any" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "any" },
    },
    PreserveVolumeReplica = false,
    VolumeGroupReplicas = new[]
    {
        new Oci.Core.Inputs.VolumeGroupVolumeGroupReplicaArgs
        {
            AvailabilityDomain = "string",
            DisplayName = "string",
            VolumeGroupReplicaId = "string",
        },
    },
    VolumeGroupReplicasDeletion = false,
    VolumeIds = new[]
    {
        "string",
    },
});

    example, err := Core.NewVolumeGroup(ctx, "volumeGroupResource", &Core.VolumeGroupArgs{
	AvailabilityDomain: pulumi.String("string"),
	CompartmentId:      pulumi.String("string"),
	SourceDetails: &core.VolumeGroupSourceDetailsArgs{
		Type:                 pulumi.String("string"),
		VolumeGroupBackupId:  pulumi.String("string"),
		VolumeGroupId:        pulumi.String("string"),
		VolumeGroupReplicaId: pulumi.String("string"),
		VolumeIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	DefinedTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	PreserveVolumeReplica: pulumi.Bool(false),
	VolumeGroupReplicas: core.VolumeGroupVolumeGroupReplicaArray{
		&core.VolumeGroupVolumeGroupReplicaArgs{
			AvailabilityDomain:   pulumi.String("string"),
			DisplayName:          pulumi.String("string"),
			VolumeGroupReplicaId: pulumi.String("string"),
		},
	},
	VolumeGroupReplicasDeletion: pulumi.Bool(false),
	VolumeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var volumeGroupResource = new VolumeGroup("volumeGroupResource", VolumeGroupArgs.builder()        
    .availabilityDomain("string")
    .compartmentId("string")
    .sourceDetails(VolumeGroupSourceDetailsArgs.builder()
        .type("string")
        .volumeGroupBackupId("string")
        .volumeGroupId("string")
        .volumeGroupReplicaId("string")
        .volumeIds("string")
        .build())
    .definedTags(Map.of("string", "any"))
    .displayName("string")
    .freeformTags(Map.of("string", "any"))
    .preserveVolumeReplica(false)
    .volumeGroupReplicas(VolumeGroupVolumeGroupReplicaArgs.builder()
        .availabilityDomain("string")
        .displayName("string")
        .volumeGroupReplicaId("string")
        .build())
    .volumeGroupReplicasDeletion(false)
    .volumeIds("string")
    .build());

    volume_group_resource = oci.core.VolumeGroup("volumeGroupResource",
    availability_domain="string",
    compartment_id="string",
    source_details=oci.core.VolumeGroupSourceDetailsArgs(
        type="string",
        volume_group_backup_id="string",
        volume_group_id="string",
        volume_group_replica_id="string",
        volume_ids=["string"],
    ),
    defined_tags={
        "string": "any",
    },
    display_name="string",
    freeform_tags={
        "string": "any",
    },
    preserve_volume_replica=False,
    volume_group_replicas=[oci.core.VolumeGroupVolumeGroupReplicaArgs(
        availability_domain="string",
        display_name="string",
        volume_group_replica_id="string",
    )],
    volume_group_replicas_deletion=False,
    volume_ids=["string"])

    const volumeGroupResource = new oci.core.VolumeGroup("volumeGroupResource", {
    availabilityDomain: "string",
    compartmentId: "string",
    sourceDetails: {
        type: "string",
        volumeGroupBackupId: "string",
        volumeGroupId: "string",
        volumeGroupReplicaId: "string",
        volumeIds: ["string"],
    },
    definedTags: {
        string: "any",
    },
    displayName: "string",
    freeformTags: {
        string: "any",
    },
    preserveVolumeReplica: false,
    volumeGroupReplicas: [{
        availabilityDomain: "string",
        displayName: "string",
        volumeGroupReplicaId: "string",
    }],
    volumeGroupReplicasDeletion: false,
    volumeIds: ["string"],
});

    type: oci:Core:VolumeGroup
properties:
    availabilityDomain: string
    compartmentId: string
    definedTags:
        string: any
    displayName: string
    freeformTags:
        string: any
    preserveVolumeReplica: false
    sourceDetails:
        type: string
        volumeGroupBackupId: string
        volumeGroupId: string
        volumeGroupReplicaId: string
        volumeIds:
            - string
    volumeGroupReplicas:
        - availabilityDomain: string
          displayName: string
          volumeGroupReplicaId: string
    volumeGroupReplicasDeletion: false
    volumeIds:
        - string

    VolumeGroup Resource Properties

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

    Inputs

    The VolumeGroup resource accepts the following input properties:

    AvailabilityDomain string
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the volume group.
    SourceDetails VolumeGroupSourceDetails
    Specifies the source for a volume group.
    BackupPolicyId string
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    PreserveVolumeReplica bool
    VolumeGroupReplicas List<VolumeGroupVolumeGroupReplica>
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    VolumeGroupReplicasDeletion bool
    VolumeIds List<string>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the volume group.
    SourceDetails VolumeGroupSourceDetailsArgs
    Specifies the source for a volume group.
    BackupPolicyId string
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    PreserveVolumeReplica bool
    VolumeGroupReplicas []VolumeGroupVolumeGroupReplicaArgs
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    VolumeGroupReplicasDeletion bool
    VolumeIds []string

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment that contains the volume group.
    sourceDetails VolumeGroupSourceDetails
    Specifies the source for a volume group.
    backupPolicyId String
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    preserveVolumeReplica Boolean
    volumeGroupReplicas List<VolumeGroupVolumeGroupReplica>
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    volumeGroupReplicasDeletion Boolean
    volumeIds List<String>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    compartmentId string
    (Updatable) The OCID of the compartment that contains the volume group.
    sourceDetails VolumeGroupSourceDetails
    Specifies the source for a volume group.
    backupPolicyId string
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    preserveVolumeReplica boolean
    volumeGroupReplicas VolumeGroupVolumeGroupReplica[]
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    volumeGroupReplicasDeletion boolean
    volumeIds string[]

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    compartment_id str
    (Updatable) The OCID of the compartment that contains the volume group.
    source_details core.VolumeGroupSourceDetailsArgs
    Specifies the source for a volume group.
    backup_policy_id str
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    preserve_volume_replica bool
    volume_group_replicas Sequence[core.VolumeGroupVolumeGroupReplicaArgs]
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    volume_group_replicas_deletion bool
    volume_ids Sequence[str]

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment that contains the volume group.
    sourceDetails Property Map
    Specifies the source for a volume group.
    backupPolicyId String
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    preserveVolumeReplica Boolean
    volumeGroupReplicas List<Property Map>
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    volumeGroupReplicasDeletion Boolean
    volumeIds List<String>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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 VolumeGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IsHydrated bool
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    SizeInGbs string
    The aggregate size of the volume group in GBs.
    SizeInMbs string
    The aggregate size of the volume group in MBs.
    State string
    The current state of a volume group.
    TimeCreated string
    The date and time the volume group was created. Format defined by RFC3339.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsHydrated bool
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    SizeInGbs string
    The aggregate size of the volume group in GBs.
    SizeInMbs string
    The aggregate size of the volume group in MBs.
    State string
    The current state of a volume group.
    TimeCreated string
    The date and time the volume group was created. Format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    isHydrated Boolean
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    sizeInGbs String
    The aggregate size of the volume group in GBs.
    sizeInMbs String
    The aggregate size of the volume group in MBs.
    state String
    The current state of a volume group.
    timeCreated String
    The date and time the volume group was created. Format defined by RFC3339.
    id string
    The provider-assigned unique ID for this managed resource.
    isHydrated boolean
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    sizeInGbs string
    The aggregate size of the volume group in GBs.
    sizeInMbs string
    The aggregate size of the volume group in MBs.
    state string
    The current state of a volume group.
    timeCreated string
    The date and time the volume group was created. Format defined by RFC3339.
    id str
    The provider-assigned unique ID for this managed resource.
    is_hydrated bool
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    size_in_gbs str
    The aggregate size of the volume group in GBs.
    size_in_mbs str
    The aggregate size of the volume group in MBs.
    state str
    The current state of a volume group.
    time_created str
    The date and time the volume group was created. Format defined by RFC3339.
    id String
    The provider-assigned unique ID for this managed resource.
    isHydrated Boolean
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    sizeInGbs String
    The aggregate size of the volume group in GBs.
    sizeInMbs String
    The aggregate size of the volume group in MBs.
    state String
    The current state of a volume group.
    timeCreated String
    The date and time the volume group was created. Format defined by RFC3339.

    Look up Existing VolumeGroup Resource

    Get an existing VolumeGroup 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?: VolumeGroupState, opts?: CustomResourceOptions): VolumeGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_domain: Optional[str] = None,
        backup_policy_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_hydrated: Optional[bool] = None,
        preserve_volume_replica: Optional[bool] = None,
        size_in_gbs: Optional[str] = None,
        size_in_mbs: Optional[str] = None,
        source_details: Optional[_core.VolumeGroupSourceDetailsArgs] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        volume_group_replicas: Optional[Sequence[_core.VolumeGroupVolumeGroupReplicaArgs]] = None,
        volume_group_replicas_deletion: Optional[bool] = None,
        volume_ids: Optional[Sequence[str]] = None) -> VolumeGroup
    func GetVolumeGroup(ctx *Context, name string, id IDInput, state *VolumeGroupState, opts ...ResourceOption) (*VolumeGroup, error)
    public static VolumeGroup Get(string name, Input<string> id, VolumeGroupState? state, CustomResourceOptions? opts = null)
    public static VolumeGroup get(String name, Output<String> id, VolumeGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    BackupPolicyId string
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the volume group.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsHydrated bool
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    PreserveVolumeReplica bool
    SizeInGbs string
    The aggregate size of the volume group in GBs.
    SizeInMbs string
    The aggregate size of the volume group in MBs.
    SourceDetails VolumeGroupSourceDetails
    Specifies the source for a volume group.
    State string
    The current state of a volume group.
    TimeCreated string
    The date and time the volume group was created. Format defined by RFC3339.
    VolumeGroupReplicas List<VolumeGroupVolumeGroupReplica>
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    VolumeGroupReplicasDeletion bool
    VolumeIds List<string>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    BackupPolicyId string
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the volume group.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    IsHydrated bool
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    PreserveVolumeReplica bool
    SizeInGbs string
    The aggregate size of the volume group in GBs.
    SizeInMbs string
    The aggregate size of the volume group in MBs.
    SourceDetails VolumeGroupSourceDetailsArgs
    Specifies the source for a volume group.
    State string
    The current state of a volume group.
    TimeCreated string
    The date and time the volume group was created. Format defined by RFC3339.
    VolumeGroupReplicas []VolumeGroupVolumeGroupReplicaArgs
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    VolumeGroupReplicasDeletion bool
    VolumeIds []string

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    backupPolicyId String
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    compartmentId String
    (Updatable) The OCID of the compartment that contains the volume group.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isHydrated Boolean
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    preserveVolumeReplica Boolean
    sizeInGbs String
    The aggregate size of the volume group in GBs.
    sizeInMbs String
    The aggregate size of the volume group in MBs.
    sourceDetails VolumeGroupSourceDetails
    Specifies the source for a volume group.
    state String
    The current state of a volume group.
    timeCreated String
    The date and time the volume group was created. Format defined by RFC3339.
    volumeGroupReplicas List<VolumeGroupVolumeGroupReplica>
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    volumeGroupReplicasDeletion Boolean
    volumeIds List<String>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    backupPolicyId string
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    compartmentId string
    (Updatable) The OCID of the compartment that contains the volume group.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isHydrated boolean
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    preserveVolumeReplica boolean
    sizeInGbs string
    The aggregate size of the volume group in GBs.
    sizeInMbs string
    The aggregate size of the volume group in MBs.
    sourceDetails VolumeGroupSourceDetails
    Specifies the source for a volume group.
    state string
    The current state of a volume group.
    timeCreated string
    The date and time the volume group was created. Format defined by RFC3339.
    volumeGroupReplicas VolumeGroupVolumeGroupReplica[]
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    volumeGroupReplicasDeletion boolean
    volumeIds string[]

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    backup_policy_id str
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    compartment_id str
    (Updatable) The OCID of the compartment that contains the volume group.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    is_hydrated bool
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    preserve_volume_replica bool
    size_in_gbs str
    The aggregate size of the volume group in GBs.
    size_in_mbs str
    The aggregate size of the volume group in MBs.
    source_details core.VolumeGroupSourceDetailsArgs
    Specifies the source for a volume group.
    state str
    The current state of a volume group.
    time_created str
    The date and time the volume group was created. Format defined by RFC3339.
    volume_group_replicas Sequence[core.VolumeGroupVolumeGroupReplicaArgs]
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    volume_group_replicas_deletion bool
    volume_ids Sequence[str]

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    backupPolicyId String
    If provided, specifies the ID of the volume backup policy to assign to the newly created volume group. If omitted, no policy will be assigned. This field is deprecated. Use the oci.Core.getVolumeBackupPolicyAssignments instead to assign a backup policy to a volume group.

    Deprecated: The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead.

    compartmentId String
    (Updatable) The OCID of the compartment that contains the volume group.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    isHydrated Boolean
    Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
    preserveVolumeReplica Boolean
    sizeInGbs String
    The aggregate size of the volume group in GBs.
    sizeInMbs String
    The aggregate size of the volume group in MBs.
    sourceDetails Property Map
    Specifies the source for a volume group.
    state String
    The current state of a volume group.
    timeCreated String
    The date and time the volume group was created. Format defined by RFC3339.
    volumeGroupReplicas List<Property Map>
    (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
    volumeGroupReplicasDeletion Boolean
    volumeIds List<String>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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

    Supporting Types

    VolumeGroupSourceDetails, VolumeGroupSourceDetailsArgs

    Type string
    The type can be one of these values: volumeGroupBackupId, volumeGroupId, volumeGroupReplicaId, volumeIds
    VolumeGroupBackupId string
    The OCID of the volume group backup to restore from.
    VolumeGroupId string
    The OCID of the volume group to clone from.
    VolumeGroupReplicaId string
    The OCID of the volume group replica.
    VolumeIds List<string>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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

    Type string
    The type can be one of these values: volumeGroupBackupId, volumeGroupId, volumeGroupReplicaId, volumeIds
    VolumeGroupBackupId string
    The OCID of the volume group backup to restore from.
    VolumeGroupId string
    The OCID of the volume group to clone from.
    VolumeGroupReplicaId string
    The OCID of the volume group replica.
    VolumeIds []string

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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

    type String
    The type can be one of these values: volumeGroupBackupId, volumeGroupId, volumeGroupReplicaId, volumeIds
    volumeGroupBackupId String
    The OCID of the volume group backup to restore from.
    volumeGroupId String
    The OCID of the volume group to clone from.
    volumeGroupReplicaId String
    The OCID of the volume group replica.
    volumeIds List<String>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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

    type string
    The type can be one of these values: volumeGroupBackupId, volumeGroupId, volumeGroupReplicaId, volumeIds
    volumeGroupBackupId string
    The OCID of the volume group backup to restore from.
    volumeGroupId string
    The OCID of the volume group to clone from.
    volumeGroupReplicaId string
    The OCID of the volume group replica.
    volumeIds string[]

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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

    type str
    The type can be one of these values: volumeGroupBackupId, volumeGroupId, volumeGroupReplicaId, volumeIds
    volume_group_backup_id str
    The OCID of the volume group backup to restore from.
    volume_group_id str
    The OCID of the volume group to clone from.
    volume_group_replica_id str
    The OCID of the volume group replica.
    volume_ids Sequence[str]

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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

    type String
    The type can be one of these values: volumeGroupBackupId, volumeGroupId, volumeGroupReplicaId, volumeIds
    volumeGroupBackupId String
    The OCID of the volume group backup to restore from.
    volumeGroupId String
    The OCID of the volume group to clone from.
    volumeGroupReplicaId String
    The OCID of the volume group replica.
    volumeIds List<String>

    (Updatable) Use this for update operation only. This field is not supported during creation. For create use volume_ids under source_details.

    ** 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

    VolumeGroupVolumeGroupReplica, VolumeGroupVolumeGroupReplicaArgs

    AvailabilityDomain string
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    VolumeGroupReplicaId string
    The OCID of the volume group replica.
    AvailabilityDomain string
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    VolumeGroupReplicaId string
    The OCID of the volume group replica.
    availabilityDomain String
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    volumeGroupReplicaId String
    The OCID of the volume group replica.
    availabilityDomain string
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    volumeGroupReplicaId string
    The OCID of the volume group replica.
    availability_domain str
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    volume_group_replica_id str
    The OCID of the volume group replica.
    availabilityDomain String
    (Updatable) The availability domain of the volume group replica. Example: Uocm:PHX-AD-1
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    volumeGroupReplicaId String
    The OCID of the volume group replica.

    Import

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

    $ pulumi import oci:Core/volumeGroup:VolumeGroup test_volume_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 v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-oci