|
1 | | -# oci_core_boot_volume |
2 | 1 |
|
3 | | -## BootVolume Resource |
4 | | - |
5 | | -### BootVolume Reference |
6 | | - |
7 | | -The following attributes are exported: |
8 | | - |
9 | | -* `availability_domain` - The Availability Domain of the boot volume. Example: `Uocm:PHX-AD-1` |
10 | | -* `compartment_id` - The OCID of the compartment that contains the boot volume. |
11 | | -* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` |
12 | | -* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
13 | | -* `freeform_tags` - 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](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` |
14 | | -* `id` - The boot volume's Oracle ID (OCID). |
15 | | -* `image_id` - The image OCID used to create the boot volume. |
16 | | -* `is_hydrated` - Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup. |
17 | | -* `size_in_gbs` - The size of the boot volume in GBs. |
18 | | -* `size_in_mbs` - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `size_in_gbs`. |
19 | | -* `source_details` - The boot volume source, either an existing boot volume in the same Availability Domain or a boot volume backup. If null, this means that the boot volume was created from an image. |
20 | | - * `id` - The OCID of the boot volume backup or the boot volume |
21 | | - * `type` - The type of the boot volume source. Supported values are `bootVolumeBackup` and `bootVolume` |
22 | | -* `state` - The current state of a boot volume. |
23 | | -* `time_created` - The date and time the boot volume was created. Format defined by RFC3339. |
24 | | -* `volume_group_id` - The OCID of the source volume group. |
25 | | - |
26 | | - |
27 | | - |
28 | | -### Create Operation |
29 | | -Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup. |
30 | | -For general information about boot volumes, see [Boot Volumes](https://docs.us-phoenix-1.oraclecloud.com/Content/Block/Concepts/bootvolumes.htm). |
31 | | -You may optionally specify a *display name* for the volume, which is simply a friendly name or |
32 | | -description. It does not have to be unique, and you can change it. Avoid entering confidential information. |
33 | | - |
34 | | - |
35 | | -The following arguments are supported: |
36 | | - |
37 | | -* `availability_domain` - (Required) The Availability Domain of the boot volume. Example: `Uocm:PHX-AD-1` |
38 | | -* `backup_policy_id` - (Optional) 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. |
39 | | -* `compartment_id` - (Required) The OCID of the compartment that contains the boot volume. |
40 | | -* `defined_tags` - (Optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` |
41 | | -* `display_name` - (Optional) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
42 | | -* `freeform_tags` - (Optional) 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](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` |
43 | | -* `source_details` - (Required) Specifies the boot volume source details for a new boot volume. The volume source is either another boot volume in the same Availability Domain or a boot volume backup. This is a mandatory field for a boot volume. |
44 | | - * `id` - (Required) The OCID of the boot volume backup or the boot volume |
45 | | - * `type` - (Required) The type of the boot volume source. Supported values are `bootVolumeBackup` and `bootVolume` |
46 | | - |
47 | | - |
48 | | -### Update Operation |
49 | | -Updates the specified boot volume's display name. |
50 | | - |
51 | | -The following arguments support updates: |
52 | | -* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` |
53 | | -* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
54 | | -* `freeform_tags` - 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](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` |
55 | | - |
56 | | - |
57 | | -** IMPORTANT ** |
58 | | -Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values |
59 | | - |
60 | | -### Example Usage |
61 | | - |
62 | | -```hcl |
63 | | -resource "oci_core_boot_volume" "test_boot_volume" { |
64 | | - #Required |
65 | | - availability_domain = "${var.boot_volume_availability_domain}" |
66 | | - compartment_id = "${var.compartment_id}" |
67 | | - source_details { |
68 | | - #Required |
69 | | - id = "${var.boot_volume_source_details_id}" |
70 | | - type = "${var.boot_volume_source_details_type}" |
71 | | - } |
72 | | -
|
73 | | - #Optional |
74 | | - backup_policy_id = "${oci_core_backup_policy.test_backup_policy.id}" |
75 | | - defined_tags = {"Operations.CostCenter"= "42"} |
76 | | - display_name = "${var.boot_volume_display_name}" |
77 | | - freeform_tags = {"Department"= "Finance"} |
78 | | -} |
79 | | -``` |
80 | | - |
81 | | - |
82 | | -## BootVolume Singular DataSource |
83 | | - |
84 | | - |
85 | | -### Get Operation |
86 | | -Gets information for the specified boot volume. |
87 | | - |
88 | | -The following arguments are supported: |
89 | | - |
90 | | -* `boot_volume_id` - (Required) The OCID of the boot volume. |
91 | | - |
92 | | - |
93 | | -### Example Usage |
94 | | - |
95 | | -```hcl |
96 | | -data "oci_core_boot_volume" "test_boot_volume" { |
97 | | - #Required |
98 | | - boot_volume_id = "${var.boot_volume_boot_volume_id}" |
99 | | -} |
100 | | -``` |
101 | 2 | # oci_core_boot_volumes |
102 | 3 |
|
103 | 4 | ## BootVolume DataSource |
@@ -129,4 +30,20 @@ data "oci_core_boot_volumes" "test_boot_volumes" { |
129 | 30 | #Optional |
130 | 31 | volume_group_id = "${oci_core_volume_group.test_volume_group.id}" |
131 | 32 | } |
132 | | -``` |
| 33 | +``` |
| 34 | +### BootVolume Reference |
| 35 | + |
| 36 | +The following attributes are exported: |
| 37 | + |
| 38 | +* `availability_domain` - The Availability Domain of the boot volume. Example: `Uocm:PHX-AD-1` |
| 39 | +* `compartment_id` - The OCID of the compartment that contains the boot volume. |
| 40 | +* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` |
| 41 | +* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
| 42 | +* `freeform_tags` - 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](https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` |
| 43 | +* `id` - The boot volume's Oracle ID (OCID). |
| 44 | +* `image_id` - The image OCID used to create the boot volume. |
| 45 | +* `size_in_gbs` - The size of the boot volume in GBs. |
| 46 | +* `size_in_mbs` - The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use `size_in_gbs`. |
| 47 | +* `state` - The current state of a boot volume. |
| 48 | +* `time_created` - The date and time the boot volume was created. Format defined by RFC3339. |
| 49 | +* `volume_group_id` - The OCID of the source volume group. |
0 commit comments