|
2 | 2 | page_title: "dbtcloud_environment Resource - dbtcloud" |
3 | 3 | subcategory: "" |
4 | 4 | description: |- |
5 | | - Retrieve data for a single environment |
| 5 | + Resource to manage dbt Cloud environments for the different dbt Cloud projects. In a given dbt Cloud project, one development environment can be defined and as many deployment environments as needed can be created. ~> In August 2024, dbt Cloud released the "global connection" feature, allowing connections to be defined at the account level and reused across environments and projects. This version of the provider has the connection_id as an optional field but it is recommended to start setting it up in your projects. In future versions, this field will become mandatory. |
6 | 6 | --- |
7 | 7 |
|
8 | 8 | # dbtcloud_environment (Resource) |
9 | 9 |
|
10 | 10 |
|
11 | | -Retrieve data for a single environment |
| 11 | +Resource to manage dbt Cloud environments for the different dbt Cloud projects. In a given dbt Cloud project, one development environment can be defined and as many deployment environments as needed can be created. ~> In August 2024, dbt Cloud released the "global connection" feature, allowing connections to be defined at the account level and reused across environments and projects. This version of the provider has the connection_id as an optional field but it is recommended to start setting it up in your projects. In future versions, this field will become mandatory. |
12 | 12 |
|
13 | 13 | ## Example Usage |
14 | 14 |
|
@@ -50,25 +50,25 @@ resource "dbtcloud_environment" "dev_environment" { |
50 | 50 | ### Required |
51 | 51 |
|
52 | 52 | - `name` (String) The name of the environment |
53 | | -- `project_id` (Number) (Number) Project ID to create the environment in |
54 | | -- `type` (String) (String) The type of environment (must be either development or deployment) |
| 53 | +- `project_id` (Number) Project ID to create the environment in |
| 54 | +- `type` (String) The type of environment (must be either development or deployment) |
55 | 55 |
|
56 | 56 | ### Optional |
57 | 57 |
|
58 | 58 | - `connection_id` (Number) A connection ID (used with Global Connections) |
59 | | -- `credential_id` (Number) The project ID to which the environment belong |
| 59 | +- `credential_id` (Number) The project ID to which the environment belongs. |
60 | 60 | - `custom_branch` (String) The custom branch name to use |
61 | | -- `dbt_version` (String) (String) Version number of dbt to use in this environment. It needs to be in the format `major.minor.0-latest` (e.g. `1.5.0-latest`), `major.minor.0-pre`, `versionless`, or `latest`. While `versionless` is still supported, using `latest` is recommended. Defaults to `latest` if no version is provided |
62 | | -- `deployment_type` (String) (String) The type of environment. Only valid for environments of type 'deployment' and for now can only be 'production', 'staging' or left empty for generic environments |
63 | | -- `enable_model_query_history` (Boolean) (Boolean) Whether to enable model query history in this environment. As of Oct 2024, works only for Snowflake and BigQuery. |
| 61 | +- `dbt_version` (String) Version number of dbt to use in this environment. It needs to be in the format `major.minor.0-latest` (e.g. `1.5.0-latest`), `major.minor.0-pre`, `versionless`, or `latest`. While `versionless` is still supported, using `latest` is recommended. Defaults to `latest` if no version is provided |
| 62 | +- `deployment_type` (String) The type of environment. Only valid for environments of type 'deployment' and for now can only be 'production', 'staging' or left empty for generic environments |
| 63 | +- `enable_model_query_history` (Boolean) Whether to enable model query history in this environment. As of Oct 2024, works only for Snowflake and BigQuery. |
64 | 64 | - `extended_attributes_id` (Number) The ID of the extended attributes applied |
65 | 65 | - `is_active` (Boolean) Whether the environment is active |
66 | 66 | - `use_custom_branch` (Boolean) Whether to use a custom git branch in this environment |
67 | 67 |
|
68 | 68 | ### Read-Only |
69 | 69 |
|
70 | | -- `environment_id` (Number) The ID of the environment |
71 | | -- `id` (String) The ID of the license map |
| 70 | +- `environment_id` (Number) The ID of the environment. Duplicated. Here for backward compatibility. |
| 71 | +- `id` (String) The ID of environment. |
72 | 72 |
|
73 | 73 | ## Import |
74 | 74 |
|
|
0 commit comments