splight.Server
 
Example Usage
Create Server Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Server(name: string, args: ServerArgs, opts?: CustomResourceOptions);@overload
def Server(resource_name: str,
           args: ServerArgs,
           opts: Optional[ResourceOptions] = None)
@overload
def Server(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           version: Optional[str] = None,
           configs: Optional[Sequence[ServerConfigArgs]] = None,
           description: Optional[str] = None,
           env_vars: Optional[Sequence[ServerEnvVarArgs]] = None,
           log_level: Optional[str] = None,
           machine_instance_size: Optional[str] = None,
           name: Optional[str] = None,
           node: Optional[str] = None,
           ports: Optional[Sequence[ServerPortArgs]] = None,
           restart_policy: Optional[str] = None,
           tags: Optional[Sequence[ServerTagArgs]] = None)func NewServer(ctx *Context, name string, args ServerArgs, opts ...ResourceOption) (*Server, error)public Server(string name, ServerArgs args, CustomResourceOptions? opts = null)
public Server(String name, ServerArgs args)
public Server(String name, ServerArgs args, CustomResourceOptions options)
type: splight:Server
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 ServerArgs
- 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 ServerArgs
- 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 ServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServerArgs
- 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 serverResource = new Splight.Server("serverResource", new()
{
    Version = "string",
    Configs = new[]
    {
        new Splight.Inputs.ServerConfigArgs
        {
            Name = "string",
            Type = "string",
            Description = "string",
            Multiple = false,
            Required = false,
            Sensitive = false,
            Value = "string",
        },
    },
    Description = "string",
    EnvVars = new[]
    {
        new Splight.Inputs.ServerEnvVarArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    LogLevel = "string",
    MachineInstanceSize = "string",
    Name = "string",
    Node = "string",
    Ports = new[]
    {
        new Splight.Inputs.ServerPortArgs
        {
            ExposedPort = 0,
            InternalPort = 0,
            Name = "string",
            Protocol = "string",
        },
    },
    RestartPolicy = "string",
    Tags = new[]
    {
        new Splight.Inputs.ServerTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
});
example, err := splight.NewServer(ctx, "serverResource", &splight.ServerArgs{
	Version: pulumi.String("string"),
	Configs: splight.ServerConfigArray{
		&splight.ServerConfigArgs{
			Name:        pulumi.String("string"),
			Type:        pulumi.String("string"),
			Description: pulumi.String("string"),
			Multiple:    pulumi.Bool(false),
			Required:    pulumi.Bool(false),
			Sensitive:   pulumi.Bool(false),
			Value:       pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	EnvVars: splight.ServerEnvVarArray{
		&splight.ServerEnvVarArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	LogLevel:            pulumi.String("string"),
	MachineInstanceSize: pulumi.String("string"),
	Name:                pulumi.String("string"),
	Node:                pulumi.String("string"),
	Ports: splight.ServerPortArray{
		&splight.ServerPortArgs{
			ExposedPort:  pulumi.Int(0),
			InternalPort: pulumi.Int(0),
			Name:         pulumi.String("string"),
			Protocol:     pulumi.String("string"),
		},
	},
	RestartPolicy: pulumi.String("string"),
	Tags: splight.ServerTagArray{
		&splight.ServerTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
})
var serverResource = new Server("serverResource", ServerArgs.builder()
    .version("string")
    .configs(ServerConfigArgs.builder()
        .name("string")
        .type("string")
        .description("string")
        .multiple(false)
        .required(false)
        .sensitive(false)
        .value("string")
        .build())
    .description("string")
    .envVars(ServerEnvVarArgs.builder()
        .name("string")
        .value("string")
        .build())
    .logLevel("string")
    .machineInstanceSize("string")
    .name("string")
    .node("string")
    .ports(ServerPortArgs.builder()
        .exposedPort(0)
        .internalPort(0)
        .name("string")
        .protocol("string")
        .build())
    .restartPolicy("string")
    .tags(ServerTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .build());
server_resource = splight.Server("serverResource",
    version="string",
    configs=[{
        "name": "string",
        "type": "string",
        "description": "string",
        "multiple": False,
        "required": False,
        "sensitive": False,
        "value": "string",
    }],
    description="string",
    env_vars=[{
        "name": "string",
        "value": "string",
    }],
    log_level="string",
    machine_instance_size="string",
    name="string",
    node="string",
    ports=[{
        "exposed_port": 0,
        "internal_port": 0,
        "name": "string",
        "protocol": "string",
    }],
    restart_policy="string",
    tags=[{
        "id": "string",
        "name": "string",
    }])
const serverResource = new splight.Server("serverResource", {
    version: "string",
    configs: [{
        name: "string",
        type: "string",
        description: "string",
        multiple: false,
        required: false,
        sensitive: false,
        value: "string",
    }],
    description: "string",
    envVars: [{
        name: "string",
        value: "string",
    }],
    logLevel: "string",
    machineInstanceSize: "string",
    name: "string",
    node: "string",
    ports: [{
        exposedPort: 0,
        internalPort: 0,
        name: "string",
        protocol: "string",
    }],
    restartPolicy: "string",
    tags: [{
        id: "string",
        name: "string",
    }],
});
type: splight:Server
properties:
    configs:
        - description: string
          multiple: false
          name: string
          required: false
          sensitive: false
          type: string
          value: string
    description: string
    envVars:
        - name: string
          value: string
    logLevel: string
    machineInstanceSize: string
    name: string
    node: string
    ports:
        - exposedPort: 0
          internalPort: 0
          name: string
          protocol: string
    restartPolicy: string
    tags:
        - id: string
          name: string
    version: string
Server 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 Server resource accepts the following input properties:
- Version string
- [NAME-VERSION] the version of the hub server
- Configs
List<Splight.Splight. Inputs. Server Config> 
- static config parameters of the routine
- Description string
- optional description to add details of the resource
- EnvVars List<Splight.Splight. Inputs. Server Env Var> 
- environment variables for the server
- LogLevel string
- log level of the server
- MachineInstance stringSize 
- instance size
- Name string
- the name of the server to be created
- Node string
- id of the compute node where the server runs
- Ports
List<Splight.Splight. Inputs. Server Port> 
- ports of the server
- RestartPolicy string
- restart policy of the server
- 
List<Splight.Splight. Inputs. Server Tag> 
- tags of the resource
- Version string
- [NAME-VERSION] the version of the hub server
- Configs
[]ServerConfig Args 
- static config parameters of the routine
- Description string
- optional description to add details of the resource
- EnvVars []ServerEnv Var Args 
- environment variables for the server
- LogLevel string
- log level of the server
- MachineInstance stringSize 
- instance size
- Name string
- the name of the server to be created
- Node string
- id of the compute node where the server runs
- Ports
[]ServerPort Args 
- ports of the server
- RestartPolicy string
- restart policy of the server
- 
[]ServerTag Args 
- tags of the resource
- version String
- [NAME-VERSION] the version of the hub server
- configs
List<ServerConfig> 
- static config parameters of the routine
- description String
- optional description to add details of the resource
- envVars List<ServerEnv Var> 
- environment variables for the server
- logLevel String
- log level of the server
- machineInstance StringSize 
- instance size
- name String
- the name of the server to be created
- node String
- id of the compute node where the server runs
- ports
List<ServerPort> 
- ports of the server
- restartPolicy String
- restart policy of the server
- 
List<ServerTag> 
- tags of the resource
- version string
- [NAME-VERSION] the version of the hub server
- configs
ServerConfig[] 
- static config parameters of the routine
- description string
- optional description to add details of the resource
- envVars ServerEnv Var[] 
- environment variables for the server
- logLevel string
- log level of the server
- machineInstance stringSize 
- instance size
- name string
- the name of the server to be created
- node string
- id of the compute node where the server runs
- ports
ServerPort[] 
- ports of the server
- restartPolicy string
- restart policy of the server
- 
ServerTag[] 
- tags of the resource
- version str
- [NAME-VERSION] the version of the hub server
- configs
Sequence[ServerConfig Args] 
- static config parameters of the routine
- description str
- optional description to add details of the resource
- env_vars Sequence[ServerEnv Var Args] 
- environment variables for the server
- log_level str
- log level of the server
- machine_instance_ strsize 
- instance size
- name str
- the name of the server to be created
- node str
- id of the compute node where the server runs
- ports
Sequence[ServerPort Args] 
- ports of the server
- restart_policy str
- restart policy of the server
- 
Sequence[ServerTag Args] 
- tags of the resource
- version String
- [NAME-VERSION] the version of the hub server
- configs List<Property Map>
- static config parameters of the routine
- description String
- optional description to add details of the resource
- envVars List<Property Map>
- environment variables for the server
- logLevel String
- log level of the server
- machineInstance StringSize 
- instance size
- name String
- the name of the server to be created
- node String
- id of the compute node where the server runs
- ports List<Property Map>
- ports of the server
- restartPolicy String
- restart policy of the server
- List<Property Map>
- tags of the resource
Outputs
All input properties are implicitly available as output properties. Additionally, the Server 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 Server Resource
Get an existing Server 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?: ServerState, opts?: CustomResourceOptions): Server@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configs: Optional[Sequence[ServerConfigArgs]] = None,
        description: Optional[str] = None,
        env_vars: Optional[Sequence[ServerEnvVarArgs]] = None,
        log_level: Optional[str] = None,
        machine_instance_size: Optional[str] = None,
        name: Optional[str] = None,
        node: Optional[str] = None,
        ports: Optional[Sequence[ServerPortArgs]] = None,
        restart_policy: Optional[str] = None,
        tags: Optional[Sequence[ServerTagArgs]] = None,
        version: Optional[str] = None) -> Serverfunc GetServer(ctx *Context, name string, id IDInput, state *ServerState, opts ...ResourceOption) (*Server, error)public static Server Get(string name, Input<string> id, ServerState? state, CustomResourceOptions? opts = null)public static Server get(String name, Output<String> id, ServerState state, CustomResourceOptions options)resources:  _:    type: splight:Server    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.
- Configs
List<Splight.Splight. Inputs. Server Config> 
- static config parameters of the routine
- Description string
- optional description to add details of the resource
- EnvVars List<Splight.Splight. Inputs. Server Env Var> 
- environment variables for the server
- LogLevel string
- log level of the server
- MachineInstance stringSize 
- instance size
- Name string
- the name of the server to be created
- Node string
- id of the compute node where the server runs
- Ports
List<Splight.Splight. Inputs. Server Port> 
- ports of the server
- RestartPolicy string
- restart policy of the server
- 
List<Splight.Splight. Inputs. Server Tag> 
- tags of the resource
- Version string
- [NAME-VERSION] the version of the hub server
- Configs
[]ServerConfig Args 
- static config parameters of the routine
- Description string
- optional description to add details of the resource
- EnvVars []ServerEnv Var Args 
- environment variables for the server
- LogLevel string
- log level of the server
- MachineInstance stringSize 
- instance size
- Name string
- the name of the server to be created
- Node string
- id of the compute node where the server runs
- Ports
[]ServerPort Args 
- ports of the server
- RestartPolicy string
- restart policy of the server
- 
[]ServerTag Args 
- tags of the resource
- Version string
- [NAME-VERSION] the version of the hub server
- configs
List<ServerConfig> 
- static config parameters of the routine
- description String
- optional description to add details of the resource
- envVars List<ServerEnv Var> 
- environment variables for the server
- logLevel String
- log level of the server
- machineInstance StringSize 
- instance size
- name String
- the name of the server to be created
- node String
- id of the compute node where the server runs
- ports
List<ServerPort> 
- ports of the server
- restartPolicy String
- restart policy of the server
- 
List<ServerTag> 
- tags of the resource
- version String
- [NAME-VERSION] the version of the hub server
- configs
ServerConfig[] 
- static config parameters of the routine
- description string
- optional description to add details of the resource
- envVars ServerEnv Var[] 
- environment variables for the server
- logLevel string
- log level of the server
- machineInstance stringSize 
- instance size
- name string
- the name of the server to be created
- node string
- id of the compute node where the server runs
- ports
ServerPort[] 
- ports of the server
- restartPolicy string
- restart policy of the server
- 
ServerTag[] 
- tags of the resource
- version string
- [NAME-VERSION] the version of the hub server
- configs
Sequence[ServerConfig Args] 
- static config parameters of the routine
- description str
- optional description to add details of the resource
- env_vars Sequence[ServerEnv Var Args] 
- environment variables for the server
- log_level str
- log level of the server
- machine_instance_ strsize 
- instance size
- name str
- the name of the server to be created
- node str
- id of the compute node where the server runs
- ports
Sequence[ServerPort Args] 
- ports of the server
- restart_policy str
- restart policy of the server
- 
Sequence[ServerTag Args] 
- tags of the resource
- version str
- [NAME-VERSION] the version of the hub server
- configs List<Property Map>
- static config parameters of the routine
- description String
- optional description to add details of the resource
- envVars List<Property Map>
- environment variables for the server
- logLevel String
- log level of the server
- machineInstance StringSize 
- instance size
- name String
- the name of the server to be created
- node String
- id of the compute node where the server runs
- ports List<Property Map>
- ports of the server
- restartPolicy String
- restart policy of the server
- List<Property Map>
- tags of the resource
- version String
- [NAME-VERSION] the version of the hub server
Supporting Types
ServerConfig, ServerConfigArgs    
ServerEnvVar, ServerEnvVarArgs      
ServerPort, ServerPortArgs    
- ExposedPort int
- InternalPort int
- Name string
- Protocol string
- ExposedPort int
- InternalPort int
- Name string
- Protocol string
- exposedPort Integer
- internalPort Integer
- name String
- protocol String
- exposedPort number
- internalPort number
- name string
- protocol string
- exposed_port int
- internal_port int
- name str
- protocol str
- exposedPort Number
- internalPort Number
- name String
- protocol String
ServerTag, ServerTagArgs    
Import
The pulumi import command can be used, for example:
$ pulumi import splight:index/server:Server [options] splight_server.<name> <server_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- splight splightplatform/pulumi-splight
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the splightTerraform Provider.
 
