1. Packages
  2. Standard Library
  3. API Docs
  4. format
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

    Formats a string according to the given format. The syntax for the format is standard sprintf syntax.

    Using format

    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 format(args: FormatArgs, opts?: InvokeOptions): Promise<FormatResult>
    function formatOutput(args: FormatOutputArgs, opts?: InvokeOptions): Output<FormatResult>
    def format(args: Optional[Sequence[Any]] = None,
               input: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> FormatResult
    def format_output(args: Optional[pulumi.Input[Sequence[Any]]] = None,
               input: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[FormatResult]
    func Format(ctx *Context, args *FormatArgs, opts ...InvokeOption) (*FormatResult, error)
    func FormatOutput(ctx *Context, args *FormatOutputArgs, opts ...InvokeOption) FormatResultOutput

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

    public static class Format 
    {
        public static Task<FormatResult> InvokeAsync(FormatArgs args, InvokeOptions? opts = null)
        public static Output<FormatResult> Invoke(FormatInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<FormatResult> format(FormatArgs args, InvokeOptions options)
    public static Output<FormatResult> format(FormatArgs args, InvokeOptions options)
    
    fn::invoke:
      function: std:format
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Args List<object>
    Input string
    Args []interface{}
    Input string
    args List<Object>
    input String
    args any[]
    input string
    args Sequence[Any]
    input str
    args List<Any>
    input String

    format 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