Skip to content

channel.md

Latest commit

 

History

History
80 lines (56 loc) · 2.52 KB

channel.md

File metadata and controls

80 lines (56 loc) · 2.52 KB
Raw
page_title octopusdeploy_channel Resource - terraform-provider-octopusdeploy
subcategory
description This resource manages channels in Octopus Deploy.

octopusdeploy_channel (Resource)

This resource manages channels in Octopus Deploy.

Example Usage

resource "octopusdeploy_channel" "example" {
  name       = "Development Channel (OK to Delete)"
  project_id = "Projects-123"
}

Schema

Required

  • name (String) The name of this resource.
  • project_id (String) The project ID associated with this channel.

Optional

  • custom_field_definitions (Attributes List) A list of custom field definitions for this channel. Maximum of 10. (see below for nested schema)
  • description (String) The description of this channel.
  • ephemeral_environment_name_template (String) The name template for ephemeral environments created from this channel.
  • is_default (Boolean) Indicates whether this is the default channel for the associated project.
  • lifecycle_id (String) The lifecycle ID associated with this channel.
  • parent_environment_id (String) The parent environment ID for ephemeral environments.
  • rule (Block List) A list of rules associated with this channel. (see below for nested schema)
  • space_id (String) The space ID associated with this channel.
  • tenant_tags (Set of String) A set of tenant tags associated with this channel.
  • type (String) The type of channel. Valid values are "Lifecycle" or "EphemeralEnvironment". Defaults to "Lifecycle".

Read-Only

  • id (String) The unique ID for this resource.

Nested Schema for custom_field_definitions

Required:

  • description (String) The description of the custom field.
  • field_name (String) The name of the custom field.

Nested Schema for rule

Optional:

  • action_package (Block List) (see below for nested schema)
  • id (String) The ID associated with this channel rule.
  • tag (String)
  • version_range (String)

Nested Schema for rule.action_package

Optional:

  • deployment_action (String)
  • package_reference (String)

Import

Import is supported using the following syntax:

terraform import [options] octopusdeploy_channel.<name> <channel-id>