Skip to content

Commit

Permalink
docs: update docs to include cockroach_private_endpoint_connection
Browse files Browse the repository at this point in the history
This commit updates the docs to include the new
cockroach_private_endpoint_connection resource. At the same time, we add
an example for such a resource, and update the CHANGELOG file as well.
  • Loading branch information
jaylim-crl committed Aug 29, 2023
1 parent c41b1ca commit 84f4fa8
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

- New cockroach_private_endpoint_connection resource allows users to configure
trusted owner entries for private endpoints.

## [1.1.0] - 2023-08-15

### Added
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/private_endpoint_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ AWS PrivateLink Endpoint Connection.
### Read-Only

- `cloud_provider` (String) Cloud provider associated with this connection.
- `id` (String) Used with `terrform import`. Format is "<cluster ID>:<endpoint ID>".
- `id` (String) Used with `terraform import`. Format is "<cluster ID>:<endpoint ID>".
- `region_name` (String) Cloud provider region code associated with this connection.
- `service_id` (String) Server side ID of the PrivateLink connection.

Expand Down
30 changes: 30 additions & 0 deletions docs/resources/private_endpoint_trusted_owner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "cockroach_private_endpoint_trusted_owner Resource - terraform-provider-cockroach"
subcategory: ""
description: |-
Private Endpoint Trusted Owner.
---

# cockroach_private_endpoint_trusted_owner (Resource)

Private Endpoint Trusted Owner.



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `cluster_id` (String) UUID of the cluster the private endpoint trusted owner entry belongs to.
- `external_owner_id` (String) Owner ID of the private endpoint connection in the cloud provider.
- `type` (String) Representation of the external_owner_id field. Allowed values are:
* AWS_ACCOUNT_ID

### Read-Only

- `id` (String) Used with `terraform import`. Format is "<cluster ID>:<owner ID>".
- `owner_id` (String) UUID of the private endpoint trusted owner entry.


Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
variable "cluster_id" {
type = string
}

resource "cockroach_private_endpoint_trusted_owner" "example" {
cluster_id = var.cluster_id
type = "AWS_ACCOUNT_ID"
external_owner_id = "012345678901"
}

0 comments on commit 84f4fa8

Please sign in to comment.