Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Splight
  3. API Docs
  4. Algorithm
splight v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
splightplatform/pulumi-splight

splight.Algorithm

Explore with Pulumi AI

splight logo
splight v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
splightplatform/pulumi-splight

    Example Usage

    Create Algorithm Resource

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

    Constructor syntax

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

@overload
def Algorithm(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              version: Optional[str] = None,
              description: Optional[str] = None,
              inputs: Optional[Sequence[AlgorithmInputArgs]] = None,
              log_level: Optional[str] = None,
              machine_instance_size: Optional[str] = None,
              name: Optional[str] = None,
              node: Optional[str] = None,
              restart_policy: Optional[str] = None,
              tags: Optional[Sequence[AlgorithmTagArgs]] = None)
    func NewAlgorithm(ctx *Context, name string, args AlgorithmArgs, opts ...ResourceOption) (*Algorithm, error)
    public Algorithm(string name, AlgorithmArgs args, CustomResourceOptions? opts = null)
    public Algorithm(String name, AlgorithmArgs args)
public Algorithm(String name, AlgorithmArgs args, CustomResourceOptions options)

    type: splight:Algorithm
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 AlgorithmArgs
    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 AlgorithmArgs
    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 AlgorithmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlgorithmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlgorithmArgs
    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 algorithmResource = new Splight.Algorithm("algorithmResource", new()
{
    Version = "string",
    Description = "string",
    Inputs = new[]
    {
        new Splight.Inputs.AlgorithmInputArgs
        {
            Name = "string",
            Type = "string",
            Description = "string",
            Multiple = false,
            Required = false,
            Sensitive = false,
            Value = "string",
        },
    },
    LogLevel = "string",
    MachineInstanceSize = "string",
    Name = "string",
    Node = "string",
    RestartPolicy = "string",
    Tags = new[]
    {
        new Splight.Inputs.AlgorithmTagArgs
        {
            Id = "string",
            Name = "string",
        },
    },
});

    example, err := splight.NewAlgorithm(ctx, "algorithmResource", &splight.AlgorithmArgs{
	Version:     pulumi.String("string"),
	Description: pulumi.String("string"),
	Inputs: splight.AlgorithmInputTypeArray{
		&splight.AlgorithmInputTypeArgs{
			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"),
		},
	},
	LogLevel:            pulumi.String("string"),
	MachineInstanceSize: pulumi.String("string"),
	Name:                pulumi.String("string"),
	Node:                pulumi.String("string"),
	RestartPolicy:       pulumi.String("string"),
	Tags: splight.AlgorithmTagArray{
		&splight.AlgorithmTagArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
		},
	},
})

    var algorithmResource = new Algorithm("algorithmResource", AlgorithmArgs.builder()
    .version("string")
    .description("string")
    .inputs(AlgorithmInputArgs.builder()
        .name("string")
        .type("string")
        .description("string")
        .multiple(false)
        .required(false)
        .sensitive(false)
        .value("string")
        .build())
    .logLevel("string")
    .machineInstanceSize("string")
    .name("string")
    .node("string")
    .restartPolicy("string")
    .tags(AlgorithmTagArgs.builder()
        .id("string")
        .name("string")
        .build())
    .build());

    algorithm_resource = splight.Algorithm("algorithmResource",
    version="string",
    description="string",
    inputs=[{
        "name": "string",
        "type": "string",
        "description": "string",
        "multiple": False,
        "required": False,
        "sensitive": False,
        "value": "string",
    }],
    log_level="string",
    machine_instance_size="string",
    name="string",
    node="string",
    restart_policy="string",
    tags=[{
        "id": "string",
        "name": "string",
    }])

    const algorithmResource = new splight.Algorithm("algorithmResource", {
    version: "string",
    description: "string",
    inputs: [{
        name: "string",
        type: "string",
        description: "string",
        multiple: false,
        required: false,
        sensitive: false,
        value: "string",
    }],
    logLevel: "string",
    machineInstanceSize: "string",
    name: "string",
    node: "string",
    restartPolicy: "string",
    tags: [{
        id: "string",
        name: "string",
    }],
});

    type: splight:Algorithm
properties:
    description: string
    inputs:
        - description: string
          multiple: false
          name: string
          required: false
          sensitive: false
          type: string
          value: string
    logLevel: string
    machineInstanceSize: string
    name: string
    node: string
    restartPolicy: string
    tags:
        - id: string
          name: string
    version: string

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

    Version string
    [NAME-VERSION] the version of the hub algorithm
    Description string
    optional description to add details of the resource
    Inputs List<Splight.Splight.Inputs.AlgorithmInput>
    static config parameters of the routine
    LogLevel string
    log level of the algorithm
    MachineInstanceSize string
    instance size
    Name string
    the name of the algorithm to be created
    Node string
    id of the compute node where the algorithm runs
    RestartPolicy string
    restart policy of the algorithm
    Tags List<Splight.Splight.Inputs.AlgorithmTag>
    tags of the resource
    Version string
    [NAME-VERSION] the version of the hub algorithm
    Description string
    optional description to add details of the resource
    Inputs []AlgorithmInputTypeArgs
    static config parameters of the routine
    LogLevel string
    log level of the algorithm
    MachineInstanceSize string
    instance size
    Name string
    the name of the algorithm to be created
    Node string
    id of the compute node where the algorithm runs
    RestartPolicy string
    restart policy of the algorithm
    Tags []AlgorithmTagArgs
    tags of the resource
    version String
    [NAME-VERSION] the version of the hub algorithm
    description String
    optional description to add details of the resource
    inputs List<AlgorithmInput>
    static config parameters of the routine
    logLevel String
    log level of the algorithm
    machineInstanceSize String
    instance size
    name String
    the name of the algorithm to be created
    node String
    id of the compute node where the algorithm runs
    restartPolicy String
    restart policy of the algorithm
    tags List<AlgorithmTag>
    tags of the resource
    version string
    [NAME-VERSION] the version of the hub algorithm
    description string
    optional description to add details of the resource
    inputs AlgorithmInput[]
    static config parameters of the routine
    logLevel string
    log level of the algorithm
    machineInstanceSize string
    instance size
    name string
    the name of the algorithm to be created
    node string
    id of the compute node where the algorithm runs
    restartPolicy string
    restart policy of the algorithm
    tags AlgorithmTag[]
    tags of the resource
    version str
    [NAME-VERSION] the version of the hub algorithm
    description str
    optional description to add details of the resource
    inputs Sequence[AlgorithmInputArgs]
    static config parameters of the routine
    log_level str
    log level of the algorithm
    machine_instance_size str
    instance size
    name str
    the name of the algorithm to be created
    node str
    id of the compute node where the algorithm runs
    restart_policy str
    restart policy of the algorithm
    tags Sequence[AlgorithmTagArgs]
    tags of the resource
    version String
    [NAME-VERSION] the version of the hub algorithm
    description String
    optional description to add details of the resource
    inputs List<Property Map>
    static config parameters of the routine
    logLevel String
    log level of the algorithm
    machineInstanceSize String
    instance size
    name String
    the name of the algorithm to be created
    node String
    id of the compute node where the algorithm runs
    restartPolicy String
    restart policy of the algorithm
    tags List<Property Map>
    tags of the resource

    Outputs

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

    Get an existing Algorithm 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?: AlgorithmState, opts?: CustomResourceOptions): Algorithm
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        inputs: Optional[Sequence[AlgorithmInputArgs]] = None,
        log_level: Optional[str] = None,
        machine_instance_size: Optional[str] = None,
        name: Optional[str] = None,
        node: Optional[str] = None,
        restart_policy: Optional[str] = None,
        tags: Optional[Sequence[AlgorithmTagArgs]] = None,
        version: Optional[str] = None) -> Algorithm
    func GetAlgorithm(ctx *Context, name string, id IDInput, state *AlgorithmState, opts ...ResourceOption) (*Algorithm, error)
    public static Algorithm Get(string name, Input<string> id, AlgorithmState? state, CustomResourceOptions? opts = null)
    public static Algorithm get(String name, Output<String> id, AlgorithmState state, CustomResourceOptions options)
    resources:  _:    type: splight:Algorithm    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
    optional description to add details of the resource
    Inputs List<Splight.Splight.Inputs.AlgorithmInput>
    static config parameters of the routine
    LogLevel string
    log level of the algorithm
    MachineInstanceSize string
    instance size
    Name string
    the name of the algorithm to be created
    Node string
    id of the compute node where the algorithm runs
    RestartPolicy string
    restart policy of the algorithm
    Tags List<Splight.Splight.Inputs.AlgorithmTag>
    tags of the resource
    Version string
    [NAME-VERSION] the version of the hub algorithm
    Description string
    optional description to add details of the resource
    Inputs []AlgorithmInputTypeArgs
    static config parameters of the routine
    LogLevel string
    log level of the algorithm
    MachineInstanceSize string
    instance size
    Name string
    the name of the algorithm to be created
    Node string
    id of the compute node where the algorithm runs
    RestartPolicy string
    restart policy of the algorithm
    Tags []AlgorithmTagArgs
    tags of the resource
    Version string
    [NAME-VERSION] the version of the hub algorithm
    description String
    optional description to add details of the resource
    inputs List<AlgorithmInput>
    static config parameters of the routine
    logLevel String
    log level of the algorithm
    machineInstanceSize String
    instance size
    name String
    the name of the algorithm to be created
    node String
    id of the compute node where the algorithm runs
    restartPolicy String
    restart policy of the algorithm
    tags List<AlgorithmTag>
    tags of the resource
    version String
    [NAME-VERSION] the version of the hub algorithm
    description string
    optional description to add details of the resource
    inputs AlgorithmInput[]
    static config parameters of the routine
    logLevel string
    log level of the algorithm
    machineInstanceSize string
    instance size
    name string
    the name of the algorithm to be created
    node string
    id of the compute node where the algorithm runs
    restartPolicy string
    restart policy of the algorithm
    tags AlgorithmTag[]
    tags of the resource
    version string
    [NAME-VERSION] the version of the hub algorithm
    description str
    optional description to add details of the resource
    inputs Sequence[AlgorithmInputArgs]
    static config parameters of the routine
    log_level str
    log level of the algorithm
    machine_instance_size str
    instance size
    name str
    the name of the algorithm to be created
    node str
    id of the compute node where the algorithm runs
    restart_policy str
    restart policy of the algorithm
    tags Sequence[AlgorithmTagArgs]
    tags of the resource
    version str
    [NAME-VERSION] the version of the hub algorithm
    description String
    optional description to add details of the resource
    inputs List<Property Map>
    static config parameters of the routine
    logLevel String
    log level of the algorithm
    machineInstanceSize String
    instance size
    name String
    the name of the algorithm to be created
    node String
    id of the compute node where the algorithm runs
    restartPolicy String
    restart policy of the algorithm
    tags List<Property Map>
    tags of the resource
    version String
    [NAME-VERSION] the version of the hub algorithm

    Supporting Types

    AlgorithmInput, AlgorithmInputArgs

    Name string
    Type string
    Description string
    Multiple bool
    Required bool
    Sensitive bool
    Value string
    Name string
    Type string
    Description string
    Multiple bool
    Required bool
    Sensitive bool
    Value string
    name String
    type String
    description String
    multiple Boolean
    required Boolean
    sensitive Boolean
    value String
    name string
    type string
    description string
    multiple boolean
    required boolean
    sensitive boolean
    value string
    name String
    type String
    description String
    multiple Boolean
    required Boolean
    sensitive Boolean
    value String

    AlgorithmTag, AlgorithmTagArgs

    Id string
    tag id
    Name string
    tag name
    Id string
    tag id
    Name string
    tag name
    id String
    tag id
    name String
    tag name
    id string
    tag id
    name string
    tag name
    id str
    tag id
    name str
    tag name
    id String
    tag id
    name String
    tag name

    Import

    $ pulumi import splight:index/algorithm:Algorithm [options] splight_algorithm.<name> <algorithm_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 splight Terraform Provider.
    splight logo
    splight v1.2.13 published on Friday, Feb 14, 2025 by splightplatform
    splightplatform/pulumi-splight