Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. Space
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.Space

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages spaces in Octopus Deploy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as octopusdeploy from "@pulumi/octopusdeploy";

const example = new octopusdeploy.Space("example", {
    description: "A space for the development team.",
    isDefault: false,
    isTaskQueueStopped: false,
    spaceManagersTeamMembers: [
        "Users-123",
        "Users-321",
    ],
    spaceManagersTeams: ["teams-everyone"],
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

example = octopusdeploy.Space("example",
    description="A space for the development team.",
    is_default=False,
    is_task_queue_stopped=False,
    space_managers_team_members=[
        "Users-123",
        "Users-321",
    ],
    space_managers_teams=["teams-everyone"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.NewSpace(ctx, "example", &octopusdeploy.SpaceArgs{
			Description:        pulumi.String("A space for the development team."),
			IsDefault:          pulumi.Bool(false),
			IsTaskQueueStopped: pulumi.Bool(false),
			SpaceManagersTeamMembers: pulumi.StringArray{
				pulumi.String("Users-123"),
				pulumi.String("Users-321"),
			},
			SpaceManagersTeams: pulumi.StringArray{
				pulumi.String("teams-everyone"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Octopusdeploy = Pulumi.Octopusdeploy;

return await Deployment.RunAsync(() => 
{
    var example = new Octopusdeploy.Space("example", new()
    {
        Description = "A space for the development team.",
        IsDefault = false,
        IsTaskQueueStopped = false,
        SpaceManagersTeamMembers = new[]
        {
            "Users-123",
            "Users-321",
        },
        SpaceManagersTeams = new[]
        {
            "teams-everyone",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.Space;
import com.pulumi.octopusdeploy.SpaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Space("example", SpaceArgs.builder()
            .description("A space for the development team.")
            .isDefault(false)
            .isTaskQueueStopped(false)
            .spaceManagersTeamMembers(            
                "Users-123",
                "Users-321")
            .spaceManagersTeams("teams-everyone")
            .build());

    }
}

    resources:
  example:
    type: octopusdeploy:Space
    properties:
      description: A space for the development team.
      isDefault: false
      isTaskQueueStopped: false
      spaceManagersTeamMembers:
        - Users-123
        - Users-321
      spaceManagersTeams:
        - teams-everyone

    Create Space Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Space(name: string, args?: SpaceArgs, opts?: CustomResourceOptions);
    @overload
def Space(resource_name: str,
          args: Optional[SpaceArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Space(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          is_default: Optional[bool] = None,
          is_task_queue_stopped: Optional[bool] = None,
          name: Optional[str] = None,
          slug: Optional[str] = None,
          space_managers_team_members: Optional[Sequence[str]] = None,
          space_managers_teams: Optional[Sequence[str]] = None)
    func NewSpace(ctx *Context, name string, args *SpaceArgs, opts ...ResourceOption) (*Space, error)
    public Space(string name, SpaceArgs? args = null, CustomResourceOptions? opts = null)
    public Space(String name, SpaceArgs args)
public Space(String name, SpaceArgs args, CustomResourceOptions options)

    type: octopusdeploy:Space
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SpaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SpaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SpaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SpaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SpaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var spaceResource = new Octopusdeploy.Space("spaceResource", new()
{
    Description = "string",
    IsDefault = false,
    IsTaskQueueStopped = false,
    Name = "string",
    Slug = "string",
    SpaceManagersTeamMembers = new[]
    {
        "string",
    },
    SpaceManagersTeams = new[]
    {
        "string",
    },
});

    example, err := octopusdeploy.NewSpace(ctx, "spaceResource", &octopusdeploy.SpaceArgs{
	Description:        pulumi.String("string"),
	IsDefault:          pulumi.Bool(false),
	IsTaskQueueStopped: pulumi.Bool(false),
	Name:               pulumi.String("string"),
	Slug:               pulumi.String("string"),
	SpaceManagersTeamMembers: pulumi.StringArray{
		pulumi.String("string"),
	},
	SpaceManagersTeams: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var spaceResource = new Space("spaceResource", SpaceArgs.builder()
    .description("string")
    .isDefault(false)
    .isTaskQueueStopped(false)
    .name("string")
    .slug("string")
    .spaceManagersTeamMembers("string")
    .spaceManagersTeams("string")
    .build());

    space_resource = octopusdeploy.Space("spaceResource",
    description="string",
    is_default=False,
    is_task_queue_stopped=False,
    name="string",
    slug="string",
    space_managers_team_members=["string"],
    space_managers_teams=["string"])

    const spaceResource = new octopusdeploy.Space("spaceResource", {
    description: "string",
    isDefault: false,
    isTaskQueueStopped: false,
    name: "string",
    slug: "string",
    spaceManagersTeamMembers: ["string"],
    spaceManagersTeams: ["string"],
});

    type: octopusdeploy:Space
properties:
    description: string
    isDefault: false
    isTaskQueueStopped: false
    name: string
    slug: string
    spaceManagersTeamMembers:
        - string
    spaceManagersTeams:
        - string

    Space Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Space resource accepts the following input properties:

    Description string
    The description of this space.
    IsDefault bool
    Specifies if this space is the default space in Octopus.
    IsTaskQueueStopped bool
    Specifies the status of the task queue for this space.
    Name string
    The name of this resource.
    Slug string
    The unique slug of this space
    SpaceManagersTeamMembers List<string>
    A list of user IDs designated to be managers of this space.
    SpaceManagersTeams List<string>
    A list of team IDs designated to be managers of this space.
    Description string
    The description of this space.
    IsDefault bool
    Specifies if this space is the default space in Octopus.
    IsTaskQueueStopped bool
    Specifies the status of the task queue for this space.
    Name string
    The name of this resource.
    Slug string
    The unique slug of this space
    SpaceManagersTeamMembers []string
    A list of user IDs designated to be managers of this space.
    SpaceManagersTeams []string
    A list of team IDs designated to be managers of this space.
    description String
    The description of this space.
    isDefault Boolean
    Specifies if this space is the default space in Octopus.
    isTaskQueueStopped Boolean
    Specifies the status of the task queue for this space.
    name String
    The name of this resource.
    slug String
    The unique slug of this space
    spaceManagersTeamMembers List<String>
    A list of user IDs designated to be managers of this space.
    spaceManagersTeams List<String>
    A list of team IDs designated to be managers of this space.
    description string
    The description of this space.
    isDefault boolean
    Specifies if this space is the default space in Octopus.
    isTaskQueueStopped boolean
    Specifies the status of the task queue for this space.
    name string
    The name of this resource.
    slug string
    The unique slug of this space
    spaceManagersTeamMembers string[]
    A list of user IDs designated to be managers of this space.
    spaceManagersTeams string[]
    A list of team IDs designated to be managers of this space.
    description str
    The description of this space.
    is_default bool
    Specifies if this space is the default space in Octopus.
    is_task_queue_stopped bool
    Specifies the status of the task queue for this space.
    name str
    The name of this resource.
    slug str
    The unique slug of this space
    space_managers_team_members Sequence[str]
    A list of user IDs designated to be managers of this space.
    space_managers_teams Sequence[str]
    A list of team IDs designated to be managers of this space.
    description String
    The description of this space.
    isDefault Boolean
    Specifies if this space is the default space in Octopus.
    isTaskQueueStopped Boolean
    Specifies the status of the task queue for this space.
    name String
    The name of this resource.
    slug String
    The unique slug of this space
    spaceManagersTeamMembers List<String>
    A list of user IDs designated to be managers of this space.
    spaceManagersTeams List<String>
    A list of team IDs designated to be managers of this space.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Space resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Space Resource

    Get an existing Space resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SpaceState, opts?: CustomResourceOptions): Space
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        is_default: Optional[bool] = None,
        is_task_queue_stopped: Optional[bool] = None,
        name: Optional[str] = None,
        slug: Optional[str] = None,
        space_managers_team_members: Optional[Sequence[str]] = None,
        space_managers_teams: Optional[Sequence[str]] = None) -> Space
    func GetSpace(ctx *Context, name string, id IDInput, state *SpaceState, opts ...ResourceOption) (*Space, error)
    public static Space Get(string name, Input<string> id, SpaceState? state, CustomResourceOptions? opts = null)
    public static Space get(String name, Output<String> id, SpaceState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:Space    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of this space.
    IsDefault bool
    Specifies if this space is the default space in Octopus.
    IsTaskQueueStopped bool
    Specifies the status of the task queue for this space.
    Name string
    The name of this resource.
    Slug string
    The unique slug of this space
    SpaceManagersTeamMembers List<string>
    A list of user IDs designated to be managers of this space.
    SpaceManagersTeams List<string>
    A list of team IDs designated to be managers of this space.
    Description string
    The description of this space.
    IsDefault bool
    Specifies if this space is the default space in Octopus.
    IsTaskQueueStopped bool
    Specifies the status of the task queue for this space.
    Name string
    The name of this resource.
    Slug string
    The unique slug of this space
    SpaceManagersTeamMembers []string
    A list of user IDs designated to be managers of this space.
    SpaceManagersTeams []string
    A list of team IDs designated to be managers of this space.
    description String
    The description of this space.
    isDefault Boolean
    Specifies if this space is the default space in Octopus.
    isTaskQueueStopped Boolean
    Specifies the status of the task queue for this space.
    name String
    The name of this resource.
    slug String
    The unique slug of this space
    spaceManagersTeamMembers List<String>
    A list of user IDs designated to be managers of this space.
    spaceManagersTeams List<String>
    A list of team IDs designated to be managers of this space.
    description string
    The description of this space.
    isDefault boolean
    Specifies if this space is the default space in Octopus.
    isTaskQueueStopped boolean
    Specifies the status of the task queue for this space.
    name string
    The name of this resource.
    slug string
    The unique slug of this space
    spaceManagersTeamMembers string[]
    A list of user IDs designated to be managers of this space.
    spaceManagersTeams string[]
    A list of team IDs designated to be managers of this space.
    description str
    The description of this space.
    is_default bool
    Specifies if this space is the default space in Octopus.
    is_task_queue_stopped bool
    Specifies the status of the task queue for this space.
    name str
    The name of this resource.
    slug str
    The unique slug of this space
    space_managers_team_members Sequence[str]
    A list of user IDs designated to be managers of this space.
    space_managers_teams Sequence[str]
    A list of team IDs designated to be managers of this space.
    description String
    The description of this space.
    isDefault Boolean
    Specifies if this space is the default space in Octopus.
    isTaskQueueStopped Boolean
    Specifies the status of the task queue for this space.
    name String
    The name of this resource.
    slug String
    The unique slug of this space
    spaceManagersTeamMembers List<String>
    A list of user IDs designated to be managers of this space.
    spaceManagersTeams List<String>
    A list of team IDs designated to be managers of this space.

    Import

    $ pulumi import octopusdeploy:index/space:Space [options] octopusdeploy_space.<name> <space-id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy