1. Packages
  2. Formal Provider
  3. API Docs
  4. Space
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

formal.Space

Explore with Pulumi AI

formal logo
Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal

    Registering a Space with Formal.

    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,
              name: Optional[str] = None,
              termination_protection: Optional[bool] = 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: formal: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 Pulumi.Space("spaceResource", new()
    {
        Description = "string",
        Name = "string",
        TerminationProtection = false,
    });
    
    example, err := formal.NewSpace(ctx, "spaceResource", &formal.SpaceArgs{
    	Description:           pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	TerminationProtection: pulumi.Bool(false),
    })
    
    var spaceResource = new Space("spaceResource", SpaceArgs.builder()
        .description("string")
        .name("string")
        .terminationProtection(false)
        .build());
    
    space_resource = formal.Space("spaceResource",
        description="string",
        name="string",
        termination_protection=False)
    
    const spaceResource = new formal.Space("spaceResource", {
        description: "string",
        name: "string",
        terminationProtection: false,
    });
    
    type: formal:Space
    properties:
        description: string
        name: string
        terminationProtection: 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:

    Description string
    Description of the Space.
    Name string
    Friendly name for this Space.
    TerminationProtection bool
    If set to true, this Space cannot be deleted.
    Description string
    Description of the Space.
    Name string
    Friendly name for this Space.
    TerminationProtection bool
    If set to true, this Space cannot be deleted.
    description String
    Description of the Space.
    name String
    Friendly name for this Space.
    terminationProtection Boolean
    If set to true, this Space cannot be deleted.
    description string
    Description of the Space.
    name string
    Friendly name for this Space.
    terminationProtection boolean
    If set to true, this Space cannot be deleted.
    description str
    Description of the Space.
    name str
    Friendly name for this Space.
    termination_protection bool
    If set to true, this Space cannot be deleted.
    description String
    Description of the Space.
    name String
    Friendly name for this Space.
    terminationProtection Boolean
    If set to true, this Space cannot be deleted.

    Outputs

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

    CreatedAt int
    Creation time of the Space.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedAt int
    Creation time of the Space.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt Integer
    Creation time of the Space.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt number
    Creation time of the Space.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at int
    Creation time of the Space.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt Number
    Creation time of the Space.
    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,
            created_at: Optional[int] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            termination_protection: 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: formal: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:
    CreatedAt int
    Creation time of the Space.
    Description string
    Description of the Space.
    Name string
    Friendly name for this Space.
    TerminationProtection bool
    If set to true, this Space cannot be deleted.
    CreatedAt int
    Creation time of the Space.
    Description string
    Description of the Space.
    Name string
    Friendly name for this Space.
    TerminationProtection bool
    If set to true, this Space cannot be deleted.
    createdAt Integer
    Creation time of the Space.
    description String
    Description of the Space.
    name String
    Friendly name for this Space.
    terminationProtection Boolean
    If set to true, this Space cannot be deleted.
    createdAt number
    Creation time of the Space.
    description string
    Description of the Space.
    name string
    Friendly name for this Space.
    terminationProtection boolean
    If set to true, this Space cannot be deleted.
    created_at int
    Creation time of the Space.
    description str
    Description of the Space.
    name str
    Friendly name for this Space.
    termination_protection bool
    If set to true, this Space cannot be deleted.
    createdAt Number
    Creation time of the Space.
    description String
    Description of the Space.
    name String
    Friendly name for this Space.
    terminationProtection Boolean
    If set to true, this Space cannot be deleted.

    Package Details

    Repository
    formal formalco/pulumi-formal
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the formal Terraform Provider.
    formal logo
    Formal v1.0.2 published on Thursday, Aug 14, 2025 by Formal