1. Packages
  2. Standard Library
  3. API Docs
  4. substr
StandardLibrary v2.3.2 published on Tuesday, Feb 10, 2026 by Pulumi
std logo
StandardLibrary v2.3.2 published on Tuesday, Feb 10, 2026 by Pulumi

    Extracts a substring from the given string.

    Using substr

    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 substr(args: SubstrArgs, opts?: InvokeOptions): Promise<SubstrResult>
    function substrOutput(args: SubstrOutputArgs, opts?: InvokeOptions): Output<SubstrResult>
    def substr(input: Optional[str] = None,
               length: Optional[int] = None,
               offset: Optional[int] = None,
               opts: Optional[InvokeOptions] = None) -> SubstrResult
    def substr_output(input: Optional[pulumi.Input[str]] = None,
               length: Optional[pulumi.Input[int]] = None,
               offset: Optional[pulumi.Input[int]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[SubstrResult]
    func Substr(ctx *Context, args *SubstrArgs, opts ...InvokeOption) (*SubstrResult, error)
    func SubstrOutput(ctx *Context, args *SubstrOutputArgs, opts ...InvokeOption) SubstrResultOutput

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

    public static class Substr 
    {
        public static Task<SubstrResult> InvokeAsync(SubstrArgs args, InvokeOptions? opts = null)
        public static Output<SubstrResult> Invoke(SubstrInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<SubstrResult> substr(SubstrArgs args, InvokeOptions options)
    public static Output<SubstrResult> substr(SubstrArgs args, InvokeOptions options)
    
    fn::invoke:
      function: std:substr
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Input string
    Length int
    Offset int
    Input string
    Length int
    Offset int
    input String
    length Integer
    offset Integer
    input string
    length number
    offset number
    input str
    length int
    offset int
    input String
    length Number
    offset Number

    substr Result

    The following output properties are available:

    Result string
    Result string
    result String
    result string
    result str
    result String

    Package Details

    Repository
    std pulumi/pulumi-std
    License
    std logo
    StandardLibrary v2.3.2 published on Tuesday, Feb 10, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate