oci.Core.BootVolume
Explore with Pulumi AI
This resource provides the Boot Volume resource in Oracle Cloud Infrastructure Core service.
Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. For general information about boot volumes, see Boot Volumes. You may optionally specify a display name for the volume, which is simply a friendly name or description. It does not have to be unique, and you can change it. Avoid entering confidential information.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testBootVolume = new oci.core.BootVolume("test_boot_volume", {
compartmentId: compartmentId,
sourceDetails: {
type: bootVolumeSourceDetailsType,
changeBlockSizeInBytes: bootVolumeSourceDetailsChangeBlockSizeInBytes,
firstBackupId: testBackup.id,
id: bootVolumeSourceDetailsId,
secondBackupId: testBackup.id,
},
autotunePolicies: [{
autotuneType: bootVolumeAutotunePoliciesAutotuneType,
maxVpusPerGb: bootVolumeAutotunePoliciesMaxVpusPerGb,
}],
availabilityDomain: bootVolumeAvailabilityDomain,
backupPolicyId: testVolumeBackupPolicies.volumeBackupPolicies[0].id,
bootVolumeReplicas: [{
availabilityDomain: bootVolumeBootVolumeReplicasAvailabilityDomain,
displayName: bootVolumeBootVolumeReplicasDisplayName,
xrrKmsKeyId: testKey.id,
}],
clusterPlacementGroupId: testGroup.id,
definedTags: {
"Operations.CostCenter": "42",
},
displayName: bootVolumeDisplayName,
freeformTags: {
Department: "Finance",
},
isAutoTuneEnabled: bootVolumeIsAutoTuneEnabled,
kmsKeyId: testKey.id,
sizeInGbs: bootVolumeSizeInGbs,
vpusPerGb: bootVolumeVpusPerGb,
xrcKmsKeyId: testKey.id,
bootVolumeReplicasDeletion: true,
});
import pulumi
import pulumi_oci as oci
test_boot_volume = oci.core.BootVolume("test_boot_volume",
compartment_id=compartment_id,
source_details={
"type": boot_volume_source_details_type,
"change_block_size_in_bytes": boot_volume_source_details_change_block_size_in_bytes,
"first_backup_id": test_backup["id"],
"id": boot_volume_source_details_id,
"second_backup_id": test_backup["id"],
},
autotune_policies=[{
"autotune_type": boot_volume_autotune_policies_autotune_type,
"max_vpus_per_gb": boot_volume_autotune_policies_max_vpus_per_gb,
}],
availability_domain=boot_volume_availability_domain,
backup_policy_id=test_volume_backup_policies["volumeBackupPolicies"][0]["id"],
boot_volume_replicas=[{
"availability_domain": boot_volume_boot_volume_replicas_availability_domain,
"display_name": boot_volume_boot_volume_replicas_display_name,
"xrr_kms_key_id": test_key["id"],
}],
cluster_placement_group_id=test_group["id"],
defined_tags={
"Operations.CostCenter": "42",
},
display_name=boot_volume_display_name,
freeform_tags={
"Department": "Finance",
},
is_auto_tune_enabled=boot_volume_is_auto_tune_enabled,
kms_key_id=test_key["id"],
size_in_gbs=boot_volume_size_in_gbs,
vpus_per_gb=boot_volume_vpus_per_gb,
xrc_kms_key_id=test_key["id"],
boot_volume_replicas_deletion=True)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Core"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Core.NewBootVolume(ctx, "test_boot_volume", &Core.BootVolumeArgs{
CompartmentId: pulumi.Any(compartmentId),
SourceDetails: &core.BootVolumeSourceDetailsArgs{
Type: pulumi.Any(bootVolumeSourceDetailsType),
ChangeBlockSizeInBytes: pulumi.Any(bootVolumeSourceDetailsChangeBlockSizeInBytes),
FirstBackupId: pulumi.Any(testBackup.Id),
Id: pulumi.Any(bootVolumeSourceDetailsId),
SecondBackupId: pulumi.Any(testBackup.Id),
},
AutotunePolicies: core.BootVolumeAutotunePolicyArray{
&core.BootVolumeAutotunePolicyArgs{
AutotuneType: pulumi.Any(bootVolumeAutotunePoliciesAutotuneType),
MaxVpusPerGb: pulumi.Any(bootVolumeAutotunePoliciesMaxVpusPerGb),
},
},
AvailabilityDomain: pulumi.Any(bootVolumeAvailabilityDomain),
BackupPolicyId: pulumi.Any(testVolumeBackupPolicies.VolumeBackupPolicies[0].Id),
BootVolumeReplicas: core.BootVolumeBootVolumeReplicaArray{
&core.BootVolumeBootVolumeReplicaArgs{
AvailabilityDomain: pulumi.Any(bootVolumeBootVolumeReplicasAvailabilityDomain),
DisplayName: pulumi.Any(bootVolumeBootVolumeReplicasDisplayName),
XrrKmsKeyId: pulumi.Any(testKey.Id),
},
},
ClusterPlacementGroupId: pulumi.Any(testGroup.Id),
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
DisplayName: pulumi.Any(bootVolumeDisplayName),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
IsAutoTuneEnabled: pulumi.Any(bootVolumeIsAutoTuneEnabled),
KmsKeyId: pulumi.Any(testKey.Id),
SizeInGbs: pulumi.Any(bootVolumeSizeInGbs),
VpusPerGb: pulumi.Any(bootVolumeVpusPerGb),
XrcKmsKeyId: pulumi.Any(testKey.Id),
BootVolumeReplicasDeletion: pulumi.Bool(true),
})
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 testBootVolume = new Oci.Core.BootVolume("test_boot_volume", new()
{
CompartmentId = compartmentId,
SourceDetails = new Oci.Core.Inputs.BootVolumeSourceDetailsArgs
{
Type = bootVolumeSourceDetailsType,
ChangeBlockSizeInBytes = bootVolumeSourceDetailsChangeBlockSizeInBytes,
FirstBackupId = testBackup.Id,
Id = bootVolumeSourceDetailsId,
SecondBackupId = testBackup.Id,
},
AutotunePolicies = new[]
{
new Oci.Core.Inputs.BootVolumeAutotunePolicyArgs
{
AutotuneType = bootVolumeAutotunePoliciesAutotuneType,
MaxVpusPerGb = bootVolumeAutotunePoliciesMaxVpusPerGb,
},
},
AvailabilityDomain = bootVolumeAvailabilityDomain,
BackupPolicyId = testVolumeBackupPolicies.VolumeBackupPolicies[0].Id,
BootVolumeReplicas = new[]
{
new Oci.Core.Inputs.BootVolumeBootVolumeReplicaArgs
{
AvailabilityDomain = bootVolumeBootVolumeReplicasAvailabilityDomain,
DisplayName = bootVolumeBootVolumeReplicasDisplayName,
XrrKmsKeyId = testKey.Id,
},
},
ClusterPlacementGroupId = testGroup.Id,
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
DisplayName = bootVolumeDisplayName,
FreeformTags =
{
{ "Department", "Finance" },
},
IsAutoTuneEnabled = bootVolumeIsAutoTuneEnabled,
KmsKeyId = testKey.Id,
SizeInGbs = bootVolumeSizeInGbs,
VpusPerGb = bootVolumeVpusPerGb,
XrcKmsKeyId = testKey.Id,
BootVolumeReplicasDeletion = true,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.BootVolume;
import com.pulumi.oci.Core.BootVolumeArgs;
import com.pulumi.oci.Core.inputs.BootVolumeSourceDetailsArgs;
import com.pulumi.oci.Core.inputs.BootVolumeAutotunePolicyArgs;
import com.pulumi.oci.Core.inputs.BootVolumeBootVolumeReplicaArgs;
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 testBootVolume = new BootVolume("testBootVolume", BootVolumeArgs.builder()
.compartmentId(compartmentId)
.sourceDetails(BootVolumeSourceDetailsArgs.builder()
.type(bootVolumeSourceDetailsType)
.changeBlockSizeInBytes(bootVolumeSourceDetailsChangeBlockSizeInBytes)
.firstBackupId(testBackup.id())
.id(bootVolumeSourceDetailsId)
.secondBackupId(testBackup.id())
.build())
.autotunePolicies(BootVolumeAutotunePolicyArgs.builder()
.autotuneType(bootVolumeAutotunePoliciesAutotuneType)
.maxVpusPerGb(bootVolumeAutotunePoliciesMaxVpusPerGb)
.build())
.availabilityDomain(bootVolumeAvailabilityDomain)
.backupPolicyId(testVolumeBackupPolicies.volumeBackupPolicies()[0].id())
.bootVolumeReplicas(BootVolumeBootVolumeReplicaArgs.builder()
.availabilityDomain(bootVolumeBootVolumeReplicasAvailabilityDomain)
.displayName(bootVolumeBootVolumeReplicasDisplayName)
.xrrKmsKeyId(testKey.id())
.build())
.clusterPlacementGroupId(testGroup.id())
.definedTags(Map.of("Operations.CostCenter", "42"))
.displayName(bootVolumeDisplayName)
.freeformTags(Map.of("Department", "Finance"))
.isAutoTuneEnabled(bootVolumeIsAutoTuneEnabled)
.kmsKeyId(testKey.id())
.sizeInGbs(bootVolumeSizeInGbs)
.vpusPerGb(bootVolumeVpusPerGb)
.xrcKmsKeyId(testKey.id())
.bootVolumeReplicasDeletion(true)
.build());
}
}
resources:
testBootVolume:
type: oci:Core:BootVolume
name: test_boot_volume
properties:
compartmentId: ${compartmentId}
sourceDetails:
type: ${bootVolumeSourceDetailsType}
changeBlockSizeInBytes: ${bootVolumeSourceDetailsChangeBlockSizeInBytes}
firstBackupId: ${testBackup.id}
id: ${bootVolumeSourceDetailsId}
secondBackupId: ${testBackup.id}
autotunePolicies:
- autotuneType: ${bootVolumeAutotunePoliciesAutotuneType}
maxVpusPerGb: ${bootVolumeAutotunePoliciesMaxVpusPerGb}
availabilityDomain: ${bootVolumeAvailabilityDomain}
backupPolicyId: ${testVolumeBackupPolicies.volumeBackupPolicies[0].id}
bootVolumeReplicas:
- availabilityDomain: ${bootVolumeBootVolumeReplicasAvailabilityDomain}
displayName: ${bootVolumeBootVolumeReplicasDisplayName}
xrrKmsKeyId: ${testKey.id}
clusterPlacementGroupId: ${testGroup.id}
definedTags:
Operations.CostCenter: '42'
displayName: ${bootVolumeDisplayName}
freeformTags:
Department: Finance
isAutoTuneEnabled: ${bootVolumeIsAutoTuneEnabled}
kmsKeyId: ${testKey.id}
sizeInGbs: ${bootVolumeSizeInGbs}
vpusPerGb: ${bootVolumeVpusPerGb}
xrcKmsKeyId: ${testKey.id}
bootVolumeReplicasDeletion: true
Create BootVolume Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BootVolume(name: string, args: BootVolumeArgs, opts?: CustomResourceOptions);
@overload
def BootVolume(resource_name: str,
args: BootVolumeArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BootVolume(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
availability_domain: Optional[str] = None,
source_details: Optional[_core.BootVolumeSourceDetailsArgs] = None,
display_name: Optional[str] = None,
boot_volume_replicas_deletion: Optional[bool] = None,
cluster_placement_group_id: Optional[str] = None,
boot_volume_replicas: Optional[Sequence[_core.BootVolumeBootVolumeReplicaArgs]] = None,
defined_tags: Optional[Mapping[str, str]] = None,
autotune_policies: Optional[Sequence[_core.BootVolumeAutotunePolicyArgs]] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
is_auto_tune_enabled: Optional[bool] = None,
kms_key_id: Optional[str] = None,
size_in_gbs: Optional[str] = None,
backup_policy_id: Optional[str] = None,
vpus_per_gb: Optional[str] = None,
xrc_kms_key_id: Optional[str] = None)
func NewBootVolume(ctx *Context, name string, args BootVolumeArgs, opts ...ResourceOption) (*BootVolume, error)
public BootVolume(string name, BootVolumeArgs args, CustomResourceOptions? opts = null)
public BootVolume(String name, BootVolumeArgs args)
public BootVolume(String name, BootVolumeArgs args, CustomResourceOptions options)
type: oci:Core:BootVolume
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 BootVolumeArgs
- 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 BootVolumeArgs
- 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 BootVolumeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BootVolumeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BootVolumeArgs
- 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 bootVolumeResource = new Oci.Core.BootVolume("bootVolumeResource", new()
{
CompartmentId = "string",
AvailabilityDomain = "string",
SourceDetails = new Oci.Core.Inputs.BootVolumeSourceDetailsArgs
{
Type = "string",
ChangeBlockSizeInBytes = "string",
FirstBackupId = "string",
Id = "string",
SecondBackupId = "string",
},
DisplayName = "string",
BootVolumeReplicasDeletion = false,
ClusterPlacementGroupId = "string",
BootVolumeReplicas = new[]
{
new Oci.Core.Inputs.BootVolumeBootVolumeReplicaArgs
{
AvailabilityDomain = "string",
BootVolumeReplicaId = "string",
DisplayName = "string",
KmsKeyId = "string",
XrrKmsKeyId = "string",
},
},
DefinedTags =
{
{ "string", "string" },
},
AutotunePolicies = new[]
{
new Oci.Core.Inputs.BootVolumeAutotunePolicyArgs
{
AutotuneType = "string",
MaxVpusPerGb = "string",
},
},
FreeformTags =
{
{ "string", "string" },
},
IsAutoTuneEnabled = false,
KmsKeyId = "string",
SizeInGbs = "string",
VpusPerGb = "string",
XrcKmsKeyId = "string",
});
example, err := Core.NewBootVolume(ctx, "bootVolumeResource", &Core.BootVolumeArgs{
CompartmentId: pulumi.String("string"),
AvailabilityDomain: pulumi.String("string"),
SourceDetails: &core.BootVolumeSourceDetailsArgs{
Type: pulumi.String("string"),
ChangeBlockSizeInBytes: pulumi.String("string"),
FirstBackupId: pulumi.String("string"),
Id: pulumi.String("string"),
SecondBackupId: pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
BootVolumeReplicasDeletion: pulumi.Bool(false),
ClusterPlacementGroupId: pulumi.String("string"),
BootVolumeReplicas: core.BootVolumeBootVolumeReplicaArray{
&core.BootVolumeBootVolumeReplicaArgs{
AvailabilityDomain: pulumi.String("string"),
BootVolumeReplicaId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
KmsKeyId: pulumi.String("string"),
XrrKmsKeyId: pulumi.String("string"),
},
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
AutotunePolicies: core.BootVolumeAutotunePolicyArray{
&core.BootVolumeAutotunePolicyArgs{
AutotuneType: pulumi.String("string"),
MaxVpusPerGb: pulumi.String("string"),
},
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
IsAutoTuneEnabled: pulumi.Bool(false),
KmsKeyId: pulumi.String("string"),
SizeInGbs: pulumi.String("string"),
VpusPerGb: pulumi.String("string"),
XrcKmsKeyId: pulumi.String("string"),
})
var bootVolumeResource = new BootVolume("bootVolumeResource", BootVolumeArgs.builder()
.compartmentId("string")
.availabilityDomain("string")
.sourceDetails(BootVolumeSourceDetailsArgs.builder()
.type("string")
.changeBlockSizeInBytes("string")
.firstBackupId("string")
.id("string")
.secondBackupId("string")
.build())
.displayName("string")
.bootVolumeReplicasDeletion(false)
.clusterPlacementGroupId("string")
.bootVolumeReplicas(BootVolumeBootVolumeReplicaArgs.builder()
.availabilityDomain("string")
.bootVolumeReplicaId("string")
.displayName("string")
.kmsKeyId("string")
.xrrKmsKeyId("string")
.build())
.definedTags(Map.of("string", "string"))
.autotunePolicies(BootVolumeAutotunePolicyArgs.builder()
.autotuneType("string")
.maxVpusPerGb("string")
.build())
.freeformTags(Map.of("string", "string"))
.isAutoTuneEnabled(false)
.kmsKeyId("string")
.sizeInGbs("string")
.vpusPerGb("string")
.xrcKmsKeyId("string")
.build());
boot_volume_resource = oci.core.BootVolume("bootVolumeResource",
compartment_id="string",
availability_domain="string",
source_details={
"type": "string",
"change_block_size_in_bytes": "string",
"first_backup_id": "string",
"id": "string",
"second_backup_id": "string",
},
display_name="string",
boot_volume_replicas_deletion=False,
cluster_placement_group_id="string",
boot_volume_replicas=[{
"availability_domain": "string",
"boot_volume_replica_id": "string",
"display_name": "string",
"kms_key_id": "string",
"xrr_kms_key_id": "string",
}],
defined_tags={
"string": "string",
},
autotune_policies=[{
"autotune_type": "string",
"max_vpus_per_gb": "string",
}],
freeform_tags={
"string": "string",
},
is_auto_tune_enabled=False,
kms_key_id="string",
size_in_gbs="string",
vpus_per_gb="string",
xrc_kms_key_id="string")
const bootVolumeResource = new oci.core.BootVolume("bootVolumeResource", {
compartmentId: "string",
availabilityDomain: "string",
sourceDetails: {
type: "string",
changeBlockSizeInBytes: "string",
firstBackupId: "string",
id: "string",
secondBackupId: "string",
},
displayName: "string",
bootVolumeReplicasDeletion: false,
clusterPlacementGroupId: "string",
bootVolumeReplicas: [{
availabilityDomain: "string",
bootVolumeReplicaId: "string",
displayName: "string",
kmsKeyId: "string",
xrrKmsKeyId: "string",
}],
definedTags: {
string: "string",
},
autotunePolicies: [{
autotuneType: "string",
maxVpusPerGb: "string",
}],
freeformTags: {
string: "string",
},
isAutoTuneEnabled: false,
kmsKeyId: "string",
sizeInGbs: "string",
vpusPerGb: "string",
xrcKmsKeyId: "string",
});
type: oci:Core:BootVolume
properties:
autotunePolicies:
- autotuneType: string
maxVpusPerGb: string
availabilityDomain: string
bootVolumeReplicas:
- availabilityDomain: string
bootVolumeReplicaId: string
displayName: string
kmsKeyId: string
xrrKmsKeyId: string
bootVolumeReplicasDeletion: false
clusterPlacementGroupId: string
compartmentId: string
definedTags:
string: string
displayName: string
freeformTags:
string: string
isAutoTuneEnabled: false
kmsKeyId: string
sizeInGbs: string
sourceDetails:
changeBlockSizeInBytes: string
firstBackupId: string
id: string
secondBackupId: string
type: string
vpusPerGb: string
xrcKmsKeyId: string
BootVolume Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BootVolume resource accepts the following input properties:
- Availability
Domain string - The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the boot volume.
- Source
Details BootVolume Source Details - Autotune
Policies List<BootVolume Autotune Policy> - (Updatable) The list of autotune policies to be enabled for this volume.
- Backup
Policy stringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - Boot
Volume List<BootReplicas Volume Boot Volume Replica> - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- Boot
Volume boolReplicas Deletion - Cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- Dictionary<string, string>
- (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, string>
- (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
Auto boolTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - Kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Size
In stringGbs - (Updatable) The size of the volume in GBs.
- Vpus
Per stringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- Xrc
Kms stringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the boot volume.
- Source
Details BootVolume Source Details Args - Autotune
Policies []BootVolume Autotune Policy Args - (Updatable) The list of autotune policies to be enabled for this volume.
- Backup
Policy stringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - Boot
Volume []BootReplicas Volume Boot Volume Replica Args - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- Boot
Volume boolReplicas Deletion - Cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- map[string]string
- (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]string
- (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
Auto boolTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - Kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Size
In stringGbs - (Updatable) The size of the volume in GBs.
- Vpus
Per stringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- Xrc
Kms stringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- compartment
Id String - (Updatable) The OCID of the compartment that contains the boot volume.
- source
Details BootVolume Source Details - autotune
Policies List<BootVolume Autotune Policy> - (Updatable) The list of autotune policies to be enabled for this volume.
- backup
Policy StringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - boot
Volume List<BootReplicas Volume Boot Volume Replica> - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- boot
Volume BooleanReplicas Deletion - cluster
Placement StringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- Map<String,String>
- (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,String>
- (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
Auto BooleanTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - kms
Key StringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In StringGbs - (Updatable) The size of the volume in GBs.
- vpus
Per StringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- xrc
Kms StringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- compartment
Id string - (Updatable) The OCID of the compartment that contains the boot volume.
- source
Details BootVolume Source Details - autotune
Policies BootVolume Autotune Policy[] - (Updatable) The list of autotune policies to be enabled for this volume.
- backup
Policy stringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - boot
Volume BootReplicas Volume Boot Volume Replica[] - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- boot
Volume booleanReplicas Deletion - cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- {[key: string]: string}
- (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]: string}
- (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
Auto booleanTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In stringGbs - (Updatable) The size of the volume in GBs.
- vpus
Per stringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- xrc
Kms stringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- compartment_
id str - (Updatable) The OCID of the compartment that contains the boot volume.
- source_
details core.Boot Volume Source Details Args - autotune_
policies Sequence[core.Boot Volume Autotune Policy Args] - (Updatable) The list of autotune policies to be enabled for this volume.
- backup_
policy_ strid - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - boot_
volume_ Sequence[core.replicas Boot Volume Boot Volume Replica Args] - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- boot_
volume_ boolreplicas_ deletion - cluster_
placement_ strgroup_ id - The clusterPlacementGroup Id of the volume for volume placement.
- Mapping[str, str]
- (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, str]
- (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_
auto_ booltune_ enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - kms_
key_ strid - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size_
in_ strgbs - (Updatable) The size of the volume in GBs.
- vpus_
per_ strgb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- xrc_
kms_ strkey_ id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- compartment
Id String - (Updatable) The OCID of the compartment that contains the boot volume.
- source
Details Property Map - autotune
Policies List<Property Map> - (Updatable) The list of autotune policies to be enabled for this volume.
- backup
Policy StringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - boot
Volume List<Property Map>Replicas - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- boot
Volume BooleanReplicas Deletion - cluster
Placement StringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- Map<String>
- (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>
- (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
Auto BooleanTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - kms
Key StringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In StringGbs - (Updatable) The size of the volume in GBs.
- vpus
Per StringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- xrc
Kms StringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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 BootVolume resource produces the following output properties:
- Auto
Tuned stringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- Id string
- The provider-assigned unique ID for this managed resource.
- Image
Id string - The image OCID used to create the boot volume.
- Is
Hydrated bool - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- Size
In stringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - State string
- The current state of a boot volume.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created string - The date and time the boot volume was created. Format defined by RFC3339.
- Volume
Group stringId - The OCID of the source volume group.
- Auto
Tuned stringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- Id string
- The provider-assigned unique ID for this managed resource.
- Image
Id string - The image OCID used to create the boot volume.
- Is
Hydrated bool - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- Size
In stringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - State string
- The current state of a boot volume.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created string - The date and time the boot volume was created. Format defined by RFC3339.
- Volume
Group stringId - The OCID of the source volume group.
- auto
Tuned StringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- id String
- The provider-assigned unique ID for this managed resource.
- image
Id String - The image OCID used to create the boot volume.
- is
Hydrated Boolean - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- size
In StringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - state String
- The current state of a boot volume.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created String - The date and time the boot volume was created. Format defined by RFC3339.
- volume
Group StringId - The OCID of the source volume group.
- auto
Tuned stringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- id string
- The provider-assigned unique ID for this managed resource.
- image
Id string - The image OCID used to create the boot volume.
- is
Hydrated boolean - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- size
In stringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - state string
- The current state of a boot volume.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created string - The date and time the boot volume was created. Format defined by RFC3339.
- volume
Group stringId - The OCID of the source volume group.
- auto_
tuned_ strvpus_ per_ gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- id str
- The provider-assigned unique ID for this managed resource.
- image_
id str - The image OCID used to create the boot volume.
- is_
hydrated bool - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- size_
in_ strmbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - state str
- The current state of a boot volume.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time_
created str - The date and time the boot volume was created. Format defined by RFC3339.
- volume_
group_ strid - The OCID of the source volume group.
- auto
Tuned StringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- id String
- The provider-assigned unique ID for this managed resource.
- image
Id String - The image OCID used to create the boot volume.
- is
Hydrated Boolean - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- size
In StringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - state String
- The current state of a boot volume.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created String - The date and time the boot volume was created. Format defined by RFC3339.
- volume
Group StringId - The OCID of the source volume group.
Look up Existing BootVolume Resource
Get an existing BootVolume 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?: BootVolumeState, opts?: CustomResourceOptions): BootVolume
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_tuned_vpus_per_gb: Optional[str] = None,
autotune_policies: Optional[Sequence[_core.BootVolumeAutotunePolicyArgs]] = None,
availability_domain: Optional[str] = None,
backup_policy_id: Optional[str] = None,
boot_volume_replicas: Optional[Sequence[_core.BootVolumeBootVolumeReplicaArgs]] = None,
boot_volume_replicas_deletion: Optional[bool] = None,
cluster_placement_group_id: Optional[str] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
image_id: Optional[str] = None,
is_auto_tune_enabled: Optional[bool] = None,
is_hydrated: Optional[bool] = None,
kms_key_id: Optional[str] = None,
size_in_gbs: Optional[str] = None,
size_in_mbs: Optional[str] = None,
source_details: Optional[_core.BootVolumeSourceDetailsArgs] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
volume_group_id: Optional[str] = None,
vpus_per_gb: Optional[str] = None,
xrc_kms_key_id: Optional[str] = None) -> BootVolume
func GetBootVolume(ctx *Context, name string, id IDInput, state *BootVolumeState, opts ...ResourceOption) (*BootVolume, error)
public static BootVolume Get(string name, Input<string> id, BootVolumeState? state, CustomResourceOptions? opts = null)
public static BootVolume get(String name, Output<String> id, BootVolumeState 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.
- Auto
Tuned stringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- Autotune
Policies List<BootVolume Autotune Policy> - (Updatable) The list of autotune policies to be enabled for this volume.
- Availability
Domain string - The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- Backup
Policy stringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - Boot
Volume List<BootReplicas Volume Boot Volume Replica> - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- Boot
Volume boolReplicas Deletion - Cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the boot volume.
- Dictionary<string, string>
- (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, string>
- (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"}
- Image
Id string - The image OCID used to create the boot volume.
- Is
Auto boolTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - Is
Hydrated bool - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- Kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Size
In stringGbs - (Updatable) The size of the volume in GBs.
- Size
In stringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - Source
Details BootVolume Source Details - State string
- The current state of a boot volume.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created string - The date and time the boot volume was created. Format defined by RFC3339.
- Volume
Group stringId - The OCID of the source volume group.
- Vpus
Per stringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- Xrc
Kms stringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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
- Auto
Tuned stringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- Autotune
Policies []BootVolume Autotune Policy Args - (Updatable) The list of autotune policies to be enabled for this volume.
- Availability
Domain string - The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- Backup
Policy stringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - Boot
Volume []BootReplicas Volume Boot Volume Replica Args - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- Boot
Volume boolReplicas Deletion - Cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- Compartment
Id string - (Updatable) The OCID of the compartment that contains the boot volume.
- map[string]string
- (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]string
- (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"}
- Image
Id string - The image OCID used to create the boot volume.
- Is
Auto boolTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - Is
Hydrated bool - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- Kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Size
In stringGbs - (Updatable) The size of the volume in GBs.
- Size
In stringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - Source
Details BootVolume Source Details Args - State string
- The current state of a boot volume.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Time
Created string - The date and time the boot volume was created. Format defined by RFC3339.
- Volume
Group stringId - The OCID of the source volume group.
- Vpus
Per stringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- Xrc
Kms stringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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
- auto
Tuned StringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- autotune
Policies List<BootVolume Autotune Policy> - (Updatable) The list of autotune policies to be enabled for this volume.
- availability
Domain String - The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- backup
Policy StringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - boot
Volume List<BootReplicas Volume Boot Volume Replica> - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- boot
Volume BooleanReplicas Deletion - cluster
Placement StringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- compartment
Id String - (Updatable) The OCID of the compartment that contains the boot volume.
- Map<String,String>
- (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,String>
- (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"}
- image
Id String - The image OCID used to create the boot volume.
- is
Auto BooleanTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - is
Hydrated Boolean - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- kms
Key StringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In StringGbs - (Updatable) The size of the volume in GBs.
- size
In StringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - source
Details BootVolume Source Details - state String
- The current state of a boot volume.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created String - The date and time the boot volume was created. Format defined by RFC3339.
- volume
Group StringId - The OCID of the source volume group.
- vpus
Per StringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- xrc
Kms StringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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
- auto
Tuned stringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- autotune
Policies BootVolume Autotune Policy[] - (Updatable) The list of autotune policies to be enabled for this volume.
- availability
Domain string - The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- backup
Policy stringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - boot
Volume BootReplicas Volume Boot Volume Replica[] - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- boot
Volume booleanReplicas Deletion - cluster
Placement stringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- compartment
Id string - (Updatable) The OCID of the compartment that contains the boot volume.
- {[key: string]: string}
- (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]: string}
- (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"}
- image
Id string - The image OCID used to create the boot volume.
- is
Auto booleanTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - is
Hydrated boolean - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In stringGbs - (Updatable) The size of the volume in GBs.
- size
In stringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - source
Details BootVolume Source Details - state string
- The current state of a boot volume.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created string - The date and time the boot volume was created. Format defined by RFC3339.
- volume
Group stringId - The OCID of the source volume group.
- vpus
Per stringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- xrc
Kms stringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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
- auto_
tuned_ strvpus_ per_ gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- autotune_
policies Sequence[core.Boot Volume Autotune Policy Args] - (Updatable) The list of autotune policies to be enabled for this volume.
- availability_
domain str - The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- backup_
policy_ strid - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - boot_
volume_ Sequence[core.replicas Boot Volume Boot Volume Replica Args] - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- boot_
volume_ boolreplicas_ deletion - cluster_
placement_ strgroup_ id - The clusterPlacementGroup Id of the volume for volume placement.
- compartment_
id str - (Updatable) The OCID of the compartment that contains the boot volume.
- Mapping[str, str]
- (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, str]
- (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"}
- image_
id str - The image OCID used to create the boot volume.
- is_
auto_ booltune_ enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - is_
hydrated bool - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- kms_
key_ strid - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size_
in_ strgbs - (Updatable) The size of the volume in GBs.
- size_
in_ strmbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - source_
details core.Boot Volume Source Details Args - state str
- The current state of a boot volume.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time_
created str - The date and time the boot volume was created. Format defined by RFC3339.
- volume_
group_ strid - The OCID of the source volume group.
- vpus_
per_ strgb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- xrc_
kms_ strkey_ id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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
- auto
Tuned StringVpus Per Gb - The number of Volume Performance Units per GB that this boot volume is effectively tuned to.
- autotune
Policies List<Property Map> - (Updatable) The list of autotune policies to be enabled for this volume.
- availability
Domain String - The availability domain of the volume. Omissible for cloning a volume. The new volume will be created in the availability domain of the source volume. Example:
Uocm:PHX-AD-1
- backup
Policy StringId - If provided, specifies the ID of the boot volume backup policy to assign to the newly created boot volume. If omitted, no policy will be assigned. This field is deprecated. Use the
oci.Core.getVolumeBackupPolicyAssignments
instead to assign a backup policy to a boot volume. - boot
Volume List<Property Map>Replicas - (Updatable) The list of boot volume replicas to be enabled for this boot volume in the specified destination availability domains.
- boot
Volume BooleanReplicas Deletion - cluster
Placement StringGroup Id - The clusterPlacementGroup Id of the volume for volume placement.
- compartment
Id String - (Updatable) The OCID of the compartment that contains the boot volume.
- Map<String>
- (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>
- (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"}
- image
Id String - The image OCID used to create the boot volume.
- is
Auto BooleanTune Enabled - (Updatable) Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the
DetachedVolumeAutotunePolicy
instead to enable the volume for detached autotune. - is
Hydrated Boolean - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.
- kms
Key StringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- size
In StringGbs - (Updatable) The size of the volume in GBs.
- size
In StringMbs - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use
size_in_gbs
. - source
Details Property Map - state String
- The current state of a boot volume.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- time
Created String - The date and time the boot volume was created. Format defined by RFC3339.
- volume
Group StringId - The OCID of the source volume group.
- vpus
Per StringGb (Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.
Allowed values:
- xrc
Kms StringKey Id The OCID of the Vault service key which is the master encryption key for the boot volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
** 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
BootVolumeAutotunePolicy, BootVolumeAutotunePolicyArgs
- Autotune
Type string - (Updatable) This specifies the type of autotunes supported by OCI.
- Max
Vpus stringPer Gb - (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.
- Autotune
Type string - (Updatable) This specifies the type of autotunes supported by OCI.
- Max
Vpus stringPer Gb - (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.
- autotune
Type String - (Updatable) This specifies the type of autotunes supported by OCI.
- max
Vpus StringPer Gb - (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.
- autotune
Type string - (Updatable) This specifies the type of autotunes supported by OCI.
- max
Vpus stringPer Gb - (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.
- autotune_
type str - (Updatable) This specifies the type of autotunes supported by OCI.
- max_
vpus_ strper_ gb - (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.
- autotune
Type String - (Updatable) This specifies the type of autotunes supported by OCI.
- max
Vpus StringPer Gb - (Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.
BootVolumeBootVolumeReplica, BootVolumeBootVolumeReplicaArgs
- Availability
Domain string - (Updatable) The availability domain of the boot volume replica. Example:
Uocm:PHX-AD-1
- Boot
Volume stringReplica Id - The boot volume replica's Oracle ID (OCID).
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Xrr
Kms stringKey Id - (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region boot volume replicas, which will be used in the destination region to encrypt the boot volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- Availability
Domain string - (Updatable) The availability domain of the boot volume replica. Example:
Uocm:PHX-AD-1
- Boot
Volume stringReplica Id - The boot volume replica's Oracle ID (OCID).
- Display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- Kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- Xrr
Kms stringKey Id - (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region boot volume replicas, which will be used in the destination region to encrypt the boot volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- availability
Domain String - (Updatable) The availability domain of the boot volume replica. Example:
Uocm:PHX-AD-1
- boot
Volume StringReplica Id - The boot volume replica's Oracle ID (OCID).
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- kms
Key StringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- xrr
Kms StringKey Id - (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region boot volume replicas, which will be used in the destination region to encrypt the boot volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- availability
Domain string - (Updatable) The availability domain of the boot volume replica. Example:
Uocm:PHX-AD-1
- boot
Volume stringReplica Id - The boot volume replica's Oracle ID (OCID).
- display
Name string - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- kms
Key stringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- xrr
Kms stringKey Id - (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region boot volume replicas, which will be used in the destination region to encrypt the boot volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- availability_
domain str - (Updatable) The availability domain of the boot volume replica. Example:
Uocm:PHX-AD-1
- boot_
volume_ strreplica_ id - The boot volume replica's Oracle ID (OCID).
- display_
name str - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- kms_
key_ strid - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- xrr_
kms_ strkey_ id - (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region boot volume replicas, which will be used in the destination region to encrypt the boot volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
- availability
Domain String - (Updatable) The availability domain of the boot volume replica. Example:
Uocm:PHX-AD-1
- boot
Volume StringReplica Id - The boot volume replica's Oracle ID (OCID).
- display
Name String - (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
- kms
Key StringId - (Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.
- xrr
Kms StringKey Id - (Updatable) The OCID of the Vault service key which is the master encryption key for the cross region boot volume replicas, which will be used in the destination region to encrypt the boot volume replica's encryption keys. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
BootVolumeSourceDetails, BootVolumeSourceDetailsArgs
- Type string
- The type can be one of these values:
bootVolume
,bootVolumeBackup
,bootVolumeBackupDelta
,bootVolumeReplica
- Change
Block stringSize In Bytes - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
- First
Backup stringId - The OCID of the first boot volume backup.
- Id string
- The OCID of the boot volume replica.
- Second
Backup stringId - The OCID of the second boot volume backup.
- Type string
- The type can be one of these values:
bootVolume
,bootVolumeBackup
,bootVolumeBackupDelta
,bootVolumeReplica
- Change
Block stringSize In Bytes - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
- First
Backup stringId - The OCID of the first boot volume backup.
- Id string
- The OCID of the boot volume replica.
- Second
Backup stringId - The OCID of the second boot volume backup.
- type String
- The type can be one of these values:
bootVolume
,bootVolumeBackup
,bootVolumeBackupDelta
,bootVolumeReplica
- change
Block StringSize In Bytes - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
- first
Backup StringId - The OCID of the first boot volume backup.
- id String
- The OCID of the boot volume replica.
- second
Backup StringId - The OCID of the second boot volume backup.
- type string
- The type can be one of these values:
bootVolume
,bootVolumeBackup
,bootVolumeBackupDelta
,bootVolumeReplica
- change
Block stringSize In Bytes - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
- first
Backup stringId - The OCID of the first boot volume backup.
- id string
- The OCID of the boot volume replica.
- second
Backup stringId - The OCID of the second boot volume backup.
- type str
- The type can be one of these values:
bootVolume
,bootVolumeBackup
,bootVolumeBackupDelta
,bootVolumeReplica
- change_
block_ strsize_ in_ bytes - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
- first_
backup_ strid - The OCID of the first boot volume backup.
- id str
- The OCID of the boot volume replica.
- second_
backup_ strid - The OCID of the second boot volume backup.
- type String
- The type can be one of these values:
bootVolume
,bootVolumeBackup
,bootVolumeBackupDelta
,bootVolumeReplica
- change
Block StringSize In Bytes - Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).
- first
Backup StringId - The OCID of the first boot volume backup.
- id String
- The OCID of the boot volume replica.
- second
Backup StringId - The OCID of the second boot volume backup.
Import
BootVolumes can be imported using the id
, e.g.
$ pulumi import oci:Core/bootVolume:BootVolume test_boot_volume "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.