Skip to content

Commit cb557be

Browse files
deanhuynhdeanhuynh
authored
Add import docs and clean up docs for all resources and data sources (#97)
1 parent 2a0ff4d commit cb557be

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+567
-63
lines changed

‎docs/data-sources/destination.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_destination Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
The destination
6+
Reads a Destination. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/.
77
---
88

99
# segment_destination (Data Source)
1010

11-
The destination
11+
Reads a Destination. For more information, visit the [Segment docs](https://segment.com/docs/connections/destinations/).
1212

1313
## Example Usage
1414

‎docs/data-sources/destination_metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_destination_metadata Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
The destination metadata
6+
Reads a Destination metadata. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/catalog/.
77
---
88

99
# segment_destination_metadata (Data Source)
1010

11-
The destination metadata
11+
Reads a Destination metadata. For more information, visit the [Segment docs](https://segment.com/docs/connections/destinations/catalog/).
1212

1313
## Example Usage
1414

‎docs/data-sources/role.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_role Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
6+
Reads a Role. For more information, visit the Segment docs https://segment.com/docs/segment-app/iam/roles/.
77
---
88

99
# segment_role (Data Source)
1010

11-
11+
Reads a Role. For more information, visit the [Segment docs](https://segment.com/docs/segment-app/iam/roles/).
1212

1313
## Example Usage
1414

‎docs/data-sources/source.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_source Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
6+
Reads a Source. For more information, visit the Segment docs https://segment.com/docs/connections/sources/.
77
---
88

99
# segment_source (Data Source)
1010

11-
11+
Reads a Source. For more information, visit the [Segment docs](https://segment.com/docs/connections/sources/).
1212

1313
## Example Usage
1414

‎docs/data-sources/source_metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_source_metadata Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
The source metadata
6+
Reads a Source metadata. For more information, visit the Segment docs https://segment.com/docs/connections/sources/catalog/.
77
---
88

99
# segment_source_metadata (Data Source)
1010

11-
The source metadata
11+
Reads a Source metadata. For more information, visit the [Segment docs](https://segment.com/docs/connections/sources/catalog/).
1212

1313
## Example Usage
1414

‎docs/data-sources/tracking_plan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_tracking_plan Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
6+
Configures a Tracking Plan. For more information, visit the Segment docs https://segment.com/docs/protocols/tracking-plan/create/.
77
---
88

99
# segment_tracking_plan (Data Source)
1010

11-
11+
Configures a Tracking Plan. For more information, visit the [Segment docs](https://segment.com/docs/protocols/tracking-plan/create/).
1212

1313
## Example Usage
1414

‎docs/data-sources/user.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_user Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
A user belonging to a Segment Workspace.
6+
Reads a user. For more information, visit the Segment docs https://segment.com/docs/segment-app/iam/concepts/#team-members.
77
---
88

99
# segment_user (Data Source)
1010

11-
A user belonging to a Segment Workspace.
11+
Reads a user. For more information, visit the [Segment docs](https://segment.com/docs/segment-app/iam/concepts/#team-members).
1212

1313
## Example Usage
1414

‎docs/data-sources/warehouse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_warehouse Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
The warehouse
6+
Configures a Warehouse. For more information, visit the Segment docs https://segment.com/docs/connections/storage/.
77
---
88

99
# segment_warehouse (Data Source)
1010

11-
The warehouse
11+
Configures a Warehouse. For more information, visit the [Segment docs](https://segment.com/docs/connections/storage/).
1212

1313
## Example Usage
1414

‎docs/data-sources/warehouse_metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_warehouse_metadata Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
The warehouse metadata
6+
Reads a Warehouse metadata. For more information, visit the Segment docs https://segment.com/docs/connections/storage/catalog/.
77
---
88

99
# segment_warehouse_metadata (Data Source)
1010

11-
The warehouse metadata
11+
Reads a Warehouse metadata. For more information, visit the [Segment docs](https://segment.com/docs/connections/storage/catalog/).
1212

1313
## Example Usage
1414

‎docs/data-sources/workspace.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "segment_workspace Data Source - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
The Workspace.
6+
Reads the Workspace.
77
---
88

99
# segment_workspace (Data Source)
1010

11-
The Workspace.
11+
Reads the Workspace.
1212

1313
## Example Usage
1414

‎docs/resources/destination.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,40 @@
33
page_title: "segment_destination Resource - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6+
Configures a Destination. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/.
7+
Import
8+
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <id>. For example:
9+
terraform
10+
import {
11+
to = segment_destination.example
12+
id = "<id>"
13+
}
614
15+
Otherwise, use terraform import with <id>. For example:
16+
console
17+
terraform import segment_destination.example <id>
718
---
819

920
# segment_destination (Resource)
1021

22+
Configures a Destination. For more information, visit the [Segment docs](https://segment.com/docs/connections/destinations/).
23+
24+
## Import
25+
26+
In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<id>`. For example:
1127

28+
```terraform
29+
import {
30+
to = segment_destination.example
31+
id = "<id>"
32+
}
33+
```
34+
35+
Otherwise, use `terraform import` with `<id>`. For example:
36+
37+
```console
38+
terraform import segment_destination.example <id>
39+
```
1240

1341
## Example Usage
1442

‎docs/resources/destination_filter.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,40 @@
33
page_title: "segment_destination_filter Resource - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
Destination filters let you send or block events, properties, and user traits from reaching a destination. Enabled filters are applied on every matching event in transit to this destination.
7-
To import a Destination filter into Terraform, use the following format: 'destination-id:filter-id'
6+
Configures a filter for a destination. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/destination-filters/.
7+
Import
8+
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <destination_id>:<filter_id>. For example:
9+
terraform
10+
import {
11+
to = segment_destination_filter.example
12+
id = "<destination_id>:<filter_id>"
13+
}
14+
15+
Otherwise, use terraform import with <destination_id>:<filter_id>. For example:
16+
console
17+
terraform import segment_destination_filter.example <destination_id>:<filter_id>
818
---
919

1020
# segment_destination_filter (Resource)
1121

12-
Destination filters let you send or block events, properties, and user traits from reaching a destination. Enabled filters are applied on every matching event in transit to this destination.
13-
14-
To import a Destination filter into Terraform, use the following format: 'destination-id:filter-id'
22+
Configures a filter for a destination. For more information, visit the [Segment docs](https://segment.com/docs/connections/destinations/destination-filters/).
23+
24+
## Import
25+
26+
In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<destination_id>:<filter_id>`. For example:
27+
28+
```terraform
29+
import {
30+
to = segment_destination_filter.example
31+
id = "<destination_id>:<filter_id>"
32+
}
33+
```
34+
35+
Otherwise, use `terraform import` with `<destination_id>:<filter_id>`. For example:
36+
37+
```console
38+
terraform import segment_destination_filter.example <destination_id>:<filter_id>
39+
```
1540

1641
## Example Usage
1742

‎docs/resources/destination_subscription.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,40 @@
33
page_title: "segment_destination_subscription Resource - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6+
Configures a Destination subscription to an action. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/actions/.
7+
Import
8+
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <id>. For example:
9+
terraform
10+
import {
11+
to = segment_destination_subscription.example
12+
id = "<id>"
13+
}
614
15+
Otherwise, use terraform import with <id>. For example:
16+
console
17+
terraform import segment_destination_subscription.example <id>
718
---
819

920
# segment_destination_subscription (Resource)
1021

22+
Configures a Destination subscription to an action. For more information, visit the [Segment docs](https://segment.com/docs/connections/destinations/actions/).
1123

24+
## Import
25+
26+
In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<id>`. For example:
27+
28+
```terraform
29+
import {
30+
to = segment_destination_subscription.example
31+
id = "<id>"
32+
}
33+
```
34+
35+
Otherwise, use `terraform import` with `<id>`. For example:
36+
37+
```console
38+
terraform import segment_destination_subscription.example <id>
39+
```
1240

1341
## Example Usage
1442

‎docs/resources/function.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,40 @@
33
page_title: "segment_function Resource - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6-
The function
6+
Configures a Function. For more information, visit the Segment docs https://segment.com/docs/connections/functions/.
7+
Import
8+
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <id>. For example:
9+
terraform
10+
import {
11+
to = segment_function.example
12+
id = "<id>"
13+
}
14+
15+
Otherwise, use terraform import with <id>. For example:
16+
console
17+
terraform import segment_function.example <id>
718
---
819

920
# segment_function (Resource)
1021

11-
The function
22+
Configures a Function. For more information, visit the [Segment docs](https://segment.com/docs/connections/functions/).
23+
24+
## Import
25+
26+
In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<id>`. For example:
27+
28+
```terraform
29+
import {
30+
to = segment_function.example
31+
id = "<id>"
32+
}
33+
```
34+
35+
Otherwise, use `terraform import` with `<id>`. For example:
36+
37+
```console
38+
terraform import segment_function.example <id>
39+
```
1240

1341
## Example Usage
1442

‎docs/resources/insert_function_instance.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,40 @@
33
page_title: "segment_insert_function_instance Resource - terraform-provider-segment"
44
subcategory: ""
55
description: |-
6+
Configures an Insert Function. For more information, visit the Segment docs https://segment.com/docs/connections/functions/insert-functions/.
7+
Import
8+
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <id>. For example:
9+
terraform
10+
import {
11+
to = segment_insert_function_instance.example
12+
id = "<id>"
13+
}
614
15+
Otherwise, use terraform import with <id>. For example:
16+
console
17+
terraform import segment_insert_function_instance.example <id>
718
---
819

920
# segment_insert_function_instance (Resource)
1021

22+
Configures an Insert Function. For more information, visit the [Segment docs](https://segment.com/docs/connections/functions/insert-functions/).
1123

24+
## Import
25+
26+
In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<id>`. For example:
27+
28+
```terraform
29+
import {
30+
to = segment_insert_function_instance.example
31+
id = "<id>"
32+
}
33+
```
34+
35+
Otherwise, use `terraform import` with `<id>`. For example:
36+
37+
```console
38+
terraform import segment_insert_function_instance.example <id>
39+
```
1240

1341
## Example Usage
1442

0 commit comments

Comments
 (0)