Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Heroku Provider
  3. API Docs
  4. space
  5. Space
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

heroku.space.Space

Explore with Pulumi AI

heroku logo
Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
pulumiverse/pulumi-heroku

    Provides a Heroku Private Space resource for running apps in isolated, highly available, secure app execution environments.

    Example Usage

    A Heroku “team” was originally called an “organization”, and that is still the identifier used in this resource.

    // Create a new Heroku space
resource "heroku_space" "default" {
  name = "test-space"
  organization = "my-company"
  region = "virginia"
}

// Create a new Heroku app in test-space, same region
resource "heroku_app" "default" {
  name = "test-app"
  region = "virginia"
  space = heroku_space.default.id
  organization = {
    name = "my-company"
  }
}

    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: SpaceArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Space(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          organization: Optional[str] = None,
          cidr: Optional[str] = None,
          data_cidr: Optional[str] = None,
          name: Optional[str] = None,
          region: Optional[str] = None,
          shield: Optional[bool] = None)
    func NewSpace(ctx *Context, name string, args SpaceArgs, opts ...ResourceOption) (*Space, error)
    public Space(string name, SpaceArgs args, CustomResourceOptions? opts = null)
    public Space(String name, SpaceArgs args)
public Space(String name, SpaceArgs args, CustomResourceOptions options)

    type: heroku:space: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 Heroku.Space.Space("spaceResource", new()
{
    Organization = "string",
    Cidr = "string",
    DataCidr = "string",
    Name = "string",
    Region = "string",
    Shield = false,
});

    example, err := space.NewSpace(ctx, "spaceResource", &space.SpaceArgs{
	Organization: pulumi.String("string"),
	Cidr:         pulumi.String("string"),
	DataCidr:     pulumi.String("string"),
	Name:         pulumi.String("string"),
	Region:       pulumi.String("string"),
	Shield:       pulumi.Bool(false),
})

    var spaceResource = new Space("spaceResource", SpaceArgs.builder()
    .organization("string")
    .cidr("string")
    .dataCidr("string")
    .name("string")
    .region("string")
    .shield(false)
    .build());

    space_resource = heroku.space.Space("spaceResource",
    organization="string",
    cidr="string",
    data_cidr="string",
    name="string",
    region="string",
    shield=False)

    const spaceResource = new heroku.space.Space("spaceResource", {
    organization: "string",
    cidr: "string",
    dataCidr: "string",
    name: "string",
    region: "string",
    shield: false,
});

    type: heroku:space:Space
properties:
    cidr: string
    dataCidr: string
    name: string
    organization: string
    region: string
    shield: false

    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:

    Organization string
    The name of the Heroku Team which will own the Private Space.
    Cidr string
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    DataCidr string
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    Name string
    The name of the Private Space.
    Region string
    provision in a specific Private Spaces region.
    Shield bool
    provision as a Shield Private Space.
    Organization string
    The name of the Heroku Team which will own the Private Space.
    Cidr string
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    DataCidr string
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    Name string
    The name of the Private Space.
    Region string
    provision in a specific Private Spaces region.
    Shield bool
    provision as a Shield Private Space.
    organization String
    The name of the Heroku Team which will own the Private Space.
    cidr String
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    dataCidr String
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    name String
    The name of the Private Space.
    region String
    provision in a specific Private Spaces region.
    shield Boolean
    provision as a Shield Private Space.
    organization string
    The name of the Heroku Team which will own the Private Space.
    cidr string
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    dataCidr string
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    name string
    The name of the Private Space.
    region string
    provision in a specific Private Spaces region.
    shield boolean
    provision as a Shield Private Space.
    organization str
    The name of the Heroku Team which will own the Private Space.
    cidr str
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    data_cidr str
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    name str
    The name of the Private Space.
    region str
    provision in a specific Private Spaces region.
    shield bool
    provision as a Shield Private Space.
    organization String
    The name of the Heroku Team which will own the Private Space.
    cidr String
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    dataCidr String
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    name String
    The name of the Private Space.
    region String
    provision in a specific Private Spaces region.
    shield Boolean
    provision as a Shield Private 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.
    OutboundIps List<string>
    The space's stable outbound NAT IPs.
    Id string
    The provider-assigned unique ID for this managed resource.
    OutboundIps []string
    The space's stable outbound NAT IPs.
    id String
    The provider-assigned unique ID for this managed resource.
    outboundIps List<String>
    The space's stable outbound NAT IPs.
    id string
    The provider-assigned unique ID for this managed resource.
    outboundIps string[]
    The space's stable outbound NAT IPs.
    id str
    The provider-assigned unique ID for this managed resource.
    outbound_ips Sequence[str]
    The space's stable outbound NAT IPs.
    id String
    The provider-assigned unique ID for this managed resource.
    outboundIps List<String>
    The space's stable outbound NAT IPs.

    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,
        cidr: Optional[str] = None,
        data_cidr: Optional[str] = None,
        name: Optional[str] = None,
        organization: Optional[str] = None,
        outbound_ips: Optional[Sequence[str]] = None,
        region: Optional[str] = None,
        shield: Optional[bool] = 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: heroku:space: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:
    Cidr string
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    DataCidr string
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    Name string
    The name of the Private Space.
    Organization string
    The name of the Heroku Team which will own the Private Space.
    OutboundIps List<string>
    The space's stable outbound NAT IPs.
    Region string
    provision in a specific Private Spaces region.
    Shield bool
    provision as a Shield Private Space.
    Cidr string
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    DataCidr string
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    Name string
    The name of the Private Space.
    Organization string
    The name of the Heroku Team which will own the Private Space.
    OutboundIps []string
    The space's stable outbound NAT IPs.
    Region string
    provision in a specific Private Spaces region.
    Shield bool
    provision as a Shield Private Space.
    cidr String
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    dataCidr String
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    name String
    The name of the Private Space.
    organization String
    The name of the Heroku Team which will own the Private Space.
    outboundIps List<String>
    The space's stable outbound NAT IPs.
    region String
    provision in a specific Private Spaces region.
    shield Boolean
    provision as a Shield Private Space.
    cidr string
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    dataCidr string
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    name string
    The name of the Private Space.
    organization string
    The name of the Heroku Team which will own the Private Space.
    outboundIps string[]
    The space's stable outbound NAT IPs.
    region string
    provision in a specific Private Spaces region.
    shield boolean
    provision as a Shield Private Space.
    cidr str
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    data_cidr str
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    name str
    The name of the Private Space.
    organization str
    The name of the Heroku Team which will own the Private Space.
    outbound_ips Sequence[str]
    The space's stable outbound NAT IPs.
    region str
    provision in a specific Private Spaces region.
    shield bool
    provision as a Shield Private Space.
    cidr String
    The RFC-1918 CIDR the Private Space will use. It must be a /16 in 10.0.0.0/8, 172.16.0.0/12 or 192.168.0.0/16
    dataCidr String
    The RFC-1918 CIDR that the Private Space will use for the Heroku-managed peering connection that’s automatically created when using Heroku Data add-ons. It must be between a /16 and a /20
    name String
    The name of the Private Space.
    organization String
    The name of the Heroku Team which will own the Private Space.
    outboundIps List<String>
    The space's stable outbound NAT IPs.
    region String
    provision in a specific Private Spaces region.
    shield Boolean
    provision as a Shield Private Space.

    Import

    Spaces can be imported using the space id, e.g.

    $ pulumi import heroku:space/space:Space foobar MySpace

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

    Package Details

    Repository
    heroku pulumiverse/pulumi-heroku
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the heroku Terraform Provider.
    heroku logo
    Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns
    pulumiverse/pulumi-heroku