Skip to content

Commit fb80d49

Browse files
vsin12rashik-bhasin
vsin12
authored and
rashik-bhasin
committed
Added - Support for private endpoint in resource manager
1 parent 56ee5ba commit fb80d49

6 files changed

+254
-8
lines changed

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

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
subcategory: "Resource Manager"
3+
layout: "oci"
4+
page_title: "Oracle Cloud Infrastructure: oci_resourcemanager_private_endpoint"
5+
sidebar_current: "docs-oci-datasource-resourcemanager-private_endpoint"
6+
description: |-
7+
Provides details about a specific Private Endpoint in Oracle Cloud Infrastructure Resource Manager service
8+
---
9+
10+
# Data Source: oci_resourcemanager_private_endpoint
11+
This data source provides details about a specific Private Endpoint resource in Oracle Cloud Infrastructure Resource Manager service.
12+
13+
Gets the specified private endpoint.
14+
15+
## Example Usage
16+
17+
```hcl
18+
data "oci_resourcemanager_private_endpoint" "test_private_endpoint" {
19+
#Required
20+
private_endpoint_id = oci_resourcemanager_private_endpoint.test_private_endpoint.id
21+
}
22+
```
23+
24+
## Argument Reference
25+
26+
The following arguments are supported:
27+
28+
* `private_endpoint_id` - (Required) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.
29+
30+
31+
## Attributes Reference
32+
33+
The following attributes are exported:
34+
35+
* `compartment_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint details.
36+
* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
37+
* `description` - Description of the private endpoint. Avoid entering confidential information.
38+
* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
39+
* `dns_zones` - DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
40+
* `freeform_tags` - Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
41+
* `id` - Unique identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the private endpoint details.
42+
* `is_used_with_configuration_source_provider` - When `true`, allows the private endpoint to be used with a configuration source provider.
43+
* `nsg_id_list` - An array of network security groups (NSG) that the customer can optionally provide.
44+
* `source_ips` - The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
45+
* `state` - The current lifecycle state of the private endpoint.
46+
* `subnet_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint.
47+
* `time_created` - The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: `2020-11-25T21:10:29.600Z`
48+
* `vcn_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint.
49+

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
subcategory: "Resource Manager"
3+
layout: "oci"
4+
page_title: "Oracle Cloud Infrastructure: oci_resourcemanager_private_endpoint_reachable_ip"
5+
sidebar_current: "docs-oci-datasource-resourcemanager-private_endpoint_reachable_ip"
6+
description: |-
7+
Provides details about a specific Private Endpoint Reachable Ip in Oracle Cloud Infrastructure Resource Manager service
8+
---
9+
10+
# Data Source: oci_resourcemanager_private_endpoint_reachable_ip
11+
This data source provides details about a specific Private Endpoint Reachable Ip resource in Oracle Cloud Infrastructure Resource Manager service.
12+
13+
Gets the alternative IP address of the private resource. This IP will be used by Resource Manager Service to connect to the private resource.
14+
15+
16+
## Example Usage
17+
18+
```hcl
19+
data "oci_resourcemanager_private_endpoint_reachable_ip" "test_private_endpoint_reachable_ip" {
20+
#Required
21+
private_endpoint_id = oci_resourcemanager_private_endpoint.test_private_endpoint.id
22+
private_ip = var.private_endpoint_reachable_ip_private_ip
23+
}
24+
```
25+
26+
## Argument Reference
27+
28+
The following arguments are supported:
29+
30+
* `private_endpoint_id` - (Required) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.
31+
* `private_ip` - (Required) The IP address of the resource in the private subnet.
32+
33+
34+
## Attributes Reference
35+
36+
The following attributes are exported:
37+
38+
* `ip_address` - An IP address for the Resource Manager service to use for connection to the private resource.
39+

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

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
subcategory: "Resource Manager"
3+
layout: "oci"
4+
page_title: "Oracle Cloud Infrastructure: oci_resourcemanager_private_endpoints"
5+
sidebar_current: "docs-oci-datasource-resourcemanager-private_endpoints"
6+
description: |-
7+
Provides the list of Private Endpoints in Oracle Cloud Infrastructure Resource Manager service
8+
---
9+
10+
# Data Source: oci_resourcemanager_private_endpoints
11+
This data source provides the list of Private Endpoints in Oracle Cloud Infrastructure Resource Manager service.
12+
13+
Lists private endpoints according to the specified filter.
14+
- For `compartmentId`, lists all private endpoint in the matching compartment.
15+
- For `privateEndpointId`, lists the matching private endpoint.
16+
17+
18+
## Example Usage
19+
20+
```hcl
21+
data "oci_resourcemanager_private_endpoints" "test_private_endpoints" {
22+
23+
#Optional
24+
compartment_id = var.compartment_id
25+
display_name = var.private_endpoint_display_name
26+
private_endpoint_id = oci_resourcemanager_private_endpoint.test_private_endpoint.id
27+
vcn_id = oci_core_vcn.test_vcn.id
28+
}
29+
```
30+
31+
## Argument Reference
32+
33+
The following arguments are supported:
34+
35+
* `compartment_id` - (Optional) A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
36+
* `display_name` - (Optional) A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires `sortBy` set to `DISPLAYNAME`. Alternatively, when you know the resource OCID, use the related Get operation.
37+
* `private_endpoint_id` - (Optional) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private endpoint.
38+
* `vcn_id` - (Optional) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.
39+
40+
41+
## Attributes Reference
42+
43+
The following attributes are exported:
44+
45+
* `private_endpoint_collection` - The list of private_endpoint_collection.
46+
47+
### PrivateEndpoint Reference
48+
49+
The following attributes are exported:
50+
51+
* `compartment_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint details.
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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
53+
* `description` - Description of the private endpoint. Avoid entering confidential information.
54+
* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
55+
* `dns_zones` - DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
56+
* `freeform_tags` - Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
57+
* `id` - Unique identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the private endpoint details.
58+
* `is_used_with_configuration_source_provider` - When `true`, allows the private endpoint to be used with a configuration source provider.
59+
* `nsg_id_list` - An array of network security groups (NSG) that the customer can optionally provide.
60+
* `source_ips` - The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
61+
* `state` - The current lifecycle state of the private endpoint.
62+
* `subnet_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint.
63+
* `time_created` - The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: `2020-11-25T21:10:29.600Z`
64+
* `vcn_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint.
65+

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Gets a stack using the stack ID.
1616

1717
```hcl
1818
data "oci_resourcemanager_stack" "test_stack" {
19-
#Required
20-
stack_id = oci_resourcemanager_stack.test_stack.id
19+
#Required
20+
stack_id = oci_resourcemanager_stack.test_stack.id
2121
}
2222
```
2323

@@ -33,15 +33,14 @@ The following arguments are supported:
3333
The following attributes are exported:
3434

3535
* `compartment_id` - Unique identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) for the compartment where the stack is located.
36-
* `config_source` - Location of the Terraform configuration.
37-
* `config_source_type` - Specifies the `configSourceType` for uploading the Terraform configuration. Presently, the .zip file type (`ZIP_UPLOAD`) is the only supported `configSourceType`.
38-
* `working_directory` - File path to the directory from which Terraform runs. If not specified, we use the root directory.
39-
* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
36+
* `config_source` - Location of the Terraform configuration.
37+
* `config_source_type` - Specifies the `configSourceType` for uploading the Terraform configuration. Presently, the .zip file type (`ZIP_UPLOAD`) is the only supported `configSourceType`.
38+
* `working_directory` - File path to the directory from which Terraform runs. If not specified, we use the root directory.
39+
* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
4040
* `description` - General description of the stack.
4141
* `display_name` - Human-readable display name for the stack.
42-
* `freeform_tags` - Free-form tags associated with this resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
42+
* `freeform_tags` - Free-form tags associated with this resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
4343
* `id` - Unique identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) for the stack.
4444
* `state` - The current lifecycle state of the stack.
4545
* `time_created` - The date and time at which the stack was created.
4646
* `variables` - Terraform variables associated with this resource. Maximum number of variables supported is 100. The maximum size of each variable, including both name and value, is 4096 bytes. Example: `{"CompartmentId": "compartment-id-value"}`
47-

‎website/docs/guides/resource_discovery.html.markdown‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@ The generated `.tf` files contain the Terraform configuration with the resources
178178
* `optimizer` - Discovers optimizer resources across the entire tenancy
179179
* `osmanagement` - Discovers osmanagement resources within the specified compartment
180180
* `osp_gateway` - Discovers osp_gateway resources within the specified compartment
181+
* `resourcemanager` - Discovers resourcemanager resources within the specified compartment
181182
* `sch` - Discovers sch resources within the specified compartment
182183
*`service_mesh` - Discovers service_mesh resources within the specified compartment
183184
* `stack_monitoring` - Discovers stack_monitoring resources within the specified compartment
@@ -774,6 +775,10 @@ osp_gateway
774775

775776
* oci\_osp\_gateway\_subscription
776777

778+
resourcemanager
779+
780+
* oci\_resourcemanager\_private\_endpoint
781+
777782
sch
778783

779784
* oci\_sch\_service\_connector

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

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
subcategory: "Resource Manager"
3+
layout: "oci"
4+
page_title: "Oracle Cloud Infrastructure: oci_resourcemanager_private_endpoint"
5+
sidebar_current: "docs-oci-resource-resourcemanager-private_endpoint"
6+
description: |-
7+
Provides the Private Endpoint resource in Oracle Cloud Infrastructure Resource Manager service
8+
---
9+
10+
# oci_resourcemanager_private_endpoint
11+
This resource provides the Private Endpoint resource in Oracle Cloud Infrastructure Resource Manager service.
12+
13+
Creates a a private endpoint in the specified compartment.
14+
15+
16+
## Example Usage
17+
18+
```hcl
19+
resource "oci_resourcemanager_private_endpoint" "test_private_endpoint" {
20+
#Required
21+
compartment_id = var.compartment_id
22+
display_name = var.private_endpoint_display_name
23+
subnet_id = oci_core_subnet.test_subnet.id
24+
vcn_id = oci_core_vcn.test_vcn.id
25+
26+
#Optional
27+
defined_tags = {"Operations.CostCenter"= "42"}
28+
description = var.private_endpoint_description
29+
dns_zones = var.private_endpoint_dns_zones
30+
freeform_tags = {"Department"= "Finance"}
31+
is_used_with_configuration_source_provider = var.private_endpoint_is_used_with_configuration_source_provider
32+
nsg_id_list = var.private_endpoint_nsg_id_list
33+
}
34+
```
35+
36+
## Argument Reference
37+
38+
The following arguments are supported:
39+
40+
* `compartment_id` - (Required) (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint details.
41+
* `defined_tags` - (Optional) (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
42+
* `description` - (Optional) (Updatable) Description of the private endpoint. Avoid entering confidential information.
43+
* `display_name` - (Required) (Updatable) The private endpoint display name. Avoid entering confidential information.
44+
* `dns_zones` - (Optional) (Updatable) DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
45+
* `freeform_tags` - (Optional) (Updatable) Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
46+
* `is_used_with_configuration_source_provider` - (Optional) (Updatable) When `true`, allows the private endpoint to be used with a configuration source provider.
47+
* `nsg_id_list` - (Optional) (Updatable) An array of network security group (NSG) [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the private endpoint. Order does not matter.
48+
* `subnet_id` - (Required) (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint.
49+
* `vcn_id` - (Required) (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint.
50+
51+
52+
** IMPORTANT **
53+
Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
54+
55+
## Attributes Reference
56+
57+
The following attributes are exported:
58+
59+
* `compartment_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this private endpoint details.
60+
* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}`
61+
* `description` - Description of the private endpoint. Avoid entering confidential information.
62+
* `display_name` - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
63+
* `dns_zones` - DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
64+
* `freeform_tags` - Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
65+
* `id` - Unique identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the private endpoint details.
66+
* `is_used_with_configuration_source_provider` - When `true`, allows the private endpoint to be used with a configuration source provider.
67+
* `nsg_id_list` - An array of network security groups (NSG) that the customer can optionally provide.
68+
* `source_ips` - The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
69+
* `state` - The current lifecycle state of the private endpoint.
70+
* `subnet_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet within the VCN for the private endpoint.
71+
* `time_created` - The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: `2020-11-25T21:10:29.600Z`
72+
* `vcn_id` - The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN for the private endpoint.
73+
74+
## Timeouts
75+
76+
The `timeouts` block allows you to specify [timeouts](https://registry.terraform.io/providers/hashicorp/oci/latest/docs/guides/changing_timeouts) for certain operations:
77+
* `create` - (Defaults to 20 minutes), when creating the Private Endpoint
78+
* `update` - (Defaults to 20 minutes), when updating the Private Endpoint
79+
* `delete` - (Defaults to 20 minutes), when destroying the Private Endpoint
80+
81+
82+
## Import
83+
84+
PrivateEndpoints can be imported using the `id`, e.g.
85+
86+
```
87+
$ terraform import oci_resourcemanager_private_endpoint.test_private_endpoint "id"
88+
```
89+

0 commit comments

Comments
 (0)