Skip to content

Commit ca9fdd8

Browse files
ab-cs13ab-cs13
committed
documentation added.
1 parent c3643f9 commit ca9fdd8

File tree

3 files changed

+215
-1
lines changed

3 files changed

+215
-1
lines changed

‎internal/service/odb/cloud_exadata_infrastructure.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,8 @@ func (r *resourceCloudExadataInfrastructure) Schema(ctx context.Context, req res
227227
names.AttrTags: tftags.TagsAttribute(),
228228
names.AttrTagsAll: tftags.TagsAttributeComputedOnly(),
229229
"total_storage_size_in_gbs": schema.Int32Attribute{
230-
Computed: true,
230+
Computed: true,
231+
Description: "The total amount of storage, in gigabytes (GB), on the Exadata infrastructure.",
231232
},
232233
names.AttrCreatedAt: schema.StringAttribute{
233234
Computed: true,

‎website/docs/d/cloud_exadata_infrastructure.html.markdown‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
subcategory: "Polly"
3+
layout: "aws"
4+
page_title: "AWS: aws_polly_voices"
5+
description: |-
6+
Terraform data source for managing an AWS Polly Voices.
7+
---
8+
9+
# Data Source: aws_odb_cloud_exadata_infrastructure
10+
11+
Terraform data source for Exadata Infrastructure resource in AWS for Oracle Database Service.
12+
13+
## Example Usage
14+
15+
### Basic Usage
16+
17+
```terraform
18+
data "aws_odb_cloud_exadata_infrastructure" "example" {
19+
id = "example"
20+
}
21+
```
22+
23+
## Argument Reference
24+
25+
The following arguments are optional:
26+
27+
* `id` - (Required) The unique identifier of the Exadata infrastructure.
28+
29+
## Attribute Reference
30+
31+
This data source exports the following attributes in addition to the arguments above:
32+
33+
* `arn` - The Amazon Resource Name (ARN) for the Exadata infrastructure.
34+
* `activated_storage_count` - The number of storage servers requested for the Exadata infrastructure.
35+
* `additional_storage_count` - The number of storage servers requested for the Exadata infrastructure.
36+
* `availability_zone` - The name of the Availability Zone (AZ) where the Exadata infrastructure is located.
37+
* `availability_zone_id` - The AZ ID of the AZ where the Exadata infrastructure is located.
38+
* `arn` - The Amazon Resource Name (ARN) for the Exadata infrastructure.
39+
* `id` - The unique identifier of the Exadata infrastructure.
40+
* `compute_count` - The number of database servers for the Exadata infrastructure.
41+
* `cpu_count` - The total number of CPU cores that are allocated to the Exadata infrastructure.
42+
* `data_storage_size_in_tbs` - The size of the Exadata infrastructure's data disk group, in terabytes (TB).
43+
* `db_node_storage_size_in_gbs` - The size of the storage available on each database node, in gigabytes (GB).
44+
* `db_server_version` - The version of the Exadata infrastructure.
45+
* `display_name` - The display name of the Exadata infrastructure.
46+
* `last_maintenance_run_id` - The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.
47+
* `max_cpu_count` - The total number of CPU cores available on the Exadata infrastructure.
48+
* `max_data_storage_in_tbs` - The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.
49+
* `max_db_node_storage_size_in_gbs` - The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.
50+
* `max_memory_in_gbs` - The total amount of memory, in gigabytes (GB), that's available on the Exadata infrastructure.
51+
* `memory_size_in_gbs` - The amount of memory, in gigabytes (GB), that's allocated on the Exadata infrastructure.
52+
* `monthly_db_server_version` - The monthly software version of the database servers installed on the Exadata infrastructure.
53+
* `monthly_storage_server_version` - The monthly software version of the storage servers installed on the Exadata infrastructure.
54+
* `next_maintenance_run_id` - The OCID of the next maintenance run for the Exadata infrastructure.
55+
* `oci_resource_anchor_name` - The name of the OCI resource anchor for the Exadata infrastructure.
56+
* `oci_url` - The HTTPS link to the Exadata infrastructure in OCI.
57+
* `ocid` - The OCID of the Exadata infrastructure in OCI.
58+
* `percent_progress` - The amount of progress made on the current operation on the Exadata infrastructure expressed as a percentage.
59+
* `shape` - The model name of the Exadata infrastructure.
60+
* `status` - The status of the Exadata infrastructure.
61+
* `status_reason` - Additional information about the status of the Exadata infrastructure.
62+
* `storage_count` - The number of storage servers that are activated for the Exadata infrastructure.
63+
* `storage_server_version` - The software version of the storage servers on the Exadata infrastructure.
64+
* `total_storage_size_in_gbs` - The total amount of storage, in gigabytes (GB), on the Exadata infrastructure.
65+
* `compute_model` - The OCI compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
66+
* `created_at` - The time when the Exadata infrastructure was created.
67+
* `database_server_type` - The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
68+
* `storage_server_type` - The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
69+
* `maintenance_window` - The scheduling details of the maintenance window. Patching and system updates take place during the maintenance window.

‎website/docs/r/cloud_exadata_infrastructure.html.markdown‎

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
---
2+
subcategory: "OpenSearch Ingestion"
3+
layout: "aws"
4+
page_title: "AWS: aws_osis_pipeline"
5+
description: |-
6+
Terraform resource for managing an AWS OpenSearch Ingestion Pipeline.
7+
---
8+
9+
# Resource: aws_odb_cloud_exadata_infrastructure
10+
11+
Terraform resource for creating Exadata Infrastructure resource in AWS for Oracle Database Service.
12+
13+
## Example Usage
14+
15+
### Basic Usage
16+
17+
```terraform
18+
19+
resource "aws_odb_cloud_exadata_infrastructure" "example" {
20+
display_name = "my-exa-infra"
21+
shape = "Exadata.X11M"
22+
storage_count = 3
23+
compute_count = 2
24+
availability_zone_id = "use1-az6"
25+
customer_contacts_to_send_to_oci = [{ email = "[email protected]" }, { email = "[email protected]" }]
26+
database_server_type = "X11M"
27+
storage_server_type = "X11M-HC"
28+
maintenance_window {
29+
custom_action_timeout_in_mins = 16
30+
days_of_week = [{ name = "MONDAY" }, { name = "TUESDAY" }]
31+
hours_of_day = [11, 16]
32+
is_custom_action_timeout_enabled = true
33+
lead_time_in_weeks = 3
34+
months = [{ name = "FEBRUARY" }, { name = "MAY" }, { name = "AUGUST" }, { name = "NOVEMBER" }]
35+
patching_mode = "ROLLING"
36+
preference = "CUSTOM_PREFERENCE"
37+
weeks_of_month = [2, 4]
38+
}
39+
tags = {
40+
"env" = "dev"
41+
}
42+
43+
}
44+
45+
resource "aws_odb_cloud_exadata_infrastructure" "example" {
46+
display_name = "my_exa_X9M"
47+
shape = "Exadata.X9M"
48+
storage_count = 3
49+
compute_count = 2
50+
availability_zone_id = "use1-az6"
51+
maintenance_window {
52+
custom_action_timeout_in_mins = 16
53+
is_custom_action_timeout_enabled = true
54+
patching_mode = "ROLLING"
55+
preference = "NO_PREFERENCE"
56+
}
57+
}
58+
```
59+
60+
## Argument Reference
61+
62+
The following arguments are required:
63+
64+
* `display_name` - (Required) The user-friendly name for the Exadata infrastructure. Changing this will force terraform to create a new resource.
65+
* `shape` - (Required) The model name of the Exadata infrastructure. Changing this will force terraform to create new resource.
66+
* `storage_count` - (Required) The number of storage servers that are activated for the Exadata infrastructure. Changing this will force terraform to create new resource.
67+
* `compute_count` - (Required) The number of compute instances that the Exadata infrastructure is located. Changing this will force terraform to create new resource.
68+
* `availability_zone_id` - (Required) The AZ ID of the AZ where the Exadata infrastructure is located. Changing this will force terraform to create new resource.
69+
70+
The following arguments are optional:
71+
72+
* `customer_contacts_to_send_to_oci` - (Optional) The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure. Changing this will force terraform to create new resource.
73+
* `availability_zone`: The name of the Availability Zone (AZ) where the Exadata infrastructure is located. Changing this will force terraform to create new resource.
74+
* `database_server_type` - (Optional) The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation. This is a mandatory parameter for Exadata.X11M system shape. Changing this will force terraform to create new resource.
75+
* `storage_server_type` - (Optional) The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation. This is a mandatory parameter for Exadata.X11M system shape. Changing this will force terraform to create new resource.
76+
* `tags` - (Optional) A map of tags to assign to the exadata infrastructure. If configured with a provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level.
77+
78+
### maintenance_window
79+
80+
* `custom_action_timeout_in_mins` - (Required) The custom action timeout in minutes for the maintenance window.
81+
* `is_custom_action_timeout_enabled` - (Required) ndicates whether custom action timeout is enabled for the maintenance window.
82+
* `patching_mode` - (Required) The patching mode for the maintenance window.
83+
* `preference` - (Required) The preference for the maintenance window scheduling.
84+
* `days_of_week` - (Optional) The days of the week when maintenance can be performed.
85+
* `hours_of_day` - (Optional) The hours of the day when maintenance can be performed.
86+
* `lead_time_in_weeks` - (Optional) The lead time in weeks before the maintenance window.
87+
* `months` - (Optional) The months when maintenance can be performed.
88+
* `weeks_of_month` - (Optional) The weeks of the month when maintenance can be performed.
89+
90+
## Attribute Reference
91+
92+
This resource exports the following attributes in addition to the arguments above:
93+
94+
* `id` - Unique identifier for the pipeline.
95+
* `arn` - Amazon Resource Name (ARN) of the pipeline.
96+
* `activated_storage_count` - The number of storage servers requested for the Exadata infrastructure.
97+
* `additional_storage_count` - The number of storage servers requested for the Exadata infrastructure.
98+
* `available_storage_size_in_gbs` - The amount of available storage, in gigabytes (GB), for the Exadata infrastructure.
99+
* `cpu_count` - The total number of CPU cores that are allocated to the Exadata infrastructure.
100+
* `data_storage_size_in_tbs` - The size of the Exadata infrastructure's data disk group, in terabytes (TB).
101+
* `db_node_storage_size_in_gbs` - The size of the Exadata infrastructure's local node storage, in gigabytes (GB).
102+
* `db_server_version` - The software version of the database servers (dom0) in the Exadata infrastructure.
103+
* `last_maintenance_run_id` - The Oracle Cloud Identifier (OCID) of the last maintenance run for the Exadata infrastructure.
104+
* `max_cpu_count` - The total number of CPU cores available on the Exadata infrastructure.
105+
* `max_data_storage_in_tbs` - The total amount of data disk group storage, in terabytes (TB), that's available on the Exadata infrastructure.
106+
* `max_db_node_storage_size_in_gbs` - The total amount of local node storage, in gigabytes (GB), that's available on the Exadata infrastructure.
107+
* `max_memory_in_gbs` - The total amount of memory in gigabytes (GB) available on the Exadata infrastructure.
108+
* `monthly_db_server_version` - The monthly software version of the database servers in the Exadata infrastructure.
109+
* `monthly_storage_server_version` - The monthly software version of the storage servers installed on the Exadata infrastructure.
110+
* `next_maintenance_run_id` - The OCID of the next maintenance run for the Exadata infrastructure.
111+
* `ocid` - The OCID of the Exadata infrastructure.
112+
* `oci_resource_anchor_name` - The name of the OCI resource anchor for the Exadata infrastructure.
113+
* `percent_progress` - The amount of progress made on the current operation on the Exadata infrastructure, expressed as a percentage.
114+
* `status` - The current status of the Exadata infrastructure.
115+
* `status_reason` - Additional information about the status of the Exadata infrastructure.
116+
* `storage_server_version` - The software version of the storage servers on the Exadata infrastructure.
117+
* `total_storage_size_in_gbs` - The total amount of storage, in gigabytes (GB), on the Exadata infrastructure.
118+
* `created_at` - The time when the Exadata infrastructure was created.
119+
* `compute_model` - The OCI model compute model used when you create or clone an instance: ECPU or OCPU.
120+
121+
## Timeouts
122+
123+
[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts):
124+
125+
* `create` - (Default `24h`)
126+
* `update` - (Default `24h`)
127+
* `delete` - (Default `24h`)
128+
129+
## Import
130+
131+
In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Ingestion Pipeline using the `id`. For example:
132+
133+
```terraform
134+
import {
135+
to = aws_odb_cloud_exadata_infrastructure.example
136+
id = "example"
137+
}
138+
```
139+
140+
Using `terraform import`, import Exadata Infrastructure using the `id`. For example:
141+
142+
```console
143+
% terraform import aws_odb_cloud_exadata_infrastructure.example example
144+
```

0 commit comments

Comments
 (0)