-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add LA note and update app users
- Loading branch information
1 parent
3acf177
commit e4d4c9a
Showing
14 changed files
with
136 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,24 +3,36 @@ | |
page_title: "aiven_organization_application_user Data Source - terraform-provider-aiven" | ||
subcategory: "" | ||
description: |- | ||
Retrieves information about an organization application user from Aiven. | ||
Gets information about an application user. | ||
This data source is in the limited availability stage and may change without notice. To enable this feature, contact the sales team mailto:[email protected]. After it's enabled, set | ||
the PROVIDER_AIVEN_ENABLE_BETA environment variable to use the data source. | ||
--- | ||
|
||
# aiven_organization_application_user (Data Source) | ||
|
||
Retrieves information about an organization application user from Aiven. | ||
Gets information about an application user. | ||
|
||
**This data source is in the limited availability stage and may change without notice.** To enable this feature, contact the [sales team](mailto:[email protected]). After it's enabled, set | ||
the `PROVIDER_AIVEN_ENABLE_BETA` environment variable to use the data source. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "aiven_organization_application_user" "tf_user" { | ||
organization_id = aiven_organization.main.id | ||
user_id = "u123a456b7890c" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `organization_id` (String) Identifier of the organization the application user belongs to. | ||
- `user_id` (String) Identifier of the organization application user. | ||
- `organization_id` (String) The ID of the organization the application user belongs to. | ||
- `user_id` (String) The ID of the application user. | ||
|
||
### Read-Only | ||
|
||
- `email` (String) Email of the organization application user. | ||
- `name` (String) Name of the organization application user. | ||
- `email` (String) The auto-generated email address of the application user. | ||
- `name` (String) Name of the application user. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,38 +3,45 @@ | |
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 resource is in the limited availability stage and may change without notice. | ||
To enable this feature, contact the sales team mailto:[email protected]. After it's enabled, set | ||
Creates and manages an organization application user. Application users https://aiven.io/docs/platform/howto/manage-application-users can be used for programmatic access to the platform. | ||
This resource is in the limited availability stage and may change without notice. To enable this feature, contact the sales team mailto:[email protected]. After it's enabled, set | ||
the PROVIDER_AIVEN_ENABLE_BETA environment variable to use the resource. | ||
--- | ||
|
||
# aiven_organization_application_user (Resource) | ||
|
||
Creates and manages an organization application user. Application users can be used for programmatic access to the platform. | ||
**This resource is in the limited availability stage and may change without notice.** | ||
To enable this feature, contact the [sales team](mailto:[email protected]). After it's enabled, set | ||
Creates and manages an organization application user. [Application users](https://aiven.io/docs/platform/howto/manage-application-users) can be used for programmatic access to the platform. | ||
|
||
**This resource is in the limited availability stage and may change without notice.** To enable this feature, contact the [sales team](mailto:[email protected]). After it's enabled, set | ||
the `PROVIDER_AIVEN_ENABLE_BETA` environment variable to use the resource. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "aiven_organization_application_user" "tf_user" { | ||
organization_id = aiven_organization.main.id | ||
name = "app-terraform" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `name` (String) Name of the organization application user. | ||
- `organization_id` (String) Identifier of the organization the application user belongs to. | ||
- `name` (String) Name of the application user. | ||
- `organization_id` (String) The ID of the organization the application user belongs to. | ||
|
||
### Optional | ||
|
||
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) | ||
|
||
### Read-Only | ||
|
||
- `email` (String) Email of the organization application user. | ||
- `id` (String) Compound identifier of the organization application user. | ||
- `user_id` (String) Identifier of the organization application user. | ||
- `email` (String) An email address automatically generated by Aiven to help identify the application user. | ||
No notifications are sent to this email. | ||
- `id` (String) A compound identifier of the resource in the format `organization_id/user_id`. | ||
- `user_id` (String) The ID of the application user. | ||
|
||
<a id="nestedblock--timeouts"></a> | ||
### Nested Schema for `timeouts` | ||
|
@@ -45,3 +52,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_application_user.example ORGANIZATION_ID/USER_ID | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
examples/data-sources/aiven_organization_application_user/data-source.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
data "aiven_organization_application_user" "tf_user" { | ||
organization_id = aiven_organization.main.id | ||
user_id = "u123a456b7890c" | ||
} |
1 change: 1 addition & 0 deletions
1
examples/resources/aiven_organization_application_user/import.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
terraform import aiven_organization_application_user.example ORGANIZATION_ID/USER_ID |
4 changes: 4 additions & 0 deletions
4
examples/resources/aiven_organization_application_user/resource.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
resource "aiven_organization_application_user" "tf_user" { | ||
organization_id = aiven_organization.main.id | ||
name = "app-terraform" | ||
} |
1 change: 1 addition & 0 deletions
1
examples/resources/aiven_organization_application_user_token/import.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
terraform import aiven_organization_application_user_token.example ORGANIZATION_ID/USER_ID/TOKEN_PREFIX |
10 changes: 10 additions & 0 deletions
10
examples/resources/aiven_organization_application_user_token/resource.tf
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
resource "aiven_organization_application_user" "tf_user" { | ||
organization_id = aiven_organization.main.id | ||
name = "app-terraform" | ||
} | ||
|
||
resource "aiven_organization_application_user_token" "example" { | ||
organization_id = aiven_organization.main.id | ||
user_id = aiven_organization_application_user.tf_user.user_id | ||
description = "Token for TF access to Aiven." | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.