oci.Core.VolumeGroup
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testVolumeGroup = new oci.core.VolumeGroup("test_volume_group", {
availabilityDomain: volumeGroupAvailabilityDomain,
compartmentId: compartmentId,
sourceDetails: {
type: "volumeIds",
volumeIds: [volumeGroupSourceId],
},
backupPolicyId: testVolumeBackupPolicies.volumeBackupPolicies[0].id,
clusterPlacementGroupId: testGroup.id,
definedTags: {
"Operations.CostCenter": "42",
},
displayName: volumeGroupDisplayName,
freeformTags: {
Department: "Finance",
},
volumeGroupReplicas: [{
availabilityDomain: volumeGroupVolumeGroupReplicasAvailabilityDomain,
displayName: volumeGroupVolumeGroupReplicasDisplayName,
}],
volumeIds: [volumeGroupSourceId],
});
import pulumi
import pulumi_oci as oci
test_volume_group = oci.core.VolumeGroup("test_volume_group",
availability_domain=volume_group_availability_domain,
compartment_id=compartment_id,
source_details=oci.core.VolumeGroupSourceDetailsArgs(
type="volumeIds",
volume_ids=[volume_group_source_id],
),
backup_policy_id=test_volume_backup_policies["volumeBackupPolicies"][0]["id"],
cluster_placement_group_id=test_group["id"],
defined_tags={
"Operations.CostCenter": "42",
},
display_name=volume_group_display_name,
freeform_tags={
"Department": "Finance",
},
volume_group_replicas=[oci.core.VolumeGroupVolumeGroupReplicaArgs(
availability_domain=volume_group_volume_group_replicas_availability_domain,
display_name=volume_group_volume_group_replicas_display_name,
)],
volume_ids=[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, "test_volume_group", &Core.VolumeGroupArgs{
AvailabilityDomain: pulumi.Any(volumeGroupAvailabilityDomain),
CompartmentId: pulumi.Any(compartmentId),
SourceDetails: &core.VolumeGroupSourceDetailsArgs{
Type: pulumi.String("volumeIds"),
VolumeIds: pulumi.StringArray{
volumeGroupSourceId,
},
},
BackupPolicyId: pulumi.Any(testVolumeBackupPolicies.VolumeBackupPolicies[0].Id),
ClusterPlacementGroupId: pulumi.Any(testGroup.Id),
DefinedTags: pulumi.Map{
"Operations.CostCenter": pulumi.Any("42"),
},
DisplayName: pulumi.Any(volumeGroupDisplayName),
FreeformTags: pulumi.Map{
"Department": pulumi.Any("Finance"),
},
VolumeGroupReplicas: core.VolumeGroupVolumeGroupReplicaArray{
&core.VolumeGroupVolumeGroupReplicaArgs{
AvailabilityDomain: pulumi.Any(volumeGroupVolumeGroupReplicasAvailabilityDomain),
DisplayName: pulumi.Any(volumeGroupVolumeGroupReplicasDisplayName),
},
},
VolumeIds: pulumi.StringArray{
volumeGroupSourceId,
},
})
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("test_volume_group", new()
{
AvailabilityDomain = volumeGroupAvailabilityDomain,
CompartmentId = compartmentId,
SourceDetails = new Oci.Core.Inputs.VolumeGroupSourceDetailsArgs
{
Type = "volumeIds",
VolumeIds = new[]
{
volumeGroupSourceId,
},
},
BackupPolicyId = testVolumeBackupPolicies.VolumeBackupPolicies[0].Id,
ClusterPlacementGroupId = testGroup.Id,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
DisplayName = volumeGroupDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
VolumeGroupReplicas = new[]
{
new Oci.Core.Inputs.VolumeGroupVolumeGroupReplicaArgs
{
AvailabilityDomain = volumeGroupVolumeGroupReplicasAvailabilityDomain,
DisplayName = volumeGroupVolumeGroupReplicasDisplayName,
},
},
VolumeIds = new[]
{
volumeGroupSourceId,
},
});
});
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(volumeGroupAvailabilityDomain)
.compartmentId(compartmentId)
.sourceDetails(VolumeGroupSourceDetailsArgs.builder()
.type("volumeIds")
.volumeIds(volumeGroupSourceId)
.build())
.backupPolicyId(testVolumeBackupPolicies.volumeBackupPolicies()[0].id())
.clusterPlacementGroupId(testGroup.id())
.definedTags(Map.of("Operations.CostCenter", "42"))
.displayName(volumeGroupDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.volumeGroupReplicas(VolumeGroupVolumeGroupReplicaArgs.builder()
.availabilityDomain(volumeGroupVolumeGroupReplicasAvailabilityDomain)
.displayName(volumeGroupVolumeGroupReplicasDisplayName)
.build())
.volumeIds(volumeGroupSourceId)
.build());
}
}
resources:
testVolumeGroup:
type: oci:Core:VolumeGroup
name: test_volume_group
properties:
availabilityDomain: ${volumeGroupAvailabilityDomain}
compartmentId: ${compartmentId}
sourceDetails:
type: volumeIds
volumeIds:
- ${volumeGroupSourceId}
backupPolicyId: ${testVolumeBackupPolicies.volumeBackupPolicies[0].id}
clusterPlacementGroupId: ${testGroup.id}
definedTags:
Operations.CostCenter: '42'
displayName: ${volumeGroupDisplayName}
freeformTags:
Department: Finance
volumeGroupReplicas:
- availabilityDomain: ${volumeGroupVolumeGroupReplicasAvailabilityDomain}
displayName: ${volumeGroupVolumeGroupReplicasDisplayName}
volumeIds:
- ${volumeGroupSourceId}
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,
cluster_placement_group_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.
Constructor 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",
},
},
ClusterPlacementGroupId = "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"),
},
},
ClusterPlacementGroupId: 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())
.clusterPlacementGroupId("string")
.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"],
),
cluster_placement_group_id="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"],
},
clusterPlacementGroupId: "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
clusterPlacementGroupId: 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:
- Availability
Domain string - The availability domain of the volume group.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the volume group.
- Source
Details VolumeGroup Source Details - Specifies the source for a volume group.
- Backup
Policy stringId - 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. - Cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- 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"}
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- Preserve
Volume boolReplica - Volume
Group List<VolumeReplicas Group Volume Group Replica> - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- Volume
Group boolReplicas Deletion - Volume
Ids List<string> (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 string - The availability domain of the volume group.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the volume group.
- Source
Details VolumeGroup Source Details Args - Specifies the source for a volume group.
- Backup
Policy stringId - 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. - Cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- 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"}
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- Preserve
Volume boolReplica - Volume
Group []VolumeReplicas Group Volume Group Replica Args - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- Volume
Group boolReplicas Deletion - Volume
Ids []string (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 String - The availability domain of the volume group.
- compartment
Id String - (Updatable) The OCID of the compartment that contains the volume group.
- source
Details VolumeGroup Source Details - Specifies the source for a volume group.
- backup
Policy StringId - 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. - cluster
Placement StringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- 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"}
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- preserve
Volume BooleanReplica - volume
Group List<VolumeReplicas Group Volume Group Replica> - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- volume
Group BooleanReplicas Deletion - volume
Ids List<String> (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 string - The availability domain of the volume group.
- compartment
Id string - (Updatable) The OCID of the compartment that contains the volume group.
- source
Details VolumeGroup Source Details - Specifies the source for a volume group.
- backup
Policy stringId - 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. - cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- {[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"}
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[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"}
- preserve
Volume booleanReplica - volume
Group VolumeReplicas Group Volume Group Replica[] - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- volume
Group booleanReplicas Deletion - volume
Ids string[] (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 - The availability domain of the volume group.
- compartment_
id str - (Updatable) The OCID of the compartment that contains the volume group.
- source_
details core.Volume Group Source Details Args - Specifies the source for a volume group.
- backup_
policy_ strid - 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. - cluster_
placement_ strgroup_ id - The clusterPlacementGroup Id of the volume group for volume group placement.
- 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.
- 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_ boolreplica - volume_
group_ Sequence[core.replicas Volume Group Volume Group Replica Args] - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- volume_
group_ boolreplicas_ deletion - volume_
ids Sequence[str] (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 String - The availability domain of the volume group.
- compartment
Id String - (Updatable) The OCID of the compartment that contains the volume group.
- source
Details Property Map - Specifies the source for a volume group.
- backup
Policy StringId - 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. - cluster
Placement StringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- 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"}
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- preserve
Volume BooleanReplica - volume
Group List<Property Map>Replicas - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- volume
Group BooleanReplicas Deletion - volume
Ids List<String> (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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.
- 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 stringGbs - The aggregate size of the volume group in GBs.
- Size
In stringMbs - The aggregate size of the volume group in MBs.
- State string
- The current state of a volume group.
- Time
Created 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.
- 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 stringGbs - The aggregate size of the volume group in GBs.
- Size
In stringMbs - The aggregate size of the volume group in MBs.
- State string
- The current state of a volume group.
- Time
Created 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.
- is
Hydrated Boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- size
In StringGbs - The aggregate size of the volume group in GBs.
- size
In StringMbs - The aggregate size of the volume group in MBs.
- state String
- The current state of a volume group.
- time
Created 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.
- is
Hydrated boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- size
In stringGbs - The aggregate size of the volume group in GBs.
- size
In stringMbs - The aggregate size of the volume group in MBs.
- state string
- The current state of a volume group.
- time
Created 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_ strgbs - The aggregate size of the volume group in GBs.
- size_
in_ strmbs - 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.
- is
Hydrated Boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- size
In StringGbs - The aggregate size of the volume group in GBs.
- size
In StringMbs - The aggregate size of the volume group in MBs.
- state String
- The current state of a volume group.
- time
Created 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,
cluster_placement_group_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.
- Availability
Domain string - The availability domain of the volume group.
- Backup
Policy stringId - 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. - Cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the volume group.
- 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"}
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- 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 boolReplica - Size
In stringGbs - The aggregate size of the volume group in GBs.
- Size
In stringMbs - The aggregate size of the volume group in MBs.
- Source
Details VolumeGroup Source Details - Specifies the source for a volume group.
- State string
- The current state of a volume group.
- Time
Created string - The date and time the volume group was created. Format defined by RFC3339.
- Volume
Group List<VolumeReplicas Group Volume Group Replica> - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- Volume
Group boolReplicas Deletion - Volume
Ids List<string> (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 string - The availability domain of the volume group.
- Backup
Policy stringId - 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. - Cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the volume group.
- 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"}
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- 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 boolReplica - Size
In stringGbs - The aggregate size of the volume group in GBs.
- Size
In stringMbs - The aggregate size of the volume group in MBs.
- Source
Details VolumeGroup Source Details Args - Specifies the source for a volume group.
- State string
- The current state of a volume group.
- Time
Created string - The date and time the volume group was created. Format defined by RFC3339.
- Volume
Group []VolumeReplicas Group Volume Group Replica Args - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- Volume
Group boolReplicas Deletion - Volume
Ids []string (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 String - The availability domain of the volume group.
- backup
Policy StringId - 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. - cluster
Placement StringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- compartment
Id String - (Updatable) The OCID of the compartment that contains the volume group.
- 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"}
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- is
Hydrated Boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- preserve
Volume BooleanReplica - size
In StringGbs - The aggregate size of the volume group in GBs.
- size
In StringMbs - The aggregate size of the volume group in MBs.
- source
Details VolumeGroup Source Details - Specifies the source for a volume group.
- state String
- The current state of a volume group.
- time
Created String - The date and time the volume group was created. Format defined by RFC3339.
- volume
Group List<VolumeReplicas Group Volume Group Replica> - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- volume
Group BooleanReplicas Deletion - volume
Ids List<String> (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 string - The availability domain of the volume group.
- backup
Policy stringId - 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. - cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- compartment
Id string - (Updatable) The OCID of the compartment that contains the volume group.
- {[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"}
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- {[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"}
- is
Hydrated boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- preserve
Volume booleanReplica - size
In stringGbs - The aggregate size of the volume group in GBs.
- size
In stringMbs - The aggregate size of the volume group in MBs.
- source
Details VolumeGroup Source Details - Specifies the source for a volume group.
- state string
- The current state of a volume group.
- time
Created string - The date and time the volume group was created. Format defined by RFC3339.
- volume
Group VolumeReplicas Group Volume Group Replica[] - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- volume
Group booleanReplicas Deletion - volume
Ids string[] (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 - The availability domain of the volume group.
- backup_
policy_ strid - 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. - cluster_
placement_ strgroup_ id - The clusterPlacementGroup Id of the volume group for volume group placement.
- compartment_
id str - (Updatable) The OCID of the compartment that contains the volume group.
- 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.
- 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_ boolreplica - size_
in_ strgbs - The aggregate size of the volume group in GBs.
- size_
in_ strmbs - The aggregate size of the volume group in MBs.
- source_
details core.Volume Group Source Details Args - 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_ Sequence[core.replicas Volume Group Volume Group Replica Args] - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- volume_
group_ boolreplicas_ deletion - volume_
ids Sequence[str] (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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 String - The availability domain of the volume group.
- backup
Policy StringId - 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. - cluster
Placement StringGroup Id - The clusterPlacementGroup Id of the volume group for volume group placement.
- compartment
Id String - (Updatable) The OCID of the compartment that contains the volume group.
- 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"}
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- 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"}
- is
Hydrated Boolean - Specifies whether the newly created cloned volume group's data has finished copying from the source volume group or backup.
- preserve
Volume BooleanReplica - size
In StringGbs - The aggregate size of the volume group in GBs.
- size
In StringMbs - The aggregate size of the volume group in MBs.
- source
Details Property Map - Specifies the source for a volume group.
- state String
- The current state of a volume group.
- time
Created String - The date and time the volume group was created. Format defined by RFC3339.
- volume
Group List<Property Map>Replicas - (Updatable) The list of volume group replicas that this volume group will be enabled to have in the specified destination availability domains.
- volume
Group BooleanReplicas Deletion - volume
Ids List<String> (Updatable) Use this for update operation only. This field is not supported during creation. For create use
volume_ids
undersource_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
- Volume
Group stringBackup Id - The OCID of the volume group backup to restore from.
- Volume
Group stringId - The OCID of the volume group to clone from.
- Volume
Group stringReplica Id - The OCID of the volume group replica.
- Volume
Ids List<string> - OCIDs for the volumes used to create this volume group.
- Type string
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeGroupReplicaId
,volumeIds
- Volume
Group stringBackup Id - The OCID of the volume group backup to restore from.
- Volume
Group stringId - The OCID of the volume group to clone from.
- Volume
Group stringReplica Id - The OCID of the volume group replica.
- Volume
Ids []string - OCIDs for the volumes used to create this volume group.
- type String
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeGroupReplicaId
,volumeIds
- volume
Group StringBackup Id - The OCID of the volume group backup to restore from.
- volume
Group StringId - The OCID of the volume group to clone from.
- volume
Group StringReplica Id - The OCID of the volume group replica.
- volume
Ids List<String> - OCIDs for the volumes used to create this volume group.
- type string
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeGroupReplicaId
,volumeIds
- volume
Group stringBackup Id - The OCID of the volume group backup to restore from.
- volume
Group stringId - The OCID of the volume group to clone from.
- volume
Group stringReplica Id - The OCID of the volume group replica.
- volume
Ids string[] - OCIDs for the volumes used to create this volume group.
- type str
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeGroupReplicaId
,volumeIds
- volume_
group_ strbackup_ id - The OCID of the volume group backup to restore from.
- volume_
group_ strid - The OCID of the volume group to clone from.
- volume_
group_ strreplica_ id - The OCID of the volume group replica.
- volume_
ids Sequence[str] - OCIDs for the volumes used to create this volume group.
- type String
- The type can be one of these values:
volumeGroupBackupId
,volumeGroupId
,volumeGroupReplicaId
,volumeIds
- volume
Group StringBackup Id - The OCID of the volume group backup to restore from.
- volume
Group StringId - The OCID of the volume group to clone from.
- volume
Group StringReplica Id - The OCID of the volume group replica.
- volume
Ids List<String> - OCIDs for the volumes used to create this volume group.
VolumeGroupVolumeGroupReplica, VolumeGroupVolumeGroupReplicaArgs
- Availability
Domain string - (Updatable) The availability domain of the volume group replica. Example:
Uocm:PHX-AD-1
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- Availability
Domain string - (Updatable) The availability domain of the volume group replica. Example:
Uocm:PHX-AD-1
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- availability
Domain String - (Updatable) The availability domain of the volume group replica. Example:
Uocm:PHX-AD-1
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- volume
Group StringReplica Id - The volume group replica's Oracle ID (OCID).
- availability
Domain string - (Updatable) The availability domain of the volume group replica. Example:
Uocm:PHX-AD-1
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- volume
Group stringReplica Id - The volume group replica's Oracle ID (OCID).
- 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_ strreplica_ id - The volume group replica's Oracle ID (OCID).
- availability
Domain String - (Updatable) The availability domain of the volume group replica. Example:
Uocm:PHX-AD-1
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- volume
Group StringReplica Id - The volume group replica's Oracle ID (OCID).
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.