1. Packages
  2. Spectrocloud Provider
  3. API Docs
  4. Appliance
spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud

spectrocloud.Appliance

Explore with Pulumi AI

spectrocloud logo
spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud

    A resource for creating and managing appliances for Edge Native cluster provisioning.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as spectrocloud from "@pulumi/spectrocloud";
    
    const appliance = new spectrocloud.Appliance("appliance", {
        tags: {
            name: "appliance_name",
        },
        uid: "test-dec9",
        wait: true,
    });
    
    import pulumi
    import pulumi_spectrocloud as spectrocloud
    
    appliance = spectrocloud.Appliance("appliance",
        tags={
            "name": "appliance_name",
        },
        uid="test-dec9",
        wait=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/spectrocloud/spectrocloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := spectrocloud.NewAppliance(ctx, "appliance", &spectrocloud.ApplianceArgs{
    			Tags: pulumi.StringMap{
    				"name": pulumi.String("appliance_name"),
    			},
    			Uid:  pulumi.String("test-dec9"),
    			Wait: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Spectrocloud = Pulumi.Spectrocloud;
    
    return await Deployment.RunAsync(() => 
    {
        var appliance = new Spectrocloud.Appliance("appliance", new()
        {
            Tags = 
            {
                { "name", "appliance_name" },
            },
            Uid = "test-dec9",
            Wait = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.spectrocloud.Appliance;
    import com.pulumi.spectrocloud.ApplianceArgs;
    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 appliance = new Appliance("appliance", ApplianceArgs.builder()
                .tags(Map.of("name", "appliance_name"))
                .uid("test-dec9")
                .wait(true)
                .build());
    
        }
    }
    
    resources:
      appliance:
        type: spectrocloud:Appliance
        properties:
          tags:
            name: appliance_name
          uid: test-dec9
          wait: true
    

    Create Appliance Resource

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

    Constructor syntax

    new Appliance(name: string, args: ApplianceArgs, opts?: CustomResourceOptions);
    @overload
    def Appliance(resource_name: str,
                  args: ApplianceArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Appliance(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  uid: Optional[str] = None,
                  appliance_id: Optional[str] = None,
                  pairing_key: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  timeouts: Optional[ApplianceTimeoutsArgs] = None,
                  wait: Optional[bool] = None)
    func NewAppliance(ctx *Context, name string, args ApplianceArgs, opts ...ResourceOption) (*Appliance, error)
    public Appliance(string name, ApplianceArgs args, CustomResourceOptions? opts = null)
    public Appliance(String name, ApplianceArgs args)
    public Appliance(String name, ApplianceArgs args, CustomResourceOptions options)
    
    type: spectrocloud:Appliance
    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 ApplianceArgs
    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 ApplianceArgs
    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 ApplianceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplianceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplianceArgs
    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 applianceResource = new Spectrocloud.Appliance("applianceResource", new()
    {
        Uid = "string",
        ApplianceId = "string",
        PairingKey = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Timeouts = new Spectrocloud.Inputs.ApplianceTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
        Wait = false,
    });
    
    example, err := spectrocloud.NewAppliance(ctx, "applianceResource", &spectrocloud.ApplianceArgs{
    	Uid:         pulumi.String("string"),
    	ApplianceId: pulumi.String("string"),
    	PairingKey:  pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Timeouts: &spectrocloud.ApplianceTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	Wait: pulumi.Bool(false),
    })
    
    var applianceResource = new Appliance("applianceResource", ApplianceArgs.builder()
        .uid("string")
        .applianceId("string")
        .pairingKey("string")
        .tags(Map.of("string", "string"))
        .timeouts(ApplianceTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .wait(false)
        .build());
    
    appliance_resource = spectrocloud.Appliance("applianceResource",
        uid="string",
        appliance_id="string",
        pairing_key="string",
        tags={
            "string": "string",
        },
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        },
        wait=False)
    
    const applianceResource = new spectrocloud.Appliance("applianceResource", {
        uid: "string",
        applianceId: "string",
        pairingKey: "string",
        tags: {
            string: "string",
        },
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
        wait: false,
    });
    
    type: spectrocloud:Appliance
    properties:
        applianceId: string
        pairingKey: string
        tags:
            string: string
        timeouts:
            create: string
            delete: string
            update: string
        uid: string
        wait: false
    

    Appliance 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 Appliance resource accepts the following input properties:

    Uid string
    The unique identifier (UID) for the appliance.
    ApplianceId string
    The ID of this resource.
    PairingKey string
    The pairing key used for appliance pairing.
    Tags Dictionary<string, string>
    A set of key-value pairs that can be used to organize and categorize the appliance.
    Timeouts ApplianceTimeouts
    Wait bool
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    Uid string
    The unique identifier (UID) for the appliance.
    ApplianceId string
    The ID of this resource.
    PairingKey string
    The pairing key used for appliance pairing.
    Tags map[string]string
    A set of key-value pairs that can be used to organize and categorize the appliance.
    Timeouts ApplianceTimeoutsArgs
    Wait bool
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    uid String
    The unique identifier (UID) for the appliance.
    applianceId String
    The ID of this resource.
    pairingKey String
    The pairing key used for appliance pairing.
    tags Map<String,String>
    A set of key-value pairs that can be used to organize and categorize the appliance.
    timeouts ApplianceTimeouts
    wait_ Boolean
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    uid string
    The unique identifier (UID) for the appliance.
    applianceId string
    The ID of this resource.
    pairingKey string
    The pairing key used for appliance pairing.
    tags {[key: string]: string}
    A set of key-value pairs that can be used to organize and categorize the appliance.
    timeouts ApplianceTimeouts
    wait boolean
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    uid str
    The unique identifier (UID) for the appliance.
    appliance_id str
    The ID of this resource.
    pairing_key str
    The pairing key used for appliance pairing.
    tags Mapping[str, str]
    A set of key-value pairs that can be used to organize and categorize the appliance.
    timeouts ApplianceTimeoutsArgs
    wait bool
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    uid String
    The unique identifier (UID) for the appliance.
    applianceId String
    The ID of this resource.
    pairingKey String
    The pairing key used for appliance pairing.
    tags Map<String>
    A set of key-value pairs that can be used to organize and categorize the appliance.
    timeouts Property Map
    wait Boolean
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Appliance 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 Appliance Resource

    Get an existing Appliance 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?: ApplianceState, opts?: CustomResourceOptions): Appliance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            appliance_id: Optional[str] = None,
            pairing_key: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            timeouts: Optional[ApplianceTimeoutsArgs] = None,
            uid: Optional[str] = None,
            wait: Optional[bool] = None) -> Appliance
    func GetAppliance(ctx *Context, name string, id IDInput, state *ApplianceState, opts ...ResourceOption) (*Appliance, error)
    public static Appliance Get(string name, Input<string> id, ApplianceState? state, CustomResourceOptions? opts = null)
    public static Appliance get(String name, Output<String> id, ApplianceState state, CustomResourceOptions options)
    resources:  _:    type: spectrocloud:Appliance    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:
    ApplianceId string
    The ID of this resource.
    PairingKey string
    The pairing key used for appliance pairing.
    Tags Dictionary<string, string>
    A set of key-value pairs that can be used to organize and categorize the appliance.
    Timeouts ApplianceTimeouts
    Uid string
    The unique identifier (UID) for the appliance.
    Wait bool
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    ApplianceId string
    The ID of this resource.
    PairingKey string
    The pairing key used for appliance pairing.
    Tags map[string]string
    A set of key-value pairs that can be used to organize and categorize the appliance.
    Timeouts ApplianceTimeoutsArgs
    Uid string
    The unique identifier (UID) for the appliance.
    Wait bool
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    applianceId String
    The ID of this resource.
    pairingKey String
    The pairing key used for appliance pairing.
    tags Map<String,String>
    A set of key-value pairs that can be used to organize and categorize the appliance.
    timeouts ApplianceTimeouts
    uid String
    The unique identifier (UID) for the appliance.
    wait_ Boolean
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    applianceId string
    The ID of this resource.
    pairingKey string
    The pairing key used for appliance pairing.
    tags {[key: string]: string}
    A set of key-value pairs that can be used to organize and categorize the appliance.
    timeouts ApplianceTimeouts
    uid string
    The unique identifier (UID) for the appliance.
    wait boolean
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    appliance_id str
    The ID of this resource.
    pairing_key str
    The pairing key used for appliance pairing.
    tags Mapping[str, str]
    A set of key-value pairs that can be used to organize and categorize the appliance.
    timeouts ApplianceTimeoutsArgs
    uid str
    The unique identifier (UID) for the appliance.
    wait bool
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.
    applianceId String
    The ID of this resource.
    pairingKey String
    The pairing key used for appliance pairing.
    tags Map<String>
    A set of key-value pairs that can be used to organize and categorize the appliance.
    timeouts Property Map
    uid String
    The unique identifier (UID) for the appliance.
    wait Boolean
    If set to true, the resource creation will wait for the appliance provisioning process to complete before returning. Defaults to false.

    Supporting Types

    ApplianceTimeouts, ApplianceTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Package Details

    Repository
    spectrocloud spectrocloud/terraform-provider-spectrocloud
    License
    Notes
    This Pulumi package is based on the spectrocloud Terraform Provider.
    spectrocloud logo
    spectrocloud 0.23.5 published on Sunday, Apr 20, 2025 by spectrocloud