Skip to content

Commit 1d8c847

Browse files
committed
added documentation
1 parent c7c409a commit 1d8c847

File tree

4 files changed

+104
-2
lines changed

4 files changed

+104
-2
lines changed

examples/odb/odb_network_peering.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright © 2025, Oracle and/or its affiliates. All rights reserved.
1+
# Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
22

33
resource "aws_odb_network_peering_connection" "test" {
44
display_name = "my_odb_net_peering"

internal/service/odb/network_peering_connection.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ type resourceNetworkPeeringConnection struct {
5959

6060
func (r *resourceNetworkPeeringConnection) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
6161
resp.Schema = schema.Schema{
62-
Description: "Information about an ODB network. Also refer odb_network_peering resource : A peering connection between an ODB network and either another ODB network or a customer-owned VPC.",
62+
Description: "A peering connection between an ODB network and either another ODB network or a customer-owned VPC.",
6363
Attributes: map[string]schema.Attribute{
6464
names.AttrARN: framework.ARNAttributeComputedOnly(),
6565
names.AttrID: framework.IDAttribute(),
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
subcategory: "Oracle Database@AWS"
3+
layout: "AWS: aws_odb_network_peering_connection"
4+
page_title: "AWS: aws_odb_network_peering_connection"
5+
description: |-
6+
Terraform data source for managing oracle database network peering resource in AWS.
7+
---
8+
9+
# Data Source: aws_odb_network_peering_connection
10+
11+
Terraform data source for managing oracle database network peering resource in AWS.
12+
13+
You can find out more about Oracle Database@AWS from [User Guide](https://docs.aws.amazon.com/odb/latest/UserGuide/what-is-odb.html).
14+
15+
## Example Usage
16+
17+
### Basic Usage
18+
19+
```terraform
20+
data "aws_odb_network_peering_connection" "example" {
21+
id = "example"
22+
}
23+
```
24+
25+
## Argument Reference
26+
27+
The following arguments are required:
28+
29+
* `id` - (Required) The unique identifier of the Exadata infrastructure.
30+
31+
The following arguments are optional:
32+
33+
* `region` - (Optional) Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
34+
35+
## Attribute Reference
36+
37+
This data source exports the following attributes in addition to the arguments above:
38+
39+
* `display_name` - Display name of the ODB network peering connection.
40+
* `status` - Status of the ODB network peering connection.
41+
* `status_reason` - Status of the ODB network peering connection.
42+
* `odb_network_arn` - ARN of the ODB network peering connection.
43+
* `arn` - The Amazon Resource Name (ARN) for the Exadata infrastructure.
44+
* `peer_network_arn` - ARN of the peer network peering connection.
45+
* `odb_peering_connection_type` - Type of the ODB peering connection.
46+
* `created_at` - Created time of the ODB network peering connection.
47+
* `percent_progress` - Progress of the ODB network peering connection.
48+
* `tags` - Tags applied to the resource.
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
subcategory: "Oracle Database@AWS"
3+
layout: "AWS: aws_odb_network_peering_connection"
4+
page_title: "AWS: aws_odb_network_peering_connection"
5+
description: |-
6+
Terraform resource for managing oracle database network peering resource in AWS.
7+
---
8+
9+
# Data Source: aws_odb_network_peering_connection
10+
11+
Terraform resource for managing oracle database network peering resource in AWS.
12+
13+
You can find out more about Oracle Database@AWS from [User Guide](https://docs.aws.amazon.com/odb/latest/UserGuide/what-is-odb.html).
14+
15+
## Example Usage
16+
17+
### Basic Usage
18+
19+
```terraform
20+
resource "aws_odb_network_peering_connection" "example" {
21+
display_name = "example"
22+
odb_network_id = "my-odb-network-id"
23+
peer_network_id = "my-vpc-id"
24+
tags = {
25+
"env" = "dev"
26+
}
27+
}
28+
```
29+
30+
## Argument Reference
31+
32+
The following arguments are required:
33+
34+
* `odb_network_id` - (Required) The unique identifier of the ODB network that initiates the peering connection. A sample ID is `odbpcx-abcdefgh12345678`. Changing this will force Terraform to create a new resource.
35+
* `peer_network_id` - (Required) The unique identifier of the ODB peering connection. Changing this will force Terraform to create a new resource.
36+
* `display_name` - (Required) Display name of the ODB network peering connection. Changing this will force Terraform to create a new resource.
37+
38+
The following arguments are optional:
39+
40+
* `region` - (Optional) Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
41+
* `tags` - (Optional) A map of tags to assign to the resource. 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.
42+
43+
## Attribute Reference
44+
45+
This data source exports the following attributes in addition to the arguments above:
46+
47+
* `status` - Status of the ODB network peering connection.
48+
* `status_reason` - The reason for the current status of the ODB peering connection.
49+
* `odb_network_arn` - ARN of the ODB network peering connection.
50+
* `peer_network_arn` - ARN of the peer network peering connection.
51+
* `odb_peering_connection_type` - Type of the ODB peering connection.
52+
* `created_at` - Created time of the ODB network peering connection.
53+
* `percent_progress` - Progress of the ODB network peering connection.
54+
* `tags_all` - A map of tags assigned to the resource, including inherited tags.

0 commit comments

Comments
 (0)