Skip to content

Commit d20a0ce

Browse files
committed
ran make doc
1 parent 5670205 commit d20a0ce

3 files changed

Lines changed: 12 additions & 12 deletions

File tree

docs/data-sources/environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Retrieve data for a single environment
2222

2323
### Read-Only
2424

25-
- `connection_id` (Number) A connection ID (used with Global Connections)
25+
- `connection_id` (Number) The ID of the connection to use (can be the `id` of a `dbtcloud_global_connection` or the `connection_id` of a legacy connection). At the moment, it is optional and the environment will use the connection set in `dbtcloud_project_connection` if `connection_id` is not set in this resource. In future versions this field will become required, so it is recommended to set it from now on. When configuring this field, it needs to be configured for all the environments of the project. To avoid Terraform state issues, when using this field, the `dbtcloud_project_connection` resource should be removed from the project or you need to make sure that the `connection_id` is the same in `dbtcloud_project_connection` and in the `connection_id` of the Development environment of the project
2626
- `credentials_id` (Number) Credential ID for this environment. A credential is not required for development environments, as dbt Cloud defaults to the user's credentials, but deployment environments will have this.
2727
- `custom_branch` (String) The custom branch name to use
2828
- `dbt_version` (String) Version number of dbt to use in this environment.

docs/data-sources/environments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Retrieve data for multiple environments
2929
Read-Only:
3030

3131
- `connection_id` (Number) A connection ID (used with Global Connections)
32-
- `credentials_id` (Number) Credential ID to create the environment with. A credential is not required for development environments but is required for deployment environments
32+
- `credentials_id` (Number) Credential ID for this environment. A credential is not required for development environments, as dbt Cloud defaults to the user's credentials, but deployment environments will have this.
3333
- `custom_branch` (String) The custom branch name to use
3434
- `dbt_version` (String) Version number of dbt to use in this environment.
3535
- `deployment_type` (String) The type of deployment environment (currently 'production', 'staging' or empty)

docs/resources/environment.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
page_title: "dbtcloud_environment Resource - dbtcloud"
33
subcategory: ""
44
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.
66
---
77

88
# dbtcloud_environment (Resource)
99

1010

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.
1212

1313
## Example Usage
1414

@@ -50,25 +50,25 @@ resource "dbtcloud_environment" "dev_environment" {
5050
### Required
5151

5252
- `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)
5555

5656
### Optional
5757

5858
- `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.
6060
- `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.
6464
- `extended_attributes_id` (Number) The ID of the extended attributes applied
6565
- `is_active` (Boolean) Whether the environment is active
6666
- `use_custom_branch` (Boolean) Whether to use a custom git branch in this environment
6767

6868
### Read-Only
6969

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.
7272

7373
## Import
7474

0 commit comments

Comments
 (0)