Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve docs for user group related resources #1624

Merged
merged 1 commit into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/data-sources/account_team_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ data "aiven_account_team_member" "foo" {

### Required

- `account_id` (String) The unique account id. This property cannot be changed, doing so forces recreation of the resource.
- `team_id` (String) An account team id. This property cannot be changed, doing so forces recreation of the resource.
- `user_email` (String) Is a user email address that first will be invited, and after accepting an invitation, he or she becomes a member of a team. Should be lowercase. This property cannot be changed, doing so forces recreation of the resource.
- `account_id` (String) The unique account id. Changing this property forces recreation of the resource.
- `team_id` (String) An account team id. Changing this property forces recreation of the resource.
- `user_email` (String) Is a user email address that first will be invited, and after accepting an invitation, he or she becomes a member of a team. Should be lowercase. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/aws_privatelink.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ data "aiven_aws_privatelink" "foo" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/aws_vpc_peering_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ data "aiven_aws_vpc_peering_connection" "foo" {

### Required

- `aws_account_id` (String) AWS account ID. This property cannot be changed, doing so forces recreation of the resource.
- `aws_vpc_id` (String) AWS VPC ID. This property cannot be changed, doing so forces recreation of the resource.
- `aws_vpc_region` (String) AWS region of the peered VPC (if not in the same region as Aiven VPC). This property cannot be changed, doing so forces recreation of the resource.
- `vpc_id` (String) The VPC the peering connection belongs to. This property cannot be changed, doing so forces recreation of the resource.
- `aws_account_id` (String) AWS account ID. Changing this property forces recreation of the resource.
- `aws_vpc_id` (String) AWS VPC ID. Changing this property forces recreation of the resource.
- `aws_vpc_region` (String) AWS region of the peered VPC (if not in the same region as Aiven VPC). Changing this property forces recreation of the resource.
- `vpc_id` (String) The VPC the peering connection belongs to. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/azure_privatelink.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ data "aiven_azure_privatelink" "foo" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
12 changes: 6 additions & 6 deletions docs/data-sources/azure_vpc_peering_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ The Azure VPC Peering Connection data source provides information about the exis

### Required

- `azure_subscription_id` (String) Azure Subscription ID. This property cannot be changed, doing so forces recreation of the resource.
- `peer_azure_app_id` (String) Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet. This property cannot be changed, doing so forces recreation of the resource.
- `peer_azure_tenant_id` (String) Azure tenant id in UUID4 form. This property cannot be changed, doing so forces recreation of the resource.
- `peer_resource_group` (String) Azure resource group name of the peered VPC. This property cannot be changed, doing so forces recreation of the resource.
- `vnet_name` (String) Azure Network name. This property cannot be changed, doing so forces recreation of the resource.
- `vpc_id` (String) The VPC the peering connection belongs to. This property cannot be changed, doing so forces recreation of the resource.
- `azure_subscription_id` (String) Azure Subscription ID. Changing this property forces recreation of the resource.
- `peer_azure_app_id` (String) Azure app registration id in UUID4 form that is allowed to create a peering to the peer vnet. Changing this property forces recreation of the resource.
- `peer_azure_tenant_id` (String) Azure tenant id in UUID4 form. Changing this property forces recreation of the resource.
- `peer_resource_group` (String) Azure resource group name of the peered VPC. Changing this property forces recreation of the resource.
- `vnet_name` (String) Azure Network name. Changing this property forces recreation of the resource.
- `vpc_id` (String) The VPC the peering connection belongs to. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ data "aiven_cassandra" "bar" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

### Read-Only
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/cassandra_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ data "aiven_cassandra_user" "user" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `username` (String) The actual name of the Cassandra User. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `username` (String) The actual name of the Cassandra User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ data "aiven_clickhouse" "clickhouse" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

### Read-Only
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/clickhouse_database.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ data "aiven_clickhouse_database" "clickhouse_db" {

### Required

- `name` (String) The name of the Clickhouse database. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `name` (String) The name of the Clickhouse database. Changing this property forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/clickhouse_user.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ data "aiven_clickhouse_user" "ch-user" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `username` (String) The actual name of the Clickhouse user. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `username` (String) The actual name of the Clickhouse user. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
8 changes: 4 additions & 4 deletions docs/data-sources/connection_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ data "aiven_connection_pool" "mytestpool" {

### Required

- `pool_name` (String) The name of the created pool. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `pool_name` (String) The name of the created pool. Changing this property forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

### Read-Only

- `connection_uri` (String, Sensitive) The URI for connecting to the pool
- `database_name` (String) The name of the database the pool connects to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `database_name` (String) The name of the database the pool connects to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `id` (String) The ID of this resource.
- `pool_mode` (String) The mode the pool operates in. The possible values are `session`, `transaction` and `statement`. The default value is `transaction`.
- `pool_size` (Number) The number of connections the pool may create towards the backend server. This does not affect the number of incoming connections, which is always a much larger number. The default value is `10`.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ data "aiven_flink" "flink" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

### Read-Only
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/flink_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ data "aiven_flink_application" "app1" {
### Required

- `name` (String) Application name
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/flink_application_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ data "aiven_flink_application_version" "app1" {

- `application_id` (String) Application ID
- `application_version_id` (String) Application version ID
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/gcp_privatelink.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ The GCP Privatelink resource allows the creation and management of Aiven GCP Pri

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the name of the service that this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/gcp_vpc_peering_connection.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ data "aiven_gcp_vpc_peering_connection" "foo" {

### Required

- `gcp_project_id` (String) GCP project ID. This property cannot be changed, doing so forces recreation of the resource.
- `peer_vpc` (String) GCP VPC network name. This property cannot be changed, doing so forces recreation of the resource.
- `vpc_id` (String) The VPC the peering connection belongs to. This property cannot be changed, doing so forces recreation of the resource.
- `gcp_project_id` (String) GCP project ID. Changing this property forces recreation of the resource.
- `peer_vpc` (String) GCP VPC network name. Changing this property forces recreation of the resource.
- `vpc_id` (String) The VPC the peering connection belongs to. Changing this property forces recreation of the resource.

### Read-Only

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ data "aiven_grafana" "gr1" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

### Read-Only
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ data "aiven_kafka" "kafka1" {

### Required

- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.
- `project` (String) Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- `service_name` (String) Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

### Read-Only
Expand Down
Loading