1. Packages
  2. Linode Provider
  3. API Docs
  4. getStackScript
Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi

linode.getStackScript

Explore with Pulumi AI

linode logo
Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi

    Provides details about a specific Linode StackScript. For more information, see the Linode APIv4 docs.

    Example Usage

    The following example shows how one might use this data source to access information about a Linode StackScript.

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const myStackscript = linode.getStackScript({
        id: "355872",
    });
    
    import pulumi
    import pulumi_linode as linode
    
    my_stackscript = linode.get_stack_script(id="355872")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.LookupStackScript(ctx, &linode.LookupStackScriptArgs{
    			Id: "355872",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var myStackscript = Linode.GetStackScript.Invoke(new()
        {
            Id = "355872",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.LinodeFunctions;
    import com.pulumi.linode.inputs.GetStackScriptArgs;
    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) {
            final var myStackscript = LinodeFunctions.getStackScript(GetStackScriptArgs.builder()
                .id(355872)
                .build());
    
        }
    }
    
    variables:
      myStackscript:
        fn::invoke:
          Function: linode:getStackScript
          Arguments:
            id: 355872
    

    Using getStackScript

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStackScript(args: GetStackScriptArgs, opts?: InvokeOptions): Promise<GetStackScriptResult>
    function getStackScriptOutput(args: GetStackScriptOutputArgs, opts?: InvokeOptions): Output<GetStackScriptResult>
    def get_stack_script(id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetStackScriptResult
    def get_stack_script_output(id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetStackScriptResult]
    func LookupStackScript(ctx *Context, args *LookupStackScriptArgs, opts ...InvokeOption) (*LookupStackScriptResult, error)
    func LookupStackScriptOutput(ctx *Context, args *LookupStackScriptOutputArgs, opts ...InvokeOption) LookupStackScriptResultOutput

    > Note: This function is named LookupStackScript in the Go SDK.

    public static class GetStackScript 
    {
        public static Task<GetStackScriptResult> InvokeAsync(GetStackScriptArgs args, InvokeOptions? opts = null)
        public static Output<GetStackScriptResult> Invoke(GetStackScriptInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStackScriptResult> getStackScript(GetStackScriptArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: linode:index/getStackScript:getStackScript
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The unique numeric ID of the StackScript to query.
    Id string
    The unique numeric ID of the StackScript to query.
    id String
    The unique numeric ID of the StackScript to query.
    id string
    The unique numeric ID of the StackScript to query.
    id str
    The unique numeric ID of the StackScript to query.
    id String
    The unique numeric ID of the StackScript to query.

    getStackScript Result

    The following output properties are available:

    Created string
    The date this StackScript was created.
    DeploymentsActive int
    Count of currently active, deployed Linodes created from this StackScript.
    DeploymentsTotal int
    The total number of times this StackScript has been deployed.
    Description string
    A description for the StackScript.
    Id string
    Images List<string>
    A set of Image IDs representing the Images that this StackScript is compatible for deploying with. any/all indicates that all available image distributions, including private images, are accepted.
    IsPublic bool
    This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.
    Label string
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    RevNote string
    This field allows you to add notes for the set of revisions made to this StackScript.
    Script string
    The script to execute when provisioning a new Linode with this StackScript.
    Updated string
    The date this StackScript was updated.
    UserDefinedFields List<GetStackScriptUserDefinedField>
    This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment.
    UserGravatarId string
    The Gravatar ID for the User who created the StackScript.
    Username string
    The User who created the StackScript.
    Created string
    The date this StackScript was created.
    DeploymentsActive int
    Count of currently active, deployed Linodes created from this StackScript.
    DeploymentsTotal int
    The total number of times this StackScript has been deployed.
    Description string
    A description for the StackScript.
    Id string
    Images []string
    A set of Image IDs representing the Images that this StackScript is compatible for deploying with. any/all indicates that all available image distributions, including private images, are accepted.
    IsPublic bool
    This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.
    Label string
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    RevNote string
    This field allows you to add notes for the set of revisions made to this StackScript.
    Script string
    The script to execute when provisioning a new Linode with this StackScript.
    Updated string
    The date this StackScript was updated.
    UserDefinedFields []GetStackScriptUserDefinedField
    This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment.
    UserGravatarId string
    The Gravatar ID for the User who created the StackScript.
    Username string
    The User who created the StackScript.
    created String
    The date this StackScript was created.
    deploymentsActive Integer
    Count of currently active, deployed Linodes created from this StackScript.
    deploymentsTotal Integer
    The total number of times this StackScript has been deployed.
    description String
    A description for the StackScript.
    id String
    images List<String>
    A set of Image IDs representing the Images that this StackScript is compatible for deploying with. any/all indicates that all available image distributions, including private images, are accepted.
    isPublic Boolean
    This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.
    label String
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    revNote String
    This field allows you to add notes for the set of revisions made to this StackScript.
    script String
    The script to execute when provisioning a new Linode with this StackScript.
    updated String
    The date this StackScript was updated.
    userDefinedFields List<GetStackScriptUserDefinedField>
    This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment.
    userGravatarId String
    The Gravatar ID for the User who created the StackScript.
    username String
    The User who created the StackScript.
    created string
    The date this StackScript was created.
    deploymentsActive number
    Count of currently active, deployed Linodes created from this StackScript.
    deploymentsTotal number
    The total number of times this StackScript has been deployed.
    description string
    A description for the StackScript.
    id string
    images string[]
    A set of Image IDs representing the Images that this StackScript is compatible for deploying with. any/all indicates that all available image distributions, including private images, are accepted.
    isPublic boolean
    This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.
    label string
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    revNote string
    This field allows you to add notes for the set of revisions made to this StackScript.
    script string
    The script to execute when provisioning a new Linode with this StackScript.
    updated string
    The date this StackScript was updated.
    userDefinedFields GetStackScriptUserDefinedField[]
    This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment.
    userGravatarId string
    The Gravatar ID for the User who created the StackScript.
    username string
    The User who created the StackScript.
    created str
    The date this StackScript was created.
    deployments_active int
    Count of currently active, deployed Linodes created from this StackScript.
    deployments_total int
    The total number of times this StackScript has been deployed.
    description str
    A description for the StackScript.
    id str
    images Sequence[str]
    A set of Image IDs representing the Images that this StackScript is compatible for deploying with. any/all indicates that all available image distributions, including private images, are accepted.
    is_public bool
    This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.
    label str
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    rev_note str
    This field allows you to add notes for the set of revisions made to this StackScript.
    script str
    The script to execute when provisioning a new Linode with this StackScript.
    updated str
    The date this StackScript was updated.
    user_defined_fields Sequence[GetStackScriptUserDefinedField]
    This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment.
    user_gravatar_id str
    The Gravatar ID for the User who created the StackScript.
    username str
    The User who created the StackScript.
    created String
    The date this StackScript was created.
    deploymentsActive Number
    Count of currently active, deployed Linodes created from this StackScript.
    deploymentsTotal Number
    The total number of times this StackScript has been deployed.
    description String
    A description for the StackScript.
    id String
    images List<String>
    A set of Image IDs representing the Images that this StackScript is compatible for deploying with. any/all indicates that all available image distributions, including private images, are accepted.
    isPublic Boolean
    This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private.
    label String
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    revNote String
    This field allows you to add notes for the set of revisions made to this StackScript.
    script String
    The script to execute when provisioning a new Linode with this StackScript.
    updated String
    The date this StackScript was updated.
    userDefinedFields List<Property Map>
    This is a list of fields defined with a special syntax inside this StackScript that allow for supplying customized parameters during deployment.
    userGravatarId String
    The Gravatar ID for the User who created the StackScript.
    username String
    The User who created the StackScript.

    Supporting Types

    GetStackScriptUserDefinedField

    Default string
    The default value. If not specified, this value will be used.
    Example string
    An example value for the field.
    Label string
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    ManyOf string
    A list of acceptable values for the field in any quantity, combination or order.
    Name string
    The name of the field.
    OneOf string
    A list of acceptable single values for the field.
    Default string
    The default value. If not specified, this value will be used.
    Example string
    An example value for the field.
    Label string
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    ManyOf string
    A list of acceptable values for the field in any quantity, combination or order.
    Name string
    The name of the field.
    OneOf string
    A list of acceptable single values for the field.
    default_ String
    The default value. If not specified, this value will be used.
    example String
    An example value for the field.
    label String
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    manyOf String
    A list of acceptable values for the field in any quantity, combination or order.
    name String
    The name of the field.
    oneOf String
    A list of acceptable single values for the field.
    default string
    The default value. If not specified, this value will be used.
    example string
    An example value for the field.
    label string
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    manyOf string
    A list of acceptable values for the field in any quantity, combination or order.
    name string
    The name of the field.
    oneOf string
    A list of acceptable single values for the field.
    default str
    The default value. If not specified, this value will be used.
    example str
    An example value for the field.
    label str
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    many_of str
    A list of acceptable values for the field in any quantity, combination or order.
    name str
    The name of the field.
    one_of str
    A list of acceptable single values for the field.
    default String
    The default value. If not specified, this value will be used.
    example String
    An example value for the field.
    label String
    A human-readable label for the field that will serve as the input prompt for entering the value during deployment.
    manyOf String
    A list of acceptable values for the field in any quantity, combination or order.
    name String
    The name of the field.
    oneOf String
    A list of acceptable single values for the field.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.30.1 published on Thursday, Nov 21, 2024 by Pulumi