Skip to content

Commit

Permalink
Add import docs and clean up docs for all resources and data sources (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
deanhuynh authored Mar 6, 2024
1 parent 2a0ff4d commit cb557be
Show file tree
Hide file tree
Showing 55 changed files with 567 additions and 63 deletions.
4 changes: 2 additions & 2 deletions docs/data-sources/destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_destination Data Source - terraform-provider-segment"
subcategory: ""
description: |-
The destination
Reads a Destination. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/.
---

# segment_destination (Data Source)

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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/destination_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_destination_metadata Data Source - terraform-provider-segment"
subcategory: ""
description: |-
The destination metadata
Reads a Destination metadata. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/catalog/.
---

# segment_destination_metadata (Data Source)

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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/role.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_role Data Source - terraform-provider-segment"
subcategory: ""
description: |-
Reads a Role. For more information, visit the Segment docs https://segment.com/docs/segment-app/iam/roles/.
---

# segment_role (Data Source)


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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/source.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_source Data Source - terraform-provider-segment"
subcategory: ""
description: |-
Reads a Source. For more information, visit the Segment docs https://segment.com/docs/connections/sources/.
---

# segment_source (Data Source)


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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/source_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_source_metadata Data Source - terraform-provider-segment"
subcategory: ""
description: |-
The source metadata
Reads a Source metadata. For more information, visit the Segment docs https://segment.com/docs/connections/sources/catalog/.
---

# segment_source_metadata (Data Source)

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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/tracking_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_tracking_plan Data Source - terraform-provider-segment"
subcategory: ""
description: |-
Configures a Tracking Plan. For more information, visit the Segment docs https://segment.com/docs/protocols/tracking-plan/create/.
---

# segment_tracking_plan (Data Source)


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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_user Data Source - terraform-provider-segment"
subcategory: ""
description: |-
A user belonging to a Segment Workspace.
Reads a user. For more information, visit the Segment docs https://segment.com/docs/segment-app/iam/concepts/#team-members.
---

# segment_user (Data Source)

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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/warehouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_warehouse Data Source - terraform-provider-segment"
subcategory: ""
description: |-
The warehouse
Configures a Warehouse. For more information, visit the Segment docs https://segment.com/docs/connections/storage/.
---

# segment_warehouse (Data Source)

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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/warehouse_metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_warehouse_metadata Data Source - terraform-provider-segment"
subcategory: ""
description: |-
The warehouse metadata
Reads a Warehouse metadata. For more information, visit the Segment docs https://segment.com/docs/connections/storage/catalog/.
---

# segment_warehouse_metadata (Data Source)

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

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/workspace.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "segment_workspace Data Source - terraform-provider-segment"
subcategory: ""
description: |-
The Workspace.
Reads the Workspace.
---

# segment_workspace (Data Source)

The Workspace.
Reads the Workspace.

## Example Usage

Expand Down
28 changes: 28 additions & 0 deletions docs/resources/destination.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,40 @@
page_title: "segment_destination Resource - terraform-provider-segment"
subcategory: ""
description: |-
Configures a Destination. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/.
Import
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <id>. For example:
terraform
import {
to = segment_destination.example
id = "<id>"
}
Otherwise, use terraform import with <id>. For example:
console
terraform import segment_destination.example <id>
---

# segment_destination (Resource)

Configures a Destination. For more information, visit the [Segment docs](https://segment.com/docs/connections/destinations/).

## Import

In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<id>`. For example:

```terraform
import {
to = segment_destination.example
id = "<id>"
}
```

Otherwise, use `terraform import` with `<id>`. For example:

```console
terraform import segment_destination.example <id>
```

## Example Usage

Expand Down
35 changes: 30 additions & 5 deletions docs/resources/destination_filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,40 @@
page_title: "segment_destination_filter Resource - terraform-provider-segment"
subcategory: ""
description: |-
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.
To import a Destination filter into Terraform, use the following format: 'destination-id:filter-id'
Configures a filter for a destination. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/destination-filters/.
Import
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:
terraform
import {
to = segment_destination_filter.example
id = "<destination_id>:<filter_id>"
}
Otherwise, use terraform import with <destination_id>:<filter_id>. For example:
console
terraform import segment_destination_filter.example <destination_id>:<filter_id>
---

# segment_destination_filter (Resource)

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.

To import a Destination filter into Terraform, use the following format: 'destination-id:filter-id'
Configures a filter for a destination. For more information, visit the [Segment docs](https://segment.com/docs/connections/destinations/destination-filters/).

## Import

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:

```terraform
import {
to = segment_destination_filter.example
id = "<destination_id>:<filter_id>"
}
```

Otherwise, use `terraform import` with `<destination_id>:<filter_id>`. For example:

```console
terraform import segment_destination_filter.example <destination_id>:<filter_id>
```

## Example Usage

Expand Down
28 changes: 28 additions & 0 deletions docs/resources/destination_subscription.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,40 @@
page_title: "segment_destination_subscription Resource - terraform-provider-segment"
subcategory: ""
description: |-
Configures a Destination subscription to an action. For more information, visit the Segment docs https://segment.com/docs/connections/destinations/actions/.
Import
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <id>. For example:
terraform
import {
to = segment_destination_subscription.example
id = "<id>"
}
Otherwise, use terraform import with <id>. For example:
console
terraform import segment_destination_subscription.example <id>
---

# segment_destination_subscription (Resource)

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

## Import

In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<id>`. For example:

```terraform
import {
to = segment_destination_subscription.example
id = "<id>"
}
```

Otherwise, use `terraform import` with `<id>`. For example:

```console
terraform import segment_destination_subscription.example <id>
```

## Example Usage

Expand Down
32 changes: 30 additions & 2 deletions docs/resources/function.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,40 @@
page_title: "segment_function Resource - terraform-provider-segment"
subcategory: ""
description: |-
The function
Configures a Function. For more information, visit the Segment docs https://segment.com/docs/connections/functions/.
Import
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <id>. For example:
terraform
import {
to = segment_function.example
id = "<id>"
}
Otherwise, use terraform import with <id>. For example:
console
terraform import segment_function.example <id>
---

# segment_function (Resource)

The function
Configures a Function. For more information, visit the [Segment docs](https://segment.com/docs/connections/functions/).

## Import

In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<id>`. For example:

```terraform
import {
to = segment_function.example
id = "<id>"
}
```

Otherwise, use `terraform import` with `<id>`. For example:

```console
terraform import segment_function.example <id>
```

## Example Usage

Expand Down
28 changes: 28 additions & 0 deletions docs/resources/insert_function_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,40 @@
page_title: "segment_insert_function_instance Resource - terraform-provider-segment"
subcategory: ""
description: |-
Configures an Insert Function. For more information, visit the Segment docs https://segment.com/docs/connections/functions/insert-functions/.
Import
In Terraform v1.5.0 and later, use an import block https://developer.hashicorp.com/terraform/language/import with <id>. For example:
terraform
import {
to = segment_insert_function_instance.example
id = "<id>"
}
Otherwise, use terraform import with <id>. For example:
console
terraform import segment_insert_function_instance.example <id>
---

# segment_insert_function_instance (Resource)

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

## Import

In Terraform v1.5.0 and later, use an [import block](https://developer.hashicorp.com/terraform/language/import) with `<id>`. For example:

```terraform
import {
to = segment_insert_function_instance.example
id = "<id>"
}
```

Otherwise, use `terraform import` with `<id>`. For example:

```console
terraform import segment_insert_function_instance.example <id>
```

## Example Usage

Expand Down
Loading

0 comments on commit cb557be

Please sign in to comment.