Skip to content

Commit b960dac

Browse files
committed
Add documentation for resources
1 parent 4dd4e45 commit b960dac

File tree

4 files changed

+200
-0
lines changed

4 files changed

+200
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_aws_oidc_configuration"
4+
description: |-
5+
Manages AWS OIDC configurations.
6+
---
7+
8+
# tfe_aws_oidc_configuration
9+
10+
Defines an AWS OIDC configuration resource.
11+
12+
~> **NOTE:** Hold your own key is available on the HCP Terraform Premium edition. Refer to [HCP Terraform pricing](https://www.hashicorp.com/en/pricing?product_intent=terraform&tab=terraform) for details.
13+
14+
## Example Usage
15+
16+
Basic usage:
17+
18+
```hcl
19+
resource "tfe_aws_oidc_configuration" "example" {
20+
role_arn = "arn:aws:iam::111111111111:role/example-role-arn"
21+
organization = "my-org-name"
22+
}
23+
```
24+
25+
26+
## Argument Reference
27+
28+
The following arguments are supported:
29+
30+
* `role_arn` - (Required) The AWS ARN of your role..
31+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
32+
33+
## Attributes Reference
34+
35+
In addition to all arguments above, the following attributes are exported:
36+
37+
* `id` - The AWS OIDC configuration ID.
38+
39+
## Import
40+
AWS OIDC configurations can be imported by ID.
41+
42+
Example:
43+
44+
```shell
45+
terraform import tfe_aws_oidc_configuration.example awsoidc-DXmy3B2emVHysnbq
46+
```
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_azure_oidc_configuration"
4+
description: |-
5+
Manages Azure OIDC configurations.
6+
---
7+
8+
# tfe_azure_oidc_configuration
9+
10+
Defines an Azure OIDC configuration resource.
11+
12+
~> **NOTE:** Hold your own key is available on the HCP Terraform Premium edition. Refer to [HCP Terraform pricing](https://www.hashicorp.com/en/pricing?product_intent=terraform&tab=terraform) for details.
13+
14+
## Example Usage
15+
16+
Basic usage:
17+
18+
```hcl
19+
resource "tfe_azure_oidc_configuration" "example" {
20+
client_id = "application-id1"
21+
subscription_id = "subscription-id1"
22+
tenant_id = "tenant-id1"
23+
organization = "my-org-name"
24+
}
25+
```
26+
27+
28+
## Argument Reference
29+
30+
The following arguments are supported:
31+
32+
* `client_id` - (Required) The Client (or Application) ID of your Entra ID application.
33+
* `subscription_id` - (Required) The ID of your Azure subscription.
34+
* `tenant_id` - (Required) The Tenant (or Directory) ID of your Entra ID application.
35+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
36+
37+
## Attributes Reference
38+
39+
In addition to all arguments above, the following attributes are exported:
40+
41+
* `id` - The Azure OIDC configuration ID.
42+
43+
## Import
44+
Azure OIDC configurations can be imported by ID.
45+
46+
Example:
47+
48+
```shell
49+
terraform import tfe_azure_oidc_configuration.example azoidc-8DCgwEV2GbMcQjk8
50+
```
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_gcp_oidc_configuration"
4+
description: |-
5+
Manages GCP OIDC configurations.
6+
---
7+
8+
# tfe_gcp_oidc_configuration
9+
10+
Defines a GCP OIDC configuration resource.
11+
12+
~> **NOTE:** Hold your own key is available on the HCP Terraform Premium edition. Refer to [HCP Terraform pricing](https://www.hashicorp.com/en/pricing?product_intent=terraform&tab=terraform) for details.
13+
14+
## Example Usage
15+
16+
Basic usage:
17+
18+
```hcl
19+
resource "tfe_gcp_oidc_configuration" "example" {
20+
service_account_email = "[email protected]"
21+
project_number = "11111111"
22+
workload_provider_name = "projects/1/locations/global/workloadIdentityPools/1/providers/1"
23+
organization = "my-org-name"
24+
}
25+
```
26+
27+
28+
## Argument Reference
29+
30+
The following arguments are supported:
31+
32+
* `service_account_email` - (Required) The email of your GCP service account, with permissions to encrypt and decrypt using a Cloud KMS key.
33+
* `project_number` - (Required) The GCP Project containing the workload provider and service account.
34+
* `workload_provider_name` - (Required) The fully qualified workload provider path. This should be in the format `projects/{project_number}/locations/global/workloadIdentityPools/{workload_identity_pool_id}/providers/{workload_identity_pool_provider_id}`.
35+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
36+
37+
## Attributes Reference
38+
39+
In addition to all arguments above, the following attributes are exported:
40+
41+
* `id` - The GCP OIDC configuration ID.
42+
43+
## Import
44+
GCP OIDC configurations can be imported by ID.
45+
46+
Example:
47+
48+
```shell
49+
terraform import tfe_gcp_oidc_configuration.example gcpoidc-PuXEeRoSaK3ENGj9
50+
```
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: "tfe"
3+
page_title: "Terraform Enterprise: tfe_vault_oidc_configuration"
4+
description: |-
5+
Manages Vault OIDC configurations.
6+
---
7+
8+
# tfe_vault_oidc_configuration
9+
10+
Defines a Vault OIDC configuration resource.
11+
12+
~> **NOTE:** Hold your own key is available on the HCP Terraform Premium edition. Refer to [HCP Terraform pricing](https://www.hashicorp.com/en/pricing?product_intent=terraform&tab=terraform) for details.
13+
14+
## Example Usage
15+
16+
Basic usage:
17+
18+
```hcl
19+
resource "tfe_vault_oidc_configuration" "example" {
20+
address = "https://my-vault-cluster-public-vault-659decf3.b8298d98.z1.hashicorp.cloud:8200"
21+
role_name = "vault-role-name"
22+
namespace = "admin"
23+
auth_path = "jwt-auth-path"
24+
encoded_cacert = null
25+
organization = "my-org-name"
26+
}
27+
```
28+
29+
30+
## Argument Reference
31+
32+
The following arguments are supported:
33+
34+
* `address` - (Required) The full address of your Vault instance.
35+
* `role_name` - (Required) The name of a role in your Vault JWT auth path, with permission to encrypt and decrypt with a Transit secrets engine key.
36+
* `namespace` - (Required) The mounting path of JWT auth path of JWT auth. Defaults to `"jwt"`.
37+
* `auth_path` - (Required) The Tenant (or Directory) ID of your Entra ID application.
38+
* `encoded_cacert` - (Optional) A base64 encoded certificate which can be used to authenticate your Vault certificate. Only needed for self-hosted Vault Enterprise instances with a self-signed certificate.
39+
* `organization` - (Optional) Name of the organization. If omitted, organization must be defined in the provider config.
40+
41+
## Attributes Reference
42+
43+
In addition to all arguments above, the following attributes are exported:
44+
45+
* `id` - The Vault OIDC configuration ID.
46+
47+
## Import
48+
Vault OIDC configurations can be imported by ID.
49+
50+
Example:
51+
52+
```shell
53+
terraform import tfe_vault_oidc_configuration.example voidc-AV61VxigiRvkkvPd
54+
```

0 commit comments

Comments
 (0)