From 80df02414a8664b07e07694c84b1259ffad06d90 Mon Sep 17 00:00:00 2001 From: Stacey Salamon <111294980+staceysalamon-aiven@users.noreply.github.com> Date: Tue, 27 Feb 2024 15:14:24 +0100 Subject: [PATCH] docs: improve docs for user group related resources (#1624) --- docs/data-sources/account_team_member.md | 6 +-- docs/data-sources/aws_privatelink.md | 4 +- .../aws_vpc_peering_connection.md | 8 ++-- docs/data-sources/azure_privatelink.md | 4 +- .../azure_vpc_peering_connection.md | 12 +++--- docs/data-sources/cassandra.md | 2 +- docs/data-sources/cassandra_user.md | 6 +-- docs/data-sources/clickhouse.md | 2 +- docs/data-sources/clickhouse_database.md | 6 +-- docs/data-sources/clickhouse_user.md | 6 +-- docs/data-sources/connection_pool.md | 8 ++-- docs/data-sources/flink.md | 2 +- docs/data-sources/flink_application.md | 4 +- .../data-sources/flink_application_version.md | 4 +- docs/data-sources/gcp_privatelink.md | 4 +- .../gcp_vpc_peering_connection.md | 6 +-- docs/data-sources/grafana.md | 2 +- docs/data-sources/kafka.md | 2 +- docs/data-sources/kafka_acl.md | 10 ++--- docs/data-sources/kafka_connect.md | 2 +- docs/data-sources/kafka_connector.md | 6 +-- docs/data-sources/kafka_mirrormaker.md | 2 +- docs/data-sources/kafka_schema.md | 6 +-- .../kafka_schema_configuration.md | 6 +-- .../data-sources/kafka_schema_registry_acl.md | 10 ++--- docs/data-sources/kafka_topic.md | 6 +-- docs/data-sources/kafka_user.md | 6 +-- docs/data-sources/m3aggregator.md | 2 +- docs/data-sources/m3db.md | 2 +- docs/data-sources/m3db_user.md | 6 +-- .../mirrormaker_replication_flow.md | 4 +- docs/data-sources/mysql.md | 2 +- docs/data-sources/mysql_database.md | 6 +-- docs/data-sources/mysql_user.md | 6 +-- docs/data-sources/opensearch.md | 2 +- docs/data-sources/opensearch_acl_config.md | 4 +- docs/data-sources/opensearch_acl_rule.md | 8 ++-- .../opensearch_security_plugin_config.md | 4 +- docs/data-sources/opensearch_user.md | 6 +-- docs/data-sources/organization.md | 12 +++--- docs/data-sources/organization_user_group.md | 17 +++++--- docs/data-sources/pg.md | 2 +- docs/data-sources/pg_database.md | 10 ++--- docs/data-sources/pg_user.md | 6 +-- docs/data-sources/project_user.md | 4 +- docs/data-sources/redis.md | 2 +- docs/data-sources/redis_user.md | 14 +++---- .../transit_gateway_vpc_attachment.md | 6 +-- docs/resources/account_team_member.md | 6 +-- docs/resources/aws_privatelink.md | 4 +- docs/resources/aws_vpc_peering_connection.md | 8 ++-- docs/resources/azure_privatelink.md | 4 +- .../azure_privatelink_connection_approval.md | 4 +- .../resources/azure_vpc_peering_connection.md | 12 +++--- docs/resources/cassandra.md | 2 +- docs/resources/cassandra_user.md | 6 +-- docs/resources/clickhouse.md | 2 +- docs/resources/clickhouse_database.md | 6 +-- docs/resources/clickhouse_grant.md | 24 ++++++------ docs/resources/clickhouse_role.md | 6 +-- docs/resources/clickhouse_user.md | 6 +-- docs/resources/connection_pool.md | 8 ++-- docs/resources/flink.md | 2 +- docs/resources/flink_application.md | 4 +- .../resources/flink_application_deployment.md | 4 +- docs/resources/flink_application_version.md | 4 +- docs/resources/gcp_privatelink.md | 4 +- .../gcp_privatelink_connection_approval.md | 4 +- docs/resources/gcp_vpc_peering_connection.md | 6 +-- docs/resources/grafana.md | 2 +- docs/resources/kafka.md | 2 +- docs/resources/kafka_acl.md | 10 ++--- docs/resources/kafka_connect.md | 2 +- docs/resources/kafka_connector.md | 6 +-- docs/resources/kafka_mirrormaker.md | 2 +- docs/resources/kafka_schema.md | 6 +-- docs/resources/kafka_schema_configuration.md | 4 +- docs/resources/kafka_schema_registry_acl.md | 10 ++--- docs/resources/kafka_topic.md | 6 +-- docs/resources/kafka_user.md | 6 +-- docs/resources/m3aggregator.md | 2 +- docs/resources/m3db.md | 2 +- docs/resources/m3db_user.md | 6 +-- .../resources/mirrormaker_replication_flow.md | 4 +- docs/resources/mysql.md | 2 +- docs/resources/mysql_database.md | 6 +-- docs/resources/mysql_user.md | 6 +-- docs/resources/opensearch.md | 2 +- docs/resources/opensearch_acl_config.md | 4 +- docs/resources/opensearch_acl_rule.md | 8 ++-- .../opensearch_security_plugin_config.md | 4 +- docs/resources/opensearch_user.md | 6 +-- docs/resources/organization.md | 14 +++---- .../organization_application_user.md | 9 ++++- .../organization_application_user_token.md | 9 ++++- docs/resources/organization_group_project.md | 37 ++++++++++++++++-- docs/resources/organization_user.md | 8 ++-- docs/resources/organization_user_group.md | 26 ++++++++++--- .../organization_user_group_member.md | 39 ++++++++++++++++--- docs/resources/pg.md | 2 +- docs/resources/pg_database.md | 10 ++--- docs/resources/pg_user.md | 6 +-- docs/resources/project.md | 7 ++-- docs/resources/project_user.md | 4 +- docs/resources/project_vpc.md | 4 +- docs/resources/redis.md | 2 +- docs/resources/redis_user.md | 14 +++---- docs/resources/static_ip.md | 4 +- .../transit_gateway_vpc_attachment.md | 6 +-- .../aiven_organization/data-source.tf | 4 +- .../data-source.tf | 4 ++ .../resources/aiven_organization/import.sh | 2 +- .../resources/aiven_organization/resource.tf | 4 +- .../import.sh | 1 + .../resource copy.tf | 16 ++++++++ .../resource.tf | 12 ++++++ .../aiven_organization_user_group/import.sh | 1 + .../aiven_organization_user_group/resource.tf | 5 +++ .../import.sh | 1 + .../resource.tf | 11 ++++++ examples/resources/aiven_project/resource.tf | 7 ++-- .../organization/organization_data_source.go | 6 +-- .../organization_group_project.go | 7 ++-- .../organization/organization_resource.go | 6 +-- .../organization_user_group_member.go | 10 ++--- internal/plugin/util/pluginhelpers.go | 7 +++- internal/schemautil/userconfig/desc.go | 2 +- .../service/organization/organization_user.go | 2 +- .../organization/organization_user_group.go | 2 +- .../organization_user_group_data_source.go | 2 +- 130 files changed, 478 insertions(+), 336 deletions(-) create mode 100644 examples/data-sources/aiven_organization_user_group/data-source.tf create mode 100644 examples/resources/aiven_organization_group_project/import.sh create mode 100644 examples/resources/aiven_organization_group_project/resource copy.tf create mode 100644 examples/resources/aiven_organization_group_project/resource.tf create mode 100644 examples/resources/aiven_organization_user_group/import.sh create mode 100644 examples/resources/aiven_organization_user_group/resource.tf create mode 100644 examples/resources/aiven_organization_user_group_member/import.sh create mode 100644 examples/resources/aiven_organization_user_group_member/resource.tf diff --git a/docs/data-sources/account_team_member.md b/docs/data-sources/account_team_member.md index baaa03f29..c8af53c3c 100644 --- a/docs/data-sources/account_team_member.md +++ b/docs/data-sources/account_team_member.md @@ -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 diff --git a/docs/data-sources/aws_privatelink.md b/docs/data-sources/aws_privatelink.md index 5bf7c7378..136b68f23 100644 --- a/docs/data-sources/aws_privatelink.md +++ b/docs/data-sources/aws_privatelink.md @@ -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 diff --git a/docs/data-sources/aws_vpc_peering_connection.md b/docs/data-sources/aws_vpc_peering_connection.md index e32483d12..0f816c2f8 100644 --- a/docs/data-sources/aws_vpc_peering_connection.md +++ b/docs/data-sources/aws_vpc_peering_connection.md @@ -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 diff --git a/docs/data-sources/azure_privatelink.md b/docs/data-sources/azure_privatelink.md index 7cce43efa..90bfe7575 100644 --- a/docs/data-sources/azure_privatelink.md +++ b/docs/data-sources/azure_privatelink.md @@ -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 diff --git a/docs/data-sources/azure_vpc_peering_connection.md b/docs/data-sources/azure_vpc_peering_connection.md index ddb3b41b6..5cb616c8c 100644 --- a/docs/data-sources/azure_vpc_peering_connection.md +++ b/docs/data-sources/azure_vpc_peering_connection.md @@ -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 diff --git a/docs/data-sources/cassandra.md b/docs/data-sources/cassandra.md index d2f58b0f7..29cf6bccd 100644 --- a/docs/data-sources/cassandra.md +++ b/docs/data-sources/cassandra.md @@ -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 diff --git a/docs/data-sources/cassandra_user.md b/docs/data-sources/cassandra_user.md index 0ae3b4527..13a835313 100644 --- a/docs/data-sources/cassandra_user.md +++ b/docs/data-sources/cassandra_user.md @@ -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 diff --git a/docs/data-sources/clickhouse.md b/docs/data-sources/clickhouse.md index a8e9c59ae..338612eb7 100644 --- a/docs/data-sources/clickhouse.md +++ b/docs/data-sources/clickhouse.md @@ -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 diff --git a/docs/data-sources/clickhouse_database.md b/docs/data-sources/clickhouse_database.md index 274ba0b63..816e5bed7 100644 --- a/docs/data-sources/clickhouse_database.md +++ b/docs/data-sources/clickhouse_database.md @@ -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 diff --git a/docs/data-sources/clickhouse_user.md b/docs/data-sources/clickhouse_user.md index c593cdfbc..d3745e4ec 100644 --- a/docs/data-sources/clickhouse_user.md +++ b/docs/data-sources/clickhouse_user.md @@ -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 diff --git a/docs/data-sources/connection_pool.md b/docs/data-sources/connection_pool.md index b65159536..07c341e0c 100644 --- a/docs/data-sources/connection_pool.md +++ b/docs/data-sources/connection_pool.md @@ -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`. diff --git a/docs/data-sources/flink.md b/docs/data-sources/flink.md index 08001df7c..0fa32f2d5 100644 --- a/docs/data-sources/flink.md +++ b/docs/data-sources/flink.md @@ -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 diff --git a/docs/data-sources/flink_application.md b/docs/data-sources/flink_application.md index da5934756..d0393bf91 100644 --- a/docs/data-sources/flink_application.md +++ b/docs/data-sources/flink_application.md @@ -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 diff --git a/docs/data-sources/flink_application_version.md b/docs/data-sources/flink_application_version.md index 086d6d582..d4f138f4a 100644 --- a/docs/data-sources/flink_application_version.md +++ b/docs/data-sources/flink_application_version.md @@ -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 diff --git a/docs/data-sources/gcp_privatelink.md b/docs/data-sources/gcp_privatelink.md index 7fa981436..ce42eb157 100644 --- a/docs/data-sources/gcp_privatelink.md +++ b/docs/data-sources/gcp_privatelink.md @@ -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 diff --git a/docs/data-sources/gcp_vpc_peering_connection.md b/docs/data-sources/gcp_vpc_peering_connection.md index 82362aee4..957df0928 100644 --- a/docs/data-sources/gcp_vpc_peering_connection.md +++ b/docs/data-sources/gcp_vpc_peering_connection.md @@ -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 diff --git a/docs/data-sources/grafana.md b/docs/data-sources/grafana.md index 1acb310f8..5c780545a 100644 --- a/docs/data-sources/grafana.md +++ b/docs/data-sources/grafana.md @@ -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 diff --git a/docs/data-sources/kafka.md b/docs/data-sources/kafka.md index 9e11d59f0..da55edc77 100644 --- a/docs/data-sources/kafka.md +++ b/docs/data-sources/kafka.md @@ -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 diff --git a/docs/data-sources/kafka_acl.md b/docs/data-sources/kafka_acl.md index cc42759cf..a9174afc6 100644 --- a/docs/data-sources/kafka_acl.md +++ b/docs/data-sources/kafka_acl.md @@ -27,11 +27,11 @@ data "aiven_kafka_acl" "mytestacl" { ### Required -- `permission` (String) Kafka permission to grant. The possible values are `admin`, `read`, `readwrite` and `write`. 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. -- `topic` (String) Topic name pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource. -- `username` (String) Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource. +- `permission` (String) Kafka permission to grant. The possible values are `admin`, `read`, `readwrite` and `write`. 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. +- `topic` (String) Topic name pattern for the ACL entry. Changing this property forces recreation of the resource. +- `username` (String) Username pattern for the ACL entry. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/kafka_connect.md b/docs/data-sources/kafka_connect.md index dd58c64bc..3b0b4030f 100644 --- a/docs/data-sources/kafka_connect.md +++ b/docs/data-sources/kafka_connect.md @@ -24,7 +24,7 @@ data "aiven_kafka_connect" "kc1" { ### 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 diff --git a/docs/data-sources/kafka_connector.md b/docs/data-sources/kafka_connector.md index 312bc6027..a67804969 100644 --- a/docs/data-sources/kafka_connector.md +++ b/docs/data-sources/kafka_connector.md @@ -25,9 +25,9 @@ data "aiven_kafka_connector" "kafka-es-con1" { ### Required -- `connector_name` (String) The kafka connector name. 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. +- `connector_name` (String) The kafka connector name. 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 diff --git a/docs/data-sources/kafka_mirrormaker.md b/docs/data-sources/kafka_mirrormaker.md index 7d3a18e31..3bac7e046 100644 --- a/docs/data-sources/kafka_mirrormaker.md +++ b/docs/data-sources/kafka_mirrormaker.md @@ -24,7 +24,7 @@ data "aiven_kafka_mirrormaker" "mm1" { ### 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 diff --git a/docs/data-sources/kafka_schema.md b/docs/data-sources/kafka_schema.md index 95863ee08..b7ad133e2 100644 --- a/docs/data-sources/kafka_schema.md +++ b/docs/data-sources/kafka_schema.md @@ -24,9 +24,9 @@ data "aiven_kafka_schema_configuration" "config" { ### 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. -- `subject_name` (String) The Kafka Schema Subject name. 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. +- `subject_name` (String) The Kafka Schema Subject name. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/kafka_schema_configuration.md b/docs/data-sources/kafka_schema_configuration.md index 4a95fad86..85a66cd6d 100644 --- a/docs/data-sources/kafka_schema_configuration.md +++ b/docs/data-sources/kafka_schema_configuration.md @@ -25,8 +25,8 @@ resource "aiven_kafka_schema_configuration" "config" { ### 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 @@ -34,5 +34,5 @@ resource "aiven_kafka_schema_configuration" "config" { - `id` (String) The ID of this resource. - `schema` (String) Kafka Schema configuration. Should be a valid Avro, JSON, or Protobuf schema, depending on the schema type. - `schema_type` (String) Kafka Schema configuration type. Defaults to AVRO. Possible values are AVRO, JSON, and PROTOBUF. -- `subject_name` (String) The Kafka Schema Subject name. This property cannot be changed, doing so forces recreation of the resource. +- `subject_name` (String) The Kafka Schema Subject name. Changing this property forces recreation of the resource. - `version` (Number) Kafka Schema configuration version. diff --git a/docs/data-sources/kafka_schema_registry_acl.md b/docs/data-sources/kafka_schema_registry_acl.md index a26d6271c..de7a0c79d 100644 --- a/docs/data-sources/kafka_schema_registry_acl.md +++ b/docs/data-sources/kafka_schema_registry_acl.md @@ -17,11 +17,11 @@ The Data Source Kafka Schema Registry ACL data source provides information about ### Required -- `permission` (String) Kafka Schema Registry permission to grant. The possible values are `schema_registry_read` and `schema_registry_write`. 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. -- `resource` (String) Resource name pattern for the Schema Registry ACL entry. 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) Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource. +- `permission` (String) Kafka Schema Registry permission to grant. The possible values are `schema_registry_read` and `schema_registry_write`. 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. +- `resource` (String) Resource name pattern for the Schema Registry ACL entry. 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) Username pattern for the ACL entry. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/kafka_topic.md b/docs/data-sources/kafka_topic.md index 6e8b3195d..7a536dd24 100644 --- a/docs/data-sources/kafka_topic.md +++ b/docs/data-sources/kafka_topic.md @@ -25,9 +25,9 @@ data "aiven_kafka_topic" "mytesttopic" { ### 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. -- `topic_name` (String) The name of the topic. 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. +- `topic_name` (String) The name of the topic. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/kafka_user.md b/docs/data-sources/kafka_user.md index 42e8b5c65..4ac88a723 100644 --- a/docs/data-sources/kafka_user.md +++ b/docs/data-sources/kafka_user.md @@ -25,9 +25,9 @@ data "aiven_kafka_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 Kafka 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 Kafka User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/m3aggregator.md b/docs/data-sources/m3aggregator.md index 11ecabdb3..06a142816 100644 --- a/docs/data-sources/m3aggregator.md +++ b/docs/data-sources/m3aggregator.md @@ -24,7 +24,7 @@ data "aiven_m3aggregator" "m3a" { ### 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 diff --git a/docs/data-sources/m3db.md b/docs/data-sources/m3db.md index 23935a50b..d180cd7c4 100644 --- a/docs/data-sources/m3db.md +++ b/docs/data-sources/m3db.md @@ -24,7 +24,7 @@ data "aiven_m3db" "m3" { ### 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 diff --git a/docs/data-sources/m3db_user.md b/docs/data-sources/m3db_user.md index 6ee27d8f6..dc97a01de 100644 --- a/docs/data-sources/m3db_user.md +++ b/docs/data-sources/m3db_user.md @@ -25,9 +25,9 @@ data "aiven_m3db_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 M3DB 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 M3DB User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/mirrormaker_replication_flow.md b/docs/data-sources/mirrormaker_replication_flow.md index 145769d29..00f962499 100644 --- a/docs/data-sources/mirrormaker_replication_flow.md +++ b/docs/data-sources/mirrormaker_replication_flow.md @@ -26,8 +26,8 @@ data "aiven_mirrormaker_replication_flow" "f1" { ### 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) 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) 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. - `source_cluster` (String) Source cluster alias. Maximum length: `128`. - `target_cluster` (String) Target cluster alias. Maximum length: `128`. diff --git a/docs/data-sources/mysql.md b/docs/data-sources/mysql.md index 4c8aad65d..5604dfaa4 100644 --- a/docs/data-sources/mysql.md +++ b/docs/data-sources/mysql.md @@ -24,7 +24,7 @@ data "aiven_mysql" "mysql1" { ### 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 diff --git a/docs/data-sources/mysql_database.md b/docs/data-sources/mysql_database.md index 384aefe81..2523a7fed 100644 --- a/docs/data-sources/mysql_database.md +++ b/docs/data-sources/mysql_database.md @@ -25,9 +25,9 @@ data "aiven_mysql_database" "mydatabase" { ### Required -- `database_name` (String) The name of the service 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. +- `database_name` (String) The name of the service 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 diff --git a/docs/data-sources/mysql_user.md b/docs/data-sources/mysql_user.md index bdd5048b4..ac3c49f43 100644 --- a/docs/data-sources/mysql_user.md +++ b/docs/data-sources/mysql_user.md @@ -25,9 +25,9 @@ data "aiven_mysql_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 MySQL 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 MySQL User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/opensearch.md b/docs/data-sources/opensearch.md index 02c5e56c8..2a81aff5b 100644 --- a/docs/data-sources/opensearch.md +++ b/docs/data-sources/opensearch.md @@ -24,7 +24,7 @@ data "aiven_opensearch" "os1" { ### 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 diff --git a/docs/data-sources/opensearch_acl_config.md b/docs/data-sources/opensearch_acl_config.md index feacf418e..a57dd0863 100644 --- a/docs/data-sources/opensearch_acl_config.md +++ b/docs/data-sources/opensearch_acl_config.md @@ -24,8 +24,8 @@ data "aiven_opensearch_acl_config" "os-acl-config" { ### 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 diff --git a/docs/data-sources/opensearch_acl_rule.md b/docs/data-sources/opensearch_acl_rule.md index 32c2e5e1d..5c17ea10f 100644 --- a/docs/data-sources/opensearch_acl_rule.md +++ b/docs/data-sources/opensearch_acl_rule.md @@ -26,11 +26,11 @@ data "aiven_opensearch_acl_rule" "os_acl_rule" { ### Required -- `index` (String) The index pattern for this ACL entry. Maximum length: `249`. This property cannot be changed, doing so forces recreation of the resource. +- `index` (String) The index pattern for this ACL entry. Maximum length: `249`. Changing this property forces recreation of the resource. - `permission` (String) The permissions for this ACL entry. The possible values are `deny`, `admin`, `read`, `readwrite` and `write`. -- `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 username for the ACL entry. Maximum length: `40`. 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 username for the ACL entry. Maximum length: `40`. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/opensearch_security_plugin_config.md b/docs/data-sources/opensearch_security_plugin_config.md index 294e364d6..0fcafc249 100644 --- a/docs/data-sources/opensearch_security_plugin_config.md +++ b/docs/data-sources/opensearch_security_plugin_config.md @@ -24,8 +24,8 @@ data "aiven_opensearch_security_plugin_config" "os-sec-config" { ### 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 diff --git a/docs/data-sources/opensearch_user.md b/docs/data-sources/opensearch_user.md index e13ef3808..da9f09598 100644 --- a/docs/data-sources/opensearch_user.md +++ b/docs/data-sources/opensearch_user.md @@ -25,9 +25,9 @@ data "aiven_opensearch_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 OpenSearch 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 OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/organization.md b/docs/data-sources/organization.md index 1f96541f1..a34130455 100644 --- a/docs/data-sources/organization.md +++ b/docs/data-sources/organization.md @@ -3,18 +3,18 @@ page_title: "aiven_organization Data Source - terraform-provider-aiven" subcategory: "" description: |- - Retrieves information about an organization from Aiven. + Gets information about an organization. --- # aiven_organization (Data Source) -Retrieves information about an organization from Aiven. +Gets information about an organization. ## Example Usage ```terraform -data "aiven_organization" "organization1" { - name = "" +data "aiven_organization" "main" { + name = "Example organization" } ``` @@ -23,11 +23,11 @@ data "aiven_organization" "organization1" { ### Optional -- `id` (String) Identifier of the organization. +- `id` (String) ID of the organization. - `name` (String) Name of the organization. ### Read-Only - `create_time` (String) Timestamp of the creation of the organization. -- `tenant_id` (String) Tenant identifier of the organization. +- `tenant_id` (String) Tenant ID of the organization. - `update_time` (String) Timestamp of the last update of the organization. diff --git a/docs/data-sources/organization_user_group.md b/docs/data-sources/organization_user_group.md index 217ff6a8a..51ce3deb7 100644 --- a/docs/data-sources/organization_user_group.md +++ b/docs/data-sources/organization_user_group.md @@ -3,27 +3,34 @@ page_title: "aiven_organization_user_group Data Source - terraform-provider-aiven" subcategory: "" description: |- - Provides information about an existing user group in an organization. + Gets information about an existing user group in an organization. --- # aiven_organization_user_group (Data Source) -Provides information about an existing user group in an organization. +Gets information about an existing user group in an organization. +## Example Usage +```terraform +data "aiven_organization_user_group" "example" { + name = "Example group" + organization_id = aiven_organization.main.id +} +``` ## Schema ### Required -- `name` (String) The name of the user group. This property cannot be changed, doing so forces recreation of the resource. -- `organization_id` (String) The ID of the organization. This property cannot be changed, doing so forces recreation of the resource. +- `name` (String) The name of the user group. Changing this property forces recreation of the resource. +- `organization_id` (String) The ID of the organization. Changing this property forces recreation of the resource. ### Read-Only - `create_time` (String) Time of creation. -- `description` (String) The description of the user group. This property cannot be changed, doing so forces recreation of the resource. +- `description` (String) The description of the user group. Changing this property forces recreation of the resource. - `group_id` (String) The ID of the user group. - `id` (String) The ID of this resource. - `update_time` (String) Time of last update. diff --git a/docs/data-sources/pg.md b/docs/data-sources/pg.md index e25848089..59df4dd9b 100644 --- a/docs/data-sources/pg.md +++ b/docs/data-sources/pg.md @@ -24,7 +24,7 @@ data "aiven_pg" "pg" { ### 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 diff --git a/docs/data-sources/pg_database.md b/docs/data-sources/pg_database.md index bc7af1c0a..6401f16ed 100644 --- a/docs/data-sources/pg_database.md +++ b/docs/data-sources/pg_database.md @@ -25,13 +25,13 @@ data "aiven_pg_database" "mydatabase" { ### Required -- `database_name` (String) The name of the service 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. +- `database_name` (String) The name of the service 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 - `id` (String) The ID of this resource. -- `lc_collate` (String) Default string sort order (`LC_COLLATE`) of the database. The default value is `en_US.UTF-8`. This property cannot be changed, doing so forces recreation of the resource. -- `lc_ctype` (String) Default character classification (`LC_CTYPE`) of the database. The default value is `en_US.UTF-8`. This property cannot be changed, doing so forces recreation of the resource. +- `lc_collate` (String) Default string sort order (`LC_COLLATE`) of the database. The default value is `en_US.UTF-8`. Changing this property forces recreation of the resource. +- `lc_ctype` (String) Default character classification (`LC_CTYPE`) of the database. The default value is `en_US.UTF-8`. Changing this property forces recreation of the resource. - `termination_protection` (Boolean) It is a Terraform client-side deletion protections, which prevents the database from being deleted by Terraform. It is recommended to enable this for any production databases containing critical data. The default value is `false`. diff --git a/docs/data-sources/pg_user.md b/docs/data-sources/pg_user.md index a93a91082..ee302a6e1 100644 --- a/docs/data-sources/pg_user.md +++ b/docs/data-sources/pg_user.md @@ -25,9 +25,9 @@ data "aiven_pg_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 PG 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 PG User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only diff --git a/docs/data-sources/project_user.md b/docs/data-sources/project_user.md index a8b138627..e2a2e2123 100644 --- a/docs/data-sources/project_user.md +++ b/docs/data-sources/project_user.md @@ -24,8 +24,8 @@ data "aiven_project_user" "mytestuser" { ### Required -- `email` (String) Email address of the user. Should be lowercase. 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. +- `email` (String) Email address of the user. Should be lowercase. 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. ### Read-Only diff --git a/docs/data-sources/redis.md b/docs/data-sources/redis.md index a76085649..45e63c4d6 100644 --- a/docs/data-sources/redis.md +++ b/docs/data-sources/redis.md @@ -24,7 +24,7 @@ data "aiven_redis" "redis1" { ### 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 diff --git a/docs/data-sources/redis_user.md b/docs/data-sources/redis_user.md index e2e3f2d2f..2ee942e5e 100644 --- a/docs/data-sources/redis_user.md +++ b/docs/data-sources/redis_user.md @@ -25,16 +25,16 @@ data "aiven_redis_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 Redis 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 Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only - `id` (String) The ID of this resource. - `password` (String, Sensitive) The password of the Redis User. -- `redis_acl_categories` (List of String) Defines command category rules. The field is required with`redis_acl_commands` and `redis_acl_keys`. This property cannot be changed, doing so forces recreation of the resource. -- `redis_acl_channels` (List of String) Defines the permitted pub/sub channel patterns. This property cannot be changed, doing so forces recreation of the resource. -- `redis_acl_commands` (List of String) Defines rules for individual commands. The field is required with`redis_acl_categories` and `redis_acl_keys`. This property cannot be changed, doing so forces recreation of the resource. -- `redis_acl_keys` (List of String) Defines key access rules. The field is required with`redis_acl_categories` and `redis_acl_keys`. This property cannot be changed, doing so forces recreation of the resource. +- `redis_acl_categories` (List of String) Defines command category rules. The field is required with`redis_acl_commands` and `redis_acl_keys`. Changing this property forces recreation of the resource. +- `redis_acl_channels` (List of String) Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource. +- `redis_acl_commands` (List of String) Defines rules for individual commands. The field is required with`redis_acl_categories` and `redis_acl_keys`. Changing this property forces recreation of the resource. +- `redis_acl_keys` (List of String) Defines key access rules. The field is required with`redis_acl_categories` and `redis_acl_keys`. Changing this property forces recreation of the resource. - `type` (String) Type of the user account. Tells whether the user is the primary account or a regular account. diff --git a/docs/data-sources/transit_gateway_vpc_attachment.md b/docs/data-sources/transit_gateway_vpc_attachment.md index 01117ac76..c0230b2b0 100644 --- a/docs/data-sources/transit_gateway_vpc_attachment.md +++ b/docs/data-sources/transit_gateway_vpc_attachment.md @@ -25,9 +25,9 @@ data "aiven_transit_gateway_vpc_attachment" "attachment" { ### Required -- `peer_cloud_account` (String) AWS account ID or GCP project ID of the peered VPC. This property cannot be changed, doing so forces recreation of the resource. -- `peer_vpc` (String) Transit gateway ID. This property cannot be changed, doing so forces recreation of the resource. -- `vpc_id` (String) The VPC the peering connection 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. +- `peer_cloud_account` (String) AWS account ID or GCP project ID of the peered VPC. Changing this property forces recreation of the resource. +- `peer_vpc` (String) Transit gateway ID. Changing this property forces recreation of the resource. +- `vpc_id` (String) The VPC the peering connection 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 diff --git a/docs/resources/account_team_member.md b/docs/resources/account_team_member.md index 5d2c56ef9..a53262e5e 100644 --- a/docs/resources/account_team_member.md +++ b/docs/resources/account_team_member.md @@ -33,9 +33,9 @@ resource "aiven_account_team_member" "main" { ### 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. ### Optional diff --git a/docs/resources/aws_privatelink.md b/docs/resources/aws_privatelink.md index 46b98dffc..a91d91b56 100644 --- a/docs/resources/aws_privatelink.md +++ b/docs/resources/aws_privatelink.md @@ -29,8 +29,8 @@ resource "aiven_aws_privatelink" "foo" { ### Required - `principals` (Set of String) List of allowed principals -- `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. ### Optional diff --git a/docs/resources/aws_vpc_peering_connection.md b/docs/resources/aws_vpc_peering_connection.md index 5cbc2b51b..0415f1ddb 100644 --- a/docs/resources/aws_vpc_peering_connection.md +++ b/docs/resources/aws_vpc_peering_connection.md @@ -25,10 +25,10 @@ resource "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. ### Optional diff --git a/docs/resources/azure_privatelink.md b/docs/resources/azure_privatelink.md index 29e02e2a4..3e3b0953c 100644 --- a/docs/resources/azure_privatelink.md +++ b/docs/resources/azure_privatelink.md @@ -28,8 +28,8 @@ resource "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. - `user_subscription_ids` (Set of String) A List of allowed Subscription IDs. Maximum length: `16`. ### Optional diff --git a/docs/resources/azure_privatelink_connection_approval.md b/docs/resources/azure_privatelink_connection_approval.md index 4cbe59f0b..6193c6238 100644 --- a/docs/resources/azure_privatelink_connection_approval.md +++ b/docs/resources/azure_privatelink_connection_approval.md @@ -74,8 +74,8 @@ resource "aiven_azure_privatelink_connection_approval" "approval" { ### 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. ### Optional diff --git a/docs/resources/azure_vpc_peering_connection.md b/docs/resources/azure_vpc_peering_connection.md index 7b60fd0c3..a516115d8 100644 --- a/docs/resources/azure_vpc_peering_connection.md +++ b/docs/resources/azure_vpc_peering_connection.md @@ -28,12 +28,12 @@ resource "aiven_azure_vpc_peering_connection" "foo" { ### 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. ### Optional diff --git a/docs/resources/cassandra.md b/docs/resources/cassandra.md index b0f0371a5..098027ebd 100644 --- a/docs/resources/cassandra.md +++ b/docs/resources/cassandra.md @@ -37,7 +37,7 @@ resource "aiven_cassandra" "bar" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/cassandra_user.md b/docs/resources/cassandra_user.md index cec2ba8a2..7a5740df0 100644 --- a/docs/resources/cassandra_user.md +++ b/docs/resources/cassandra_user.md @@ -26,9 +26,9 @@ resource "aiven_cassandra_user" "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. -- `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. ### Optional diff --git a/docs/resources/clickhouse.md b/docs/resources/clickhouse.md index 3f21c9932..d4237590f 100644 --- a/docs/resources/clickhouse.md +++ b/docs/resources/clickhouse.md @@ -29,7 +29,7 @@ resource "aiven_clickhouse" "clickhouse" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/clickhouse_database.md b/docs/resources/clickhouse_database.md index e4d37d08b..cc911d1dc 100644 --- a/docs/resources/clickhouse_database.md +++ b/docs/resources/clickhouse_database.md @@ -25,9 +25,9 @@ resource "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. ### Optional diff --git a/docs/resources/clickhouse_grant.md b/docs/resources/clickhouse_grant.md index 4b007459b..3e4c66b86 100644 --- a/docs/resources/clickhouse_grant.md +++ b/docs/resources/clickhouse_grant.md @@ -80,16 +80,16 @@ resource "aiven_clickhouse_grant" "demo-user-grant" { ### 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. ### Optional -- `privilege_grant` (Block Set) Configuration to grant a privilege. This property cannot be changed, doing so forces recreation of the resource. (see [below for nested schema](#nestedblock--privilege_grant)) -- `role` (String) The role to grant privileges or roles 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. -- `role_grant` (Block Set) Configuration to grant a role. This property cannot be changed, doing so forces recreation of the resource. (see [below for nested schema](#nestedblock--role_grant)) +- `privilege_grant` (Block Set) Configuration to grant a privilege. Changing this property forces recreation of the resource. (see [below for nested schema](#nestedblock--privilege_grant)) +- `role` (String) The role to grant privileges or roles to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. +- `role_grant` (Block Set) Configuration to grant a role. Changing this property forces recreation of the resource. (see [below for nested schema](#nestedblock--role_grant)) - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) -- `user` (String) The user to grant privileges or roles 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. +- `user` (String) The user to grant privileges or roles to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Read-Only @@ -100,14 +100,14 @@ resource "aiven_clickhouse_grant" "demo-user-grant" { Required: -- `database` (String) The database that the grant refers 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` (String) The database that the grant refers to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. Optional: -- `column` (String) The column that the grant refers to. This property cannot be changed, doing so forces recreation of the resource. -- `privilege` (String) The privilege to grant, i.e. 'INSERT', 'SELECT', etc. This property cannot be changed, doing so forces recreation of the resource. -- `table` (String) The table that the grant refers to. This property cannot be changed, doing so forces recreation of the resource. -- `with_grant` (Boolean) If true then the grantee gets the ability to grant the privileges he received too. This property cannot be changed, doing so forces recreation of the resource. +- `column` (String) The column that the grant refers to. Changing this property forces recreation of the resource. +- `privilege` (String) The privilege to grant, i.e. 'INSERT', 'SELECT', etc. Changing this property forces recreation of the resource. +- `table` (String) The table that the grant refers to. Changing this property forces recreation of the resource. +- `with_grant` (Boolean) If true then the grantee gets the ability to grant the privileges he received too. Changing this property forces recreation of the resource. @@ -115,7 +115,7 @@ Optional: Optional: -- `role` (String) The role that is to be granted. 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. +- `role` (String) The role that is to be granted. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. diff --git a/docs/resources/clickhouse_role.md b/docs/resources/clickhouse_role.md index 34abbacf9..720b5ce02 100644 --- a/docs/resources/clickhouse_role.md +++ b/docs/resources/clickhouse_role.md @@ -34,9 +34,9 @@ resource "aiven_clickhouse_role" "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. -- `role` (String) The role that is to be created. 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. +- `role` (String) The role that is to be created. 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. ### Optional diff --git a/docs/resources/clickhouse_user.md b/docs/resources/clickhouse_user.md index ce73cf36a..9a25c25d4 100644 --- a/docs/resources/clickhouse_user.md +++ b/docs/resources/clickhouse_user.md @@ -25,9 +25,9 @@ resource "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. ### Optional diff --git a/docs/resources/connection_pool.md b/docs/resources/connection_pool.md index 818d4452e..d5b761caa 100644 --- a/docs/resources/connection_pool.md +++ b/docs/resources/connection_pool.md @@ -29,10 +29,10 @@ resource "aiven_connection_pool" "mytestpool" { ### Required -- `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. -- `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. +- `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. +- `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. ### Optional diff --git a/docs/resources/flink.md b/docs/resources/flink.md index bb6c02afe..fa413d121 100644 --- a/docs/resources/flink.md +++ b/docs/resources/flink.md @@ -33,7 +33,7 @@ resource "aiven_flink" "flink" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/flink_application.md b/docs/resources/flink_application.md index fea55fe8d..073ce3c44 100644 --- a/docs/resources/flink_application.md +++ b/docs/resources/flink_application.md @@ -26,8 +26,8 @@ resource "aiven_flink_application" "foo" { ### 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. ### Optional diff --git a/docs/resources/flink_application_deployment.md b/docs/resources/flink_application_deployment.md index 43600ac94..673657984 100644 --- a/docs/resources/flink_application_deployment.md +++ b/docs/resources/flink_application_deployment.md @@ -27,8 +27,8 @@ resource "aiven_flink_application_deployment" "deployment" { ### Required - `application_id` (String) Application 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. - `version_id` (String) ApplicationVersion ID ### Optional diff --git a/docs/resources/flink_application_version.md b/docs/resources/flink_application_version.md index 9b6da3f5b..3fe309ec4 100644 --- a/docs/resources/flink_application_version.md +++ b/docs/resources/flink_application_version.md @@ -59,8 +59,8 @@ resource "aiven_flink_application_version" "foo" { ### Required - `application_id` (String) Application 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. - `statement` (String) Job SQL statement ### Optional diff --git a/docs/resources/gcp_privatelink.md b/docs/resources/gcp_privatelink.md index be019f179..3d371919d 100644 --- a/docs/resources/gcp_privatelink.md +++ b/docs/resources/gcp_privatelink.md @@ -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. ### Optional diff --git a/docs/resources/gcp_privatelink_connection_approval.md b/docs/resources/gcp_privatelink_connection_approval.md index 57e634bf3..8cc158b32 100644 --- a/docs/resources/gcp_privatelink_connection_approval.md +++ b/docs/resources/gcp_privatelink_connection_approval.md @@ -17,8 +17,8 @@ The GCP privatelink approve resource waits for an aiven privatelink connection o ### 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. - `user_ip_address` (String) Privatelink connection user IP address ### Optional diff --git a/docs/resources/gcp_vpc_peering_connection.md b/docs/resources/gcp_vpc_peering_connection.md index 400edba50..0bea43b6a 100644 --- a/docs/resources/gcp_vpc_peering_connection.md +++ b/docs/resources/gcp_vpc_peering_connection.md @@ -25,9 +25,9 @@ resource "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. ### Optional diff --git a/docs/resources/grafana.md b/docs/resources/grafana.md index 61359e103..74a315b20 100644 --- a/docs/resources/grafana.md +++ b/docs/resources/grafana.md @@ -37,7 +37,7 @@ resource "aiven_grafana" "gr1" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/kafka.md b/docs/resources/kafka.md index 369231036..6261b1792 100644 --- a/docs/resources/kafka.md +++ b/docs/resources/kafka.md @@ -46,7 +46,7 @@ resource "aiven_kafka" "kafka1" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/kafka_acl.md b/docs/resources/kafka_acl.md index de8ccc7cf..f8d7d91ee 100644 --- a/docs/resources/kafka_acl.md +++ b/docs/resources/kafka_acl.md @@ -27,11 +27,11 @@ resource "aiven_kafka_acl" "mytestacl" { ### Required -- `permission` (String) Kafka permission to grant. The possible values are `admin`, `read`, `readwrite` and `write`. 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. -- `topic` (String) Topic name pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource. -- `username` (String) Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource. +- `permission` (String) Kafka permission to grant. The possible values are `admin`, `read`, `readwrite` and `write`. 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. +- `topic` (String) Topic name pattern for the ACL entry. Changing this property forces recreation of the resource. +- `username` (String) Username pattern for the ACL entry. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/kafka_connect.md b/docs/resources/kafka_connect.md index 7fa0ca856..2580614a0 100644 --- a/docs/resources/kafka_connect.md +++ b/docs/resources/kafka_connect.md @@ -39,7 +39,7 @@ resource "aiven_kafka_connect" "kc1" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/kafka_connector.md b/docs/resources/kafka_connector.md index 22950da90..1b7c7d269 100644 --- a/docs/resources/kafka_connector.md +++ b/docs/resources/kafka_connector.md @@ -36,9 +36,9 @@ resource "aiven_kafka_connector" "kafka-os-con1" { ### Required - `config` (Map of String) The Kafka Connector configuration parameters. -- `connector_name` (String) The kafka connector name. 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. +- `connector_name` (String) The kafka connector name. 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. ### Optional diff --git a/docs/resources/kafka_mirrormaker.md b/docs/resources/kafka_mirrormaker.md index 3a5dfc194..473231412 100644 --- a/docs/resources/kafka_mirrormaker.md +++ b/docs/resources/kafka_mirrormaker.md @@ -37,7 +37,7 @@ resource "aiven_kafka_mirrormaker" "mm1" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/kafka_schema.md b/docs/resources/kafka_schema.md index e15537d73..13e08a020 100644 --- a/docs/resources/kafka_schema.md +++ b/docs/resources/kafka_schema.md @@ -44,10 +44,10 @@ resource "aiven_kafka_schema" "kafka-schema1" { ### 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. - `schema` (String) Kafka Schema configuration. Should be a valid Avro, JSON, or Protobuf schema, depending on the schema type. -- `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. -- `subject_name` (String) The Kafka Schema Subject name. 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. Changing this property forces recreation of the resource. +- `subject_name` (String) The Kafka Schema Subject name. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/kafka_schema_configuration.md b/docs/resources/kafka_schema_configuration.md index 20c38152e..01010fa40 100644 --- a/docs/resources/kafka_schema_configuration.md +++ b/docs/resources/kafka_schema_configuration.md @@ -25,8 +25,8 @@ resource "aiven_kafka_schema_configuration" "config" { ### 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. ### Optional diff --git a/docs/resources/kafka_schema_registry_acl.md b/docs/resources/kafka_schema_registry_acl.md index 326e7281b..fd019bdda 100644 --- a/docs/resources/kafka_schema_registry_acl.md +++ b/docs/resources/kafka_schema_registry_acl.md @@ -17,11 +17,11 @@ The Resource Kafka Schema Registry ACL resource allows the creation and manageme ### Required -- `permission` (String) Kafka Schema Registry permission to grant. The possible values are `schema_registry_read` and `schema_registry_write`. 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. -- `resource` (String) Resource name pattern for the Schema Registry ACL entry. 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) Username pattern for the ACL entry. This property cannot be changed, doing so forces recreation of the resource. +- `permission` (String) Kafka Schema Registry permission to grant. The possible values are `schema_registry_read` and `schema_registry_write`. 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. +- `resource` (String) Resource name pattern for the Schema Registry ACL entry. 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) Username pattern for the ACL entry. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/kafka_topic.md b/docs/resources/kafka_topic.md index 9bbc7e575..4724ddb6e 100644 --- a/docs/resources/kafka_topic.md +++ b/docs/resources/kafka_topic.md @@ -40,10 +40,10 @@ resource "aiven_kafka_topic" "mytesttopic" { ### Required - `partitions` (Number) The number of partitions to create in the topic. -- `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. - `replication` (Number) The replication factor for the topic. -- `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. -- `topic_name` (String) The name of the topic. 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. Changing this property forces recreation of the resource. +- `topic_name` (String) The name of the topic. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/kafka_user.md b/docs/resources/kafka_user.md index 59118cb6d..cf9d1f7bb 100644 --- a/docs/resources/kafka_user.md +++ b/docs/resources/kafka_user.md @@ -26,9 +26,9 @@ resource "aiven_kafka_user" "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. -- `username` (String) The actual name of the Kafka 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 Kafka User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/m3aggregator.md b/docs/resources/m3aggregator.md index 3c3dcf8ab..9ed912205 100644 --- a/docs/resources/m3aggregator.md +++ b/docs/resources/m3aggregator.md @@ -33,7 +33,7 @@ resource "aiven_m3aggregator" "m3a" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/m3db.md b/docs/resources/m3db.md index 963911220..517a3efaf 100644 --- a/docs/resources/m3db.md +++ b/docs/resources/m3db.md @@ -38,7 +38,7 @@ resource "aiven_m3db" "m3" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/m3db_user.md b/docs/resources/m3db_user.md index 321f68876..4b708af40 100644 --- a/docs/resources/m3db_user.md +++ b/docs/resources/m3db_user.md @@ -26,9 +26,9 @@ resource "aiven_m3db_user" "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. -- `username` (String) The actual name of the M3DB 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 M3DB User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/mirrormaker_replication_flow.md b/docs/resources/mirrormaker_replication_flow.md index c4d42bb3f..22363d5f1 100644 --- a/docs/resources/mirrormaker_replication_flow.md +++ b/docs/resources/mirrormaker_replication_flow.md @@ -38,8 +38,8 @@ resource "aiven_mirrormaker_replication_flow" "f1" { ### Required - `enable` (Boolean) Enable of disable replication flows for a service. -- `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) 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) 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. - `source_cluster` (String) Source cluster alias. Maximum length: `128`. - `target_cluster` (String) Target cluster alias. Maximum length: `128`. diff --git a/docs/resources/mysql.md b/docs/resources/mysql.md index 076687140..a64d8c688 100644 --- a/docs/resources/mysql.md +++ b/docs/resources/mysql.md @@ -42,7 +42,7 @@ resource "aiven_mysql" "mysql1" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/mysql_database.md b/docs/resources/mysql_database.md index 8189b7526..5bcb21efd 100644 --- a/docs/resources/mysql_database.md +++ b/docs/resources/mysql_database.md @@ -25,9 +25,9 @@ resource "aiven_mysql_database" "mydatabase" { ### Required -- `database_name` (String) The name of the service 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. +- `database_name` (String) The name of the service 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. ### Optional diff --git a/docs/resources/mysql_user.md b/docs/resources/mysql_user.md index 61b306145..e25c35f44 100644 --- a/docs/resources/mysql_user.md +++ b/docs/resources/mysql_user.md @@ -26,9 +26,9 @@ resource "aiven_mysql_user" "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. -- `username` (String) The actual name of the MySQL 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 MySQL User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/opensearch.md b/docs/resources/opensearch.md index b85a17184..a6beb93d3 100644 --- a/docs/resources/opensearch.md +++ b/docs/resources/opensearch.md @@ -43,7 +43,7 @@ resource "aiven_opensearch" "os1" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/opensearch_acl_config.md b/docs/resources/opensearch_acl_config.md index 0b1092a23..be57dd65f 100644 --- a/docs/resources/opensearch_acl_config.md +++ b/docs/resources/opensearch_acl_config.md @@ -45,8 +45,8 @@ resource "aiven_opensearch_acl_config" "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. ### Optional diff --git a/docs/resources/opensearch_acl_rule.md b/docs/resources/opensearch_acl_rule.md index f83a2a587..e7ce6e51c 100644 --- a/docs/resources/opensearch_acl_rule.md +++ b/docs/resources/opensearch_acl_rule.md @@ -78,11 +78,11 @@ resource "aiven_opensearch_acl_rule" "os_acl_rule" { ### Required -- `index` (String) The index pattern for this ACL entry. Maximum length: `249`. This property cannot be changed, doing so forces recreation of the resource. +- `index` (String) The index pattern for this ACL entry. Maximum length: `249`. Changing this property forces recreation of the resource. - `permission` (String) The permissions for this ACL entry. The possible values are `deny`, `admin`, `read`, `readwrite` and `write`. -- `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 username for the ACL entry. Maximum length: `40`. 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 username for the ACL entry. Maximum length: `40`. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/opensearch_security_plugin_config.md b/docs/resources/opensearch_security_plugin_config.md index 9b48bec22..7e6722106 100644 --- a/docs/resources/opensearch_security_plugin_config.md +++ b/docs/resources/opensearch_security_plugin_config.md @@ -45,8 +45,8 @@ resource "aiven_opensearch_security_config" "foo" { ### Required - `admin_password` (String, Sensitive) The password for the os-sec-admin user. -- `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. ### Optional diff --git a/docs/resources/opensearch_user.md b/docs/resources/opensearch_user.md index 64246f053..c1966c354 100644 --- a/docs/resources/opensearch_user.md +++ b/docs/resources/opensearch_user.md @@ -26,9 +26,9 @@ resource "aiven_opensearch_user" "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. -- `username` (String) The actual name of the OpenSearch 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 OpenSearch User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/organization.md b/docs/resources/organization.md index 6eb4aaba5..76388c2fd 100644 --- a/docs/resources/organization.md +++ b/docs/resources/organization.md @@ -3,18 +3,18 @@ page_title: "aiven_organization Resource - terraform-provider-aiven" subcategory: "" description: |- - Creates and manages an organization in Aiven. + Creates and manages an organization https://aiven.io/docs/platform/concepts/projects_accounts_access. --- # aiven_organization (Resource) -Creates and manages an organization in Aiven. +Creates and manages an [organization](https://aiven.io/docs/platform/concepts/projects_accounts_access). ## Example Usage ```terraform -resource "aiven_organization" "organization1" { - name = "" +resource "aiven_organization" "main" { + name = "Example organization" } ``` @@ -32,8 +32,8 @@ resource "aiven_organization" "organization1" { ### Read-Only - `create_time` (String) Timestamp of the creation of the organization. -- `id` (String) Identifier of the organization. -- `tenant_id` (String) Tenant identifier of the organization. +- `id` (String) ID of the organization. +- `tenant_id` (String) Tenant ID of the organization. - `update_time` (String) Timestamp of the last update of the organization. @@ -51,5 +51,5 @@ Optional: Import is supported using the following syntax: ```shell -terraform import aiven_organization.organization1 organization_id +terraform import aiven_organization.main ORGANIZATION_ID ``` diff --git a/docs/resources/organization_application_user.md b/docs/resources/organization_application_user.md index 5aa712efd..a8945e702 100644 --- a/docs/resources/organization_application_user.md +++ b/docs/resources/organization_application_user.md @@ -3,12 +3,17 @@ page_title: "aiven_organization_application_user Resource - terraform-provider-aiven" subcategory: "" description: |- - Creates and manages an organization application user. Application users can be used for programmatic access to the platform. This features is in the limited availability stage. Contact sales@aiven.io to try this feature. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDERAIVENENABLE_BETA environment variable. + Creates and manages an organization application user. Application users can be used for programmatic access to the platform. This features is in the limited availability stage. Contact sales@aiven.io to try this feature. + This resource is in beta and may change without notice. To use this resource, + set the PROVIDER_AIVEN_ENABLE_BETA environment variable to true. --- # aiven_organization_application_user (Resource) -Creates and manages an organization application user. Application users can be used for programmatic access to the platform. This features is in the limited availability stage. Contact sales@aiven.io to try this feature. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable. +Creates and manages an organization application user. Application users can be used for programmatic access to the platform. This features is in the limited availability stage. Contact sales@aiven.io to try this feature. + +**This resource is in beta and may change without notice.** To use this resource, +set the `PROVIDER_AIVEN_ENABLE_BETA` environment variable to true. diff --git a/docs/resources/organization_application_user_token.md b/docs/resources/organization_application_user_token.md index 25efa1411..e55a958ef 100644 --- a/docs/resources/organization_application_user_token.md +++ b/docs/resources/organization_application_user_token.md @@ -3,12 +3,17 @@ page_title: "aiven_organization_application_user_token Resource - terraform-provider-aiven" subcategory: "" description: |- - Creates and manages an organization application user token in Aiven. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDERAIVENENABLE_BETA environment variable. + Creates and manages an organization application user token in Aiven. + This resource is in beta and may change without notice. To use this resource, + set the PROVIDER_AIVEN_ENABLE_BETA environment variable to true. --- # aiven_organization_application_user_token (Resource) -Creates and manages an organization application user token in Aiven. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable. +Creates and manages an organization application user token in Aiven. + +**This resource is in beta and may change without notice.** To use this resource, +set the `PROVIDER_AIVEN_ENABLE_BETA` environment variable to true. diff --git a/docs/resources/organization_group_project.md b/docs/resources/organization_group_project.md index f004c4464..c72f21ada 100644 --- a/docs/resources/organization_group_project.md +++ b/docs/resources/organization_group_project.md @@ -3,14 +3,35 @@ page_title: "aiven_organization_group_project Resource - terraform-provider-aiven" subcategory: "" description: |- - Adds and manages a group of users as members of a project. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDERAIVENENABLE_BETA environment variable. + Adds and manages a group https://aiven.io/docs/platform/concepts/projects_accounts_access#groups + of users as members of a project https://aiven.io/docs/platform/reference/project-member-privileges. + This resource is in beta and may change without notice. To use this resource, + set the PROVIDER_AIVEN_ENABLE_BETA environment variable to true. --- # aiven_organization_group_project (Resource) -Adds and manages a group of users as members of a project. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable. +Adds and manages a [group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups) + of users as [members of a project](https://aiven.io/docs/platform/reference/project-member-privileges). +**This resource is in beta and may change without notice.** To use this resource, +set the `PROVIDER_AIVEN_ENABLE_BETA` environment variable to true. +## Example Usage + +```terraform +resource "aiven_organization_user_group" "example" { + description = "Example group of users." + organization_id = aiven_organization.main.id + name = "Example group" +} + +resource "aiven_organization_user_group_project" "example" { + group_id = aiven_organization_user_group.example.group_id + project = aiven_project.example.project + role = "admin" +} +``` ## Schema @@ -19,7 +40,7 @@ Adds and manages a group of users as members of a project. Please note that this - `group_id` (String) The ID of the user group. - `project` (String) The project that the users in the group are members of. -- `role` (String) Role assigned to the users in the group for the project. +- `role` (String) Role assigned to all users in the group for the project. ### Optional @@ -27,7 +48,7 @@ Adds and manages a group of users as members of a project. Please note that this ### Read-Only -- `id` (String) Compound identifier of the organization group project relation. +- `id` (String) A compound identifier of the resource in the format `project/group_id`. ### Nested Schema for `timeouts` @@ -38,3 +59,11 @@ Optional: - `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. - `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled. - `update` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). + +## Import + +Import is supported using the following syntax: + +```shell +terraform import aiven_organization_group_project.example PROJECT/USER_GROUP_ID +``` diff --git a/docs/resources/organization_user.md b/docs/resources/organization_user.md index e747ee676..47fe77bcc 100644 --- a/docs/resources/organization_user.md +++ b/docs/resources/organization_user.md @@ -3,7 +3,7 @@ page_title: "aiven_organization_user Resource - terraform-provider-aiven" subcategory: "" description: |- - **This resource is deprecated**. Use the aiven_organization_user data source instead. + **This resource is deprecated**. Use the `aiven_organization_user` data source instead. The organization user resource allows the creation and management of an Aiven organization user. During the creation of aiven_organization_userresource, an email invitation will be sent @@ -15,7 +15,7 @@ description: |- # aiven_organization_user (Resource) -**This resource is deprecated**. Use the aiven_organization_user data source instead. +**This resource is deprecated**. Use the `aiven_organization_user` data source instead. The organization user resource allows the creation and management of an Aiven organization user. @@ -32,8 +32,8 @@ eliminate the member from the organization if one has accepted an invitation pre ### Required -- `organization_id` (String) The unique organization ID. This property cannot be changed, doing so forces recreation of the resource. -- `user_email` (String) This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. This property cannot be changed, doing so forces recreation of the resource. +- `organization_id` (String) The unique organization ID. Changing this property forces recreation of the resource. +- `user_email` (String) This is a user email address that first will be invited, and after accepting an invitation, they become a member of the organization. Should be lowercase. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/organization_user_group.md b/docs/resources/organization_user_group.md index 4d0518524..a96d19bd4 100644 --- a/docs/resources/organization_user_group.md +++ b/docs/resources/organization_user_group.md @@ -3,26 +3,34 @@ page_title: "aiven_organization_user_group Resource - terraform-provider-aiven" subcategory: "" description: |- - Creates and manages a user group in an organization. + Creates and manages a user group https://aiven.io/docs/platform/concepts/projects_accounts_access#groups in an organization. --- # aiven_organization_user_group (Resource) -Creates and manages a user group in an organization. +Creates and manages a [user group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups) in an organization. +## Example Usage +```terraform +resource "aiven_organization_user_group" "example" { + description = "Example group of users." + organization_id = aiven_organization.main.id + name = "Example group" +} +``` ## Schema ### Required -- `description` (String) The description of the user group. This property cannot be changed, doing so forces recreation of the resource. -- `organization_id` (String) The ID of the organization. This property cannot be changed, doing so forces recreation of the resource. +- `description` (String) The description of the user group. Changing this property forces recreation of the resource. +- `organization_id` (String) The ID of the organization. Changing this property forces recreation of the resource. ### Optional -- `name` (String) The name of the user group. This property cannot be changed, doing so forces recreation of the resource. +- `name` (String) The name of the user group. Changing this property forces recreation of the resource. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) ### Read-Only @@ -42,3 +50,11 @@ Optional: - `delete` (String) - `read` (String) - `update` (String) + +## Import + +Import is supported using the following syntax: + +```shell +terraform import aiven_organization_user_group.example ORGANIZATION_ID/USER_GROUP_ID +``` diff --git a/docs/resources/organization_user_group_member.md b/docs/resources/organization_user_group_member.md index 8f4a6f322..50c1c7ff9 100644 --- a/docs/resources/organization_user_group_member.md +++ b/docs/resources/organization_user_group_member.md @@ -3,23 +3,42 @@ page_title: "aiven_organization_user_group_member Resource - terraform-provider-aiven" subcategory: "" description: |- - Adds and manages users in a user group. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDERAIVENENABLE_BETA environment variable. + Adds and manages users in a user group https://aiven.io/docs/platform/concepts/projects_accounts_access#groups. + This resource is in beta and may change without notice. To use this resource, + set the PROVIDER_AIVEN_ENABLE_BETA environment variable to true. --- # aiven_organization_user_group_member (Resource) -Adds and manages users in a user group. Please note that this resource is in beta and may change without notice. To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable. +Adds and manages users in a [user group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups). +**This resource is in beta and may change without notice.** To use this resource, +set the `PROVIDER_AIVEN_ENABLE_BETA` environment variable to true. +## Example Usage + +```terraform +resource "aiven_organization_user_group" "example" { + description = "Example group of users." + organization_id = aiven_organization.main.id + name = "Example group" +} + +resource "aiven_organization_user_group_member" "project_admin" { + group_id = aiven_organization_user_group.example.group_id + organization_id = aiven_organization.main.id + user_id = "u123a456b7890c" +} +``` ## Schema ### Required -- `group_id` (String) Identifier of the organization user group. -- `organization_id` (String) Identifier of the organization. -- `user_id` (String) Identifier of the organization user group member. +- `group_id` (String) The ID of the user group. +- `organization_id` (String) The ID of the organization. +- `user_id` (String) The ID of the organization user. ### Optional @@ -27,7 +46,7 @@ Adds and manages users in a user group. Please note that this resource is in bet ### Read-Only -- `id` (String) Compound identifier of the organization user group member. +- `id` (String) A compound identifier of the group member in the format `organization_id/group_id/user_id`. - `last_activity_time` (String) Last activity time of the user group member. @@ -39,3 +58,11 @@ Optional: - `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. - `read` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled. - `update` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). + +## Import + +Import is supported using the following syntax: + +```shell +terraform import aiven_organization_user_group_member.project_admin ORGANIZATION_ID/USER_GROUP_ID/USER_ID +``` diff --git a/docs/resources/pg.md b/docs/resources/pg.md index dc653ba83..72865cc20 100644 --- a/docs/resources/pg.md +++ b/docs/resources/pg.md @@ -56,7 +56,7 @@ resource "aiven_pg" "pg" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/pg_database.md b/docs/resources/pg_database.md index c6ecdf243..6017ac095 100644 --- a/docs/resources/pg_database.md +++ b/docs/resources/pg_database.md @@ -25,14 +25,14 @@ resource "aiven_pg_database" "mydatabase" { ### Required -- `database_name` (String) The name of the service 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. +- `database_name` (String) The name of the service 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. ### Optional -- `lc_collate` (String) Default string sort order (`LC_COLLATE`) of the database. The default value is `en_US.UTF-8`. This property cannot be changed, doing so forces recreation of the resource. -- `lc_ctype` (String) Default character classification (`LC_CTYPE`) of the database. The default value is `en_US.UTF-8`. This property cannot be changed, doing so forces recreation of the resource. +- `lc_collate` (String) Default string sort order (`LC_COLLATE`) of the database. The default value is `en_US.UTF-8`. Changing this property forces recreation of the resource. +- `lc_ctype` (String) Default character classification (`LC_CTYPE`) of the database. The default value is `en_US.UTF-8`. Changing this property forces recreation of the resource. - `termination_protection` (Boolean) It is a Terraform client-side deletion protections, which prevents the database from being deleted by Terraform. It is recommended to enable this for any production databases containing critical data. The default value is `false`. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) diff --git a/docs/resources/pg_user.md b/docs/resources/pg_user.md index db2f4f04b..c78a0cb2b 100644 --- a/docs/resources/pg_user.md +++ b/docs/resources/pg_user.md @@ -26,9 +26,9 @@ resource "aiven_pg_user" "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. -- `username` (String) The actual name of the PG 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 PG User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional diff --git a/docs/resources/project.md b/docs/resources/project.md index 4598d6958..f9b3a3019 100644 --- a/docs/resources/project.md +++ b/docs/resources/project.md @@ -13,10 +13,9 @@ The Project resource allows the creation and management of Aiven Projects. ## Example Usage ```terraform -resource "aiven_project" "myproject" { - project = "" - card_id = "" - account_id = aiven_account_team..account_id +resource "aiven_project" "example_project" { + project = "Example project" + parent_id = aiven_organization.main.id } ``` diff --git a/docs/resources/project_user.md b/docs/resources/project_user.md index 27dba8360..6326e93f6 100644 --- a/docs/resources/project_user.md +++ b/docs/resources/project_user.md @@ -25,9 +25,9 @@ resource "aiven_project_user" "mytestuser" { ### Required -- `email` (String) Email address of the user. Should be lowercase. This property cannot be changed, doing so forces recreation of the resource. +- `email` (String) Email address of the user. Should be lowercase. Changing this property forces recreation of the resource. - `member_type` (String) Project membership type. The possible values are `admin`, `developer` and `operator`. -- `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. ### Optional diff --git a/docs/resources/project_vpc.md b/docs/resources/project_vpc.md index 22b76af1d..568f21fb5 100644 --- a/docs/resources/project_vpc.md +++ b/docs/resources/project_vpc.md @@ -29,9 +29,9 @@ resource "aiven_project_vpc" "myvpc" { ### Required -- `cloud_name` (String) Defines where the cloud provider and region where the service is hosted in. See the Service resource for additional information. This property cannot be changed, doing so forces recreation of the resource. +- `cloud_name` (String) Defines where the cloud provider and region where the service is hosted in. See the Service resource for additional information. Changing this property forces recreation of the resource. - `network_cidr` (String) Network address range used by the VPC like 192.168.0.0/24 -- `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. ### Optional diff --git a/docs/resources/redis.md b/docs/resources/redis.md index a274d5758..db1dfb1c4 100644 --- a/docs/resources/redis.md +++ b/docs/resources/redis.md @@ -37,7 +37,7 @@ resource "aiven_redis" "redis1" { ### Required - `plan` (String) Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are `hobbyist`, `startup-x`, `business-x` and `premium-x` where `x` is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the [Aiven pricing page](https://aiven.io/pricing). -- `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. ### Optional diff --git a/docs/resources/redis_user.md b/docs/resources/redis_user.md index 9d4d50158..297e17292 100644 --- a/docs/resources/redis_user.md +++ b/docs/resources/redis_user.md @@ -26,17 +26,17 @@ resource "aiven_redis_user" "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. -- `username` (String) The actual name of the Redis 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 Redis User. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional - `password` (String, Sensitive) The password of the Redis User. -- `redis_acl_categories` (List of String) Defines command category rules. The field is required with`redis_acl_commands` and `redis_acl_keys`. This property cannot be changed, doing so forces recreation of the resource. -- `redis_acl_channels` (List of String) Defines the permitted pub/sub channel patterns. This property cannot be changed, doing so forces recreation of the resource. -- `redis_acl_commands` (List of String) Defines rules for individual commands. The field is required with`redis_acl_categories` and `redis_acl_keys`. This property cannot be changed, doing so forces recreation of the resource. -- `redis_acl_keys` (List of String) Defines key access rules. The field is required with`redis_acl_categories` and `redis_acl_keys`. This property cannot be changed, doing so forces recreation of the resource. +- `redis_acl_categories` (List of String) Defines command category rules. The field is required with`redis_acl_commands` and `redis_acl_keys`. Changing this property forces recreation of the resource. +- `redis_acl_channels` (List of String) Defines the permitted pub/sub channel patterns. Changing this property forces recreation of the resource. +- `redis_acl_commands` (List of String) Defines rules for individual commands. The field is required with`redis_acl_categories` and `redis_acl_keys`. Changing this property forces recreation of the resource. +- `redis_acl_keys` (List of String) Defines key access rules. The field is required with`redis_acl_categories` and `redis_acl_keys`. Changing this property forces recreation of the resource. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) ### Read-Only diff --git a/docs/resources/static_ip.md b/docs/resources/static_ip.md index ffdcfd6d6..51013e7e5 100644 --- a/docs/resources/static_ip.md +++ b/docs/resources/static_ip.md @@ -17,8 +17,8 @@ The aiven_static_ip resource allows the creation and deletion of static ips. Ple ### Required -- `cloud_name` (String) Specifies the cloud that the static ip belongs to. 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. +- `cloud_name` (String) Specifies the cloud that the static ip belongs to. 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. ### Optional diff --git a/docs/resources/transit_gateway_vpc_attachment.md b/docs/resources/transit_gateway_vpc_attachment.md index 72a2d3d28..8abc6acea 100644 --- a/docs/resources/transit_gateway_vpc_attachment.md +++ b/docs/resources/transit_gateway_vpc_attachment.md @@ -29,10 +29,10 @@ resource "aiven_transit_gateway_vpc_attachment" "attachment" { ### Required -- `peer_cloud_account` (String) AWS account ID or GCP project ID of the peered VPC. This property cannot be changed, doing so forces recreation of the resource. -- `peer_vpc` (String) Transit gateway ID. This property cannot be changed, doing so forces recreation of the resource. +- `peer_cloud_account` (String) AWS account ID or GCP project ID of the peered VPC. Changing this property forces recreation of the resource. +- `peer_vpc` (String) Transit gateway ID. Changing this property forces recreation of the resource. - `user_peer_network_cidrs` (Set of String) List of private IPv4 ranges to route through the peering connection -- `vpc_id` (String) The VPC the peering connection 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. +- `vpc_id` (String) The VPC the peering connection belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource. ### Optional diff --git a/examples/data-sources/aiven_organization/data-source.tf b/examples/data-sources/aiven_organization/data-source.tf index aab38ca0c..79c113b98 100644 --- a/examples/data-sources/aiven_organization/data-source.tf +++ b/examples/data-sources/aiven_organization/data-source.tf @@ -1,3 +1,3 @@ -data "aiven_organization" "organization1" { - name = "" +data "aiven_organization" "main" { + name = "Example organization" } \ No newline at end of file diff --git a/examples/data-sources/aiven_organization_user_group/data-source.tf b/examples/data-sources/aiven_organization_user_group/data-source.tf new file mode 100644 index 000000000..6ef3dacba --- /dev/null +++ b/examples/data-sources/aiven_organization_user_group/data-source.tf @@ -0,0 +1,4 @@ +data "aiven_organization_user_group" "example" { + name = "Example group" + organization_id = aiven_organization.main.id +} \ No newline at end of file diff --git a/examples/resources/aiven_organization/import.sh b/examples/resources/aiven_organization/import.sh index 5c5592dc3..2d932168d 100644 --- a/examples/resources/aiven_organization/import.sh +++ b/examples/resources/aiven_organization/import.sh @@ -1 +1 @@ -terraform import aiven_organization.organization1 organization_id +terraform import aiven_organization.main ORGANIZATION_ID diff --git a/examples/resources/aiven_organization/resource.tf b/examples/resources/aiven_organization/resource.tf index 2f526dfcd..9a368e5c0 100644 --- a/examples/resources/aiven_organization/resource.tf +++ b/examples/resources/aiven_organization/resource.tf @@ -1,3 +1,3 @@ -resource "aiven_organization" "organization1" { - name = "" +resource "aiven_organization" "main" { + name = "Example organization" } \ No newline at end of file diff --git a/examples/resources/aiven_organization_group_project/import.sh b/examples/resources/aiven_organization_group_project/import.sh new file mode 100644 index 000000000..24a1209ef --- /dev/null +++ b/examples/resources/aiven_organization_group_project/import.sh @@ -0,0 +1 @@ +terraform import aiven_organization_group_project.example PROJECT/USER_GROUP_ID diff --git a/examples/resources/aiven_organization_group_project/resource copy.tf b/examples/resources/aiven_organization_group_project/resource copy.tf new file mode 100644 index 000000000..3486c5f14 --- /dev/null +++ b/examples/resources/aiven_organization_group_project/resource copy.tf @@ -0,0 +1,16 @@ +resource "aiven_project" "example_project" { + project = "Example project" + parent_id = aiven_organization.main.id +} + +resource "aiven_organization_user_group" "example" { + description = "Example group of users." + organization_id = aiven_organization.main.id + name = "Example group" +} + +resource "aiven_organization_user_group_member" "project_admin" { + group_id = aiven_organization_user_group.example.group_id + organization_id = aiven_organization.main.id + user_id = "u123a456b7890c" +} \ No newline at end of file diff --git a/examples/resources/aiven_organization_group_project/resource.tf b/examples/resources/aiven_organization_group_project/resource.tf new file mode 100644 index 000000000..2c556eeab --- /dev/null +++ b/examples/resources/aiven_organization_group_project/resource.tf @@ -0,0 +1,12 @@ + +resource "aiven_organization_user_group" "example" { + description = "Example group of users." + organization_id = aiven_organization.main.id + name = "Example group" +} + +resource "aiven_organization_user_group_project" "example" { + group_id = aiven_organization_user_group.example.group_id + project = aiven_project.example.project + role = "admin" +} \ No newline at end of file diff --git a/examples/resources/aiven_organization_user_group/import.sh b/examples/resources/aiven_organization_user_group/import.sh new file mode 100644 index 000000000..df08e71b1 --- /dev/null +++ b/examples/resources/aiven_organization_user_group/import.sh @@ -0,0 +1 @@ +terraform import aiven_organization_user_group.example ORGANIZATION_ID/USER_GROUP_ID diff --git a/examples/resources/aiven_organization_user_group/resource.tf b/examples/resources/aiven_organization_user_group/resource.tf new file mode 100644 index 000000000..3db3c5459 --- /dev/null +++ b/examples/resources/aiven_organization_user_group/resource.tf @@ -0,0 +1,5 @@ +resource "aiven_organization_user_group" "example" { + description = "Example group of users." + organization_id = aiven_organization.main.id + name = "Example group" +} \ No newline at end of file diff --git a/examples/resources/aiven_organization_user_group_member/import.sh b/examples/resources/aiven_organization_user_group_member/import.sh new file mode 100644 index 000000000..25eb28840 --- /dev/null +++ b/examples/resources/aiven_organization_user_group_member/import.sh @@ -0,0 +1 @@ +terraform import aiven_organization_user_group_member.project_admin ORGANIZATION_ID/USER_GROUP_ID/USER_ID diff --git a/examples/resources/aiven_organization_user_group_member/resource.tf b/examples/resources/aiven_organization_user_group_member/resource.tf new file mode 100644 index 000000000..180f7050f --- /dev/null +++ b/examples/resources/aiven_organization_user_group_member/resource.tf @@ -0,0 +1,11 @@ +resource "aiven_organization_user_group" "example" { + description = "Example group of users." + organization_id = aiven_organization.main.id + name = "Example group" +} + +resource "aiven_organization_user_group_member" "project_admin" { + group_id = aiven_organization_user_group.example.group_id + organization_id = aiven_organization.main.id + user_id = "u123a456b7890c" +} \ No newline at end of file diff --git a/examples/resources/aiven_project/resource.tf b/examples/resources/aiven_project/resource.tf index e7685fdfa..6e4ffdf0e 100644 --- a/examples/resources/aiven_project/resource.tf +++ b/examples/resources/aiven_project/resource.tf @@ -1,5 +1,4 @@ -resource "aiven_project" "myproject" { - project = "" - card_id = "" - account_id = aiven_account_team..account_id +resource "aiven_project" "example_project" { + project = "Example project" + parent_id = aiven_organization.main.id } diff --git a/internal/plugin/service/organization/organization_data_source.go b/internal/plugin/service/organization/organization_data_source.go index 723e6a287..730312523 100644 --- a/internal/plugin/service/organization/organization_data_source.go +++ b/internal/plugin/service/organization/organization_data_source.go @@ -72,10 +72,10 @@ func (r *organizationDataSource) Schema( resp *datasource.SchemaResponse, ) { resp.Schema = schema.Schema{ - Description: "Retrieves information about an organization from Aiven.", + Description: "Gets information about an organization.", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ - Description: "Identifier of the organization.", + Description: "ID of the organization.", Optional: true, }, "name": schema.StringAttribute{ @@ -83,7 +83,7 @@ func (r *organizationDataSource) Schema( Optional: true, }, "tenant_id": schema.StringAttribute{ - Description: "Tenant identifier of the organization.", + Description: "Tenant ID of the organization.", Computed: true, }, "create_time": schema.StringAttribute{ diff --git a/internal/plugin/service/organization/organization_group_project.go b/internal/plugin/service/organization/organization_group_project.go index cbdb4b7a0..16d9005f6 100644 --- a/internal/plugin/service/organization/organization_group_project.go +++ b/internal/plugin/service/organization/organization_group_project.go @@ -78,11 +78,12 @@ func (r *organizationGroupProjectResource) Schema( resp *resource.SchemaResponse) { resp.Schema = util.GeneralizeSchema(ctx, schema.Schema{ Description: util.BetaDescription( - "Adds and manages a group of users as members of a project.", + `Adds and manages a [group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups) + of users as [members of a project](https://aiven.io/docs/platform/reference/project-member-privileges).`, ), Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ - Description: "Compound identifier of the organization group project relation.", + Description: "A compound identifier of the resource in the format `project/group_id`.", Computed: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.UseStateForUnknown(), @@ -103,7 +104,7 @@ func (r *organizationGroupProjectResource) Schema( }, }, "role": schema.StringAttribute{ - Description: "Role assigned to the users in the group for the project.", + Description: "Role assigned to all users in the group for the project.", Required: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.RequiresReplace(), diff --git a/internal/plugin/service/organization/organization_resource.go b/internal/plugin/service/organization/organization_resource.go index ea7fa5a18..01afad5fe 100644 --- a/internal/plugin/service/organization/organization_resource.go +++ b/internal/plugin/service/organization/organization_resource.go @@ -73,10 +73,10 @@ func (r *organizationResource) TypeName() string { // Schema defines the schema for the organization resource. func (r *organizationResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) { resp.Schema = util.GeneralizeSchema(ctx, schema.Schema{ - Description: "Creates and manages an organization in Aiven.", + Description: "Creates and manages an [organization](https://aiven.io/docs/platform/concepts/projects_accounts_access).", Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ - Description: "Identifier of the organization.", + Description: "ID of the organization.", Computed: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.UseStateForUnknown(), @@ -87,7 +87,7 @@ func (r *organizationResource) Schema(ctx context.Context, _ resource.SchemaRequ Required: true, }, "tenant_id": schema.StringAttribute{ - Description: "Tenant identifier of the organization.", + Description: "Tenant ID of the organization.", Computed: true, }, "create_time": schema.StringAttribute{ diff --git a/internal/plugin/service/organization/organization_user_group_member.go b/internal/plugin/service/organization/organization_user_group_member.go index 55edf7612..e08c68b8a 100644 --- a/internal/plugin/service/organization/organization_user_group_member.go +++ b/internal/plugin/service/organization/organization_user_group_member.go @@ -76,31 +76,31 @@ func (r *organizationUserGroupMembersResource) Schema( resp *resource.SchemaResponse, ) { resp.Schema = util.GeneralizeSchema(ctx, schema.Schema{ - Description: util.BetaDescription("Adds and manages users in a user group."), + Description: util.BetaDescription("Adds and manages users in a [user group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups)."), Attributes: map[string]schema.Attribute{ "id": schema.StringAttribute{ - Description: "Compound identifier of the organization user group member.", + Description: "A compound identifier of the group member in the format `organization_id/group_id/user_id`.", Computed: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.UseStateForUnknown(), }, }, "organization_id": schema.StringAttribute{ - Description: "Identifier of the organization.", + Description: "The ID of the organization.", Required: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.RequiresReplace(), }, }, "group_id": schema.StringAttribute{ - Description: "Identifier of the organization user group.", + Description: "The ID of the user group.", Required: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.RequiresReplace(), }, }, "user_id": schema.StringAttribute{ - Description: "Identifier of the organization user group member.", + Description: "The ID of the organization user.", Required: true, PlanModifiers: []planmodifier.String{ stringplanmodifier.RequiresReplace(), diff --git a/internal/plugin/util/pluginhelpers.go b/internal/plugin/util/pluginhelpers.go index e120293d9..15d35de03 100644 --- a/internal/plugin/util/pluginhelpers.go +++ b/internal/plugin/util/pluginhelpers.go @@ -27,8 +27,11 @@ func ComposeID(parts ...string) string { // BetaDescription is a helper function that returns a description for beta resources. func BetaDescription(description string) string { - return description + " Please note that this resource is in beta and may change without notice. " + - "To use this resource, please set the PROVIDER_AIVEN_ENABLE_BETA environment variable." + return description + ` + +**This resource is in beta and may change without notice.** To use this resource, +set the ` + "`PROVIDER_AIVEN_ENABLE_BETA`" + ` environment variable to true. +` } // ValueOrDefault returns the value if not nil, otherwise returns the default value. Value is converted to type diff --git a/internal/schemautil/userconfig/desc.go b/internal/schemautil/userconfig/desc.go index b1633d7da..671af57f1 100644 --- a/internal/schemautil/userconfig/desc.go +++ b/internal/schemautil/userconfig/desc.go @@ -130,7 +130,7 @@ func (db *DescriptionBuilder) Build() string { if db.withForceNew { builder.WriteRune(' ') - builder.WriteString("This property cannot be changed, doing so forces recreation of the resource.") + builder.WriteString("Changing this property forces recreation of the resource.") } return builder.String() diff --git a/internal/sdkprovider/service/organization/organization_user.go b/internal/sdkprovider/service/organization/organization_user.go index ce64c8c8a..46679df01 100644 --- a/internal/sdkprovider/service/organization/organization_user.go +++ b/internal/sdkprovider/service/organization/organization_user.go @@ -57,7 +57,7 @@ var aivenOrganizationUserSchema = map[string]*schema.Schema{ func ResourceOrganizationUser() *schema.Resource { return &schema.Resource{ Description: ` - **This resource is deprecated**. Use the aiven_organization_user data source instead. + **This resource is deprecated**. Use the ` + "`aiven_organization_user`" + ` data source instead. The organization user resource allows the creation and management of an Aiven organization user. diff --git a/internal/sdkprovider/service/organization/organization_user_group.go b/internal/sdkprovider/service/organization/organization_user_group.go index b423d9e64..abbae921d 100644 --- a/internal/sdkprovider/service/organization/organization_user_group.go +++ b/internal/sdkprovider/service/organization/organization_user_group.go @@ -48,7 +48,7 @@ var aivenOrganizationUserGroupSchema = map[string]*schema.Schema{ func ResourceOrganizationUserGroup() *schema.Resource { return &schema.Resource{ - Description: "Creates and manages a user group in an organization.", + Description: "Creates and manages a [user group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups) in an organization.", CreateContext: resourceOrganizationUserGroupCreate, ReadContext: resourceOrganizationUserGroupRead, UpdateContext: resourceOrganizationUserGroupUpdate, diff --git a/internal/sdkprovider/service/organization/organization_user_group_data_source.go b/internal/sdkprovider/service/organization/organization_user_group_data_source.go index 8b24171fe..a69fe9183 100644 --- a/internal/sdkprovider/service/organization/organization_user_group_data_source.go +++ b/internal/sdkprovider/service/organization/organization_user_group_data_source.go @@ -13,7 +13,7 @@ import ( func DatasourceOrganizationUserGroup() *schema.Resource { return &schema.Resource{ ReadContext: datasourceOrganizationUserGroupRead, - Description: "Provides information about an existing user group in an organization.", + Description: "Gets information about an existing user group in an organization.", Schema: schemautil.ResourceSchemaAsDatasourceSchema( aivenOrganizationUserGroupSchema, "organization_id", "name", ),