Skip to content

Commit 1917007

Browse files
ab-cs13ab-cs13
committed
data source documentation
1 parent 2365295 commit 1917007

File tree

5 files changed

+286
-137
lines changed

5 files changed

+286
-137
lines changed

‎internal/service/odb/cloud_autonomous_vm_cluster_data_source.go‎

Lines changed: 94 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -50,153 +50,197 @@ func (d *dataSourceCloudAutonomousVmCluster) Schema(ctx context.Context, req dat
5050
},
5151
"cloud_exadata_infrastructure_id": schema.StringAttribute{
5252
Computed: true,
53-
Description: "Exadata infrastructure id. Changing this will force terraform to create new resource.",
53+
Description: "Cloud exadata infrastructure id associated with this cloud autonomous VM cluster.",
5454
},
5555
"autonomous_data_storage_percentage": schema.Float32Attribute{
56-
Computed: true,
56+
Computed: true,
57+
Description: "The percentage of data storage currently in use for Autonomous Databases in the Autonomous VM cluster.",
5758
},
5859
"autonomous_data_storage_size_in_tbs": schema.Float64Attribute{
59-
Computed: true,
60+
Computed: true,
61+
Description: "The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.",
6062
},
6163
"available_autonomous_data_storage_size_in_tbs": schema.Float64Attribute{
62-
Computed: true,
64+
Computed: true,
65+
Description: "The available data storage space for Autonomous Databases in the Autonomous VM cluster, in TB.",
6366
},
6467
"available_container_databases": schema.Int32Attribute{
65-
Computed: true,
68+
Computed: true,
69+
Description: "The number of Autonomous CDBs that you can create with the currently available storage.",
6670
},
6771
"available_cpus": schema.Float32Attribute{
68-
Computed: true,
72+
Computed: true,
73+
Description: "The number of CPU cores available for allocation to Autonomous Databases.",
6974
},
7075
"compute_model": schema.StringAttribute{
71-
CustomType: computeModel,
72-
Computed: true,
76+
CustomType: computeModel,
77+
Computed: true,
78+
Description: " The compute model of the Autonomous VM cluster: ECPU or OCPU.",
7379
},
7480
"cpu_core_count": schema.Int32Attribute{
75-
Computed: true,
81+
Computed: true,
82+
Description: "The total number of CPU cores in the Autonomous VM cluster.",
7683
},
7784
"cpu_core_count_per_node": schema.Int32Attribute{
78-
Computed: true,
85+
Computed: true,
86+
Description: "The number of CPU cores enabled per node in the Autonomous VM cluster.",
7987
},
8088
"cpu_percentage": schema.Float32Attribute{
81-
Computed: true,
89+
Computed: true,
90+
Description: "he percentage of total CPU cores currently in use in the Autonomous VM cluster.",
8291
},
8392
"created_at": schema.StringAttribute{
84-
Computed: true,
93+
Computed: true,
94+
Description: "The date and time when the Autonomous VM cluster was created.",
8595
},
8696
"data_storage_size_in_gbs": schema.Float64Attribute{
87-
Computed: true,
97+
Computed: true,
98+
Description: "The total data storage allocated to the Autonomous VM cluster, in GB.",
8899
},
89100
"data_storage_size_in_tbs": schema.Float64Attribute{
90-
Computed: true,
101+
Computed: true,
102+
Description: "The total data storage allocated to the Autonomous VM cluster, in TB.",
91103
},
92104
"odb_node_storage_size_in_gbs": schema.Int32Attribute{
93-
Computed: true,
105+
Computed: true,
106+
Description: "The local node storage allocated to the Autonomous VM cluster, in gigabytes (GB).",
94107
},
95108
"db_servers": schema.SetAttribute{
96109
Computed: true,
97110
CustomType: fwtypes.SetOfStringType,
98111
ElementType: types.StringType,
112+
Description: "The list of database servers associated with the Autonomous VM cluster.",
99113
},
100114
"description": schema.StringAttribute{
101-
Computed: true,
115+
Computed: true,
116+
Description: "The user-provided description of the Autonomous VM cluster.",
102117
},
103118
"display_name": schema.StringAttribute{
104-
Computed: true,
119+
Computed: true,
120+
Description: "The display name of the Autonomous VM cluster.",
105121
},
106122
"domain": schema.StringAttribute{
107-
Computed: true,
123+
Computed: true,
124+
Description: "The domain name of the Autonomous VM cluster.",
108125
},
109126
"exadata_storage_in_tbs_lowest_scaled_value": schema.Float64Attribute{
110-
Computed: true,
127+
Computed: true,
128+
Description: "The minimum value to which you can scale down the Exadata storage, in TB.",
111129
},
112130
"hostname": schema.StringAttribute{
113-
Computed: true,
131+
Computed: true,
132+
Description: "The hostname of the Autonomous VM cluster.",
114133
},
115134
"is_mtls_enabled_vm_cluster": schema.BoolAttribute{
116-
Computed: true,
135+
Computed: true,
136+
Description: " Indicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.",
117137
},
118138
"license_model": schema.StringAttribute{
119-
CustomType: licenseModel,
120-
Computed: true,
139+
CustomType: licenseModel,
140+
Computed: true,
141+
Description: "The Oracle license model that applies to the Autonomous VM cluster. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE .",
121142
},
122143
"max_acds_lowest_scaled_value": schema.Int32Attribute{
123-
Computed: true,
144+
Computed: true,
145+
Description: "The minimum value to which you can scale down the maximum number of Autonomous CDBs.",
124146
},
125147
"memory_per_oracle_compute_unit_in_gbs": schema.Int32Attribute{
126-
Computed: true,
148+
Computed: true,
149+
Description: "The amount of memory allocated per Oracle Compute Unit, in GB.",
127150
},
128151
"memory_size_in_gbs": schema.Int32Attribute{
129-
Computed: true,
152+
Computed: true,
153+
Description: "The total amount of memory allocated to the Autonomous VM cluster, in gigabytes (GB).",
130154
},
131155
"node_count": schema.Int32Attribute{
132-
Computed: true,
156+
Computed: true,
157+
Description: "The number of database server nodes in the Autonomous VM cluster.",
133158
},
134159
"non_provisionable_autonomous_container_databases": schema.Int32Attribute{
135-
Computed: true,
160+
Computed: true,
161+
Description: "The number of Autonomous CDBs that can't be provisioned because of resource constraints.",
136162
},
137163
"oci_resource_anchor_name": schema.StringAttribute{
138-
Computed: true,
164+
Computed: true,
165+
Description: "The name of the OCI resource anchor associated with this Autonomous VM cluster.",
139166
},
140167
"oci_url": schema.StringAttribute{
141-
Computed: true,
168+
Computed: true,
169+
Description: "The URL for accessing the OCI console page for this Autonomous VM cluster.",
142170
},
143171
"ocid": schema.StringAttribute{
144-
Computed: true,
172+
Computed: true,
173+
Description: "The Oracle Cloud Identifier (OCID) of the Autonomous VM cluster.",
145174
},
146175
"odb_network_id": schema.StringAttribute{
147-
Computed: true,
176+
Computed: true,
177+
Description: "The unique identifier of the ODB network associated with this Autonomous VM cluster.",
148178
},
149179
"percent_progress": schema.Float32Attribute{
150-
Computed: true,
180+
Computed: true,
181+
Description: "The progress of the current operation on the Autonomous VM cluster, as a percentage.",
151182
},
152183
"provisionable_autonomous_container_databases": schema.Int32Attribute{
153-
Computed: true,
184+
Computed: true,
185+
Description: "The number of Autonomous CDBs that can be provisioned in the Autonomous VM cluster.",
154186
},
155187
"provisioned_autonomous_container_databases": schema.Int32Attribute{
156-
Computed: true,
188+
Computed: true,
189+
Description: "The number of Autonomous CDBs currently provisioned in the Autonomous VM cluster.",
157190
},
158191
"provisioned_cpus": schema.Float32Attribute{
159-
Computed: true,
192+
Computed: true,
193+
Description: "The number of CPU cores currently provisioned in the Autonomous VM cluster.",
160194
},
161195
"reclaimable_cpus": schema.Float32Attribute{
162-
Computed: true,
196+
Computed: true,
197+
Description: "The number of CPU cores that can be reclaimed from terminated or scaled-down Autonomous Databases.",
163198
},
164199
"reserved_cpus": schema.Float32Attribute{
165-
Computed: true,
200+
Computed: true,
201+
Description: "The number of CPU cores reserved for system operations and redundancy.",
166202
},
167203
"scan_listener_port_non_tls": schema.Int32Attribute{
168-
Computed: true,
204+
Computed: true,
205+
Description: "The SCAN listener port for non-TLS (TCP) protocol. The default is 1521.",
169206
},
170207
"scan_listener_port_tls": schema.Int32Attribute{
171-
Computed: true,
208+
Computed: true,
209+
Description: "The SCAN listener port for TLS (TCP) protocol. The default is 2484.",
172210
},
173211
"shape": schema.StringAttribute{
174-
Computed: true,
212+
Computed: true,
213+
Description: "The shape of the Exadata infrastructure for the Autonomous VM cluster.",
175214
},
176215
"status": schema.StringAttribute{
177-
CustomType: status,
178-
Computed: true,
216+
CustomType: status,
217+
Computed: true,
218+
Description: "The status of the Autonomous VM cluster.",
179219
},
180220
"status_reason": schema.StringAttribute{
181-
Computed: true,
221+
Computed: true,
222+
Description: "Additional information about the current status of the Autonomous VM cluster.",
182223
},
183224
"time_database_ssl_certificate_expires": schema.StringAttribute{
184-
Computed: true,
225+
Computed: true,
226+
Description: "The expiration date and time of the database SSL certificate.",
185227
},
186228
"time_ords_certificate_expires": schema.StringAttribute{
187-
Computed: true,
229+
Computed: true,
230+
Description: "The expiration date and time of the Oracle REST Data Services (ORDS)certificate .",
188231
},
189232
"time_zone": schema.StringAttribute{
190-
Computed: true,
233+
Computed: true,
234+
Description: "The time zone of the Autonomous VM cluster.",
191235
},
192236
"total_container_databases": schema.Int32Attribute{
193237
Computed: true,
194238
},
195239
names.AttrTags: tftags.TagsAttributeComputedOnly(),
196240
"maintenance_window": schema.ObjectAttribute{
197-
Computed: true,
198-
CustomType: fwtypes.NewObjectTypeOf[cloudAutonomousVmClusterMaintenanceWindowDataSourceModel](ctx),
199-
241+
Computed: true,
242+
CustomType: fwtypes.NewObjectTypeOf[cloudAutonomousVmClusterMaintenanceWindowDataSourceModel](ctx),
243+
Description: "The maintenance window for the Autonomous VM cluster.",
200244
AttributeTypes: map[string]attr.Type{
201245
"days_of_week": types.SetType{
202246
ElemType: fwtypes.StringEnumType[odbtypes.DayOfWeekName](),

0 commit comments

Comments
 (0)