1. Packages
  2. Snowflake Provider
  3. API Docs
  4. getComputePools
Snowflake v2.1.0 published on Thursday, Jun 26, 2025 by Pulumi

snowflake.getComputePools

Explore with Pulumi AI

snowflake logo
Snowflake v2.1.0 published on Thursday, Jun 26, 2025 by Pulumi

    !> Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to preview_features_enabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

    Data source used to get details of filtered compute pools. Filtering is aligned with the current possibilities for SHOW COMPUTE POOLS query. The results of SHOW and DESCRIBE are encapsulated in one output collection compute_pools.

    Using getComputePools

    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 getComputePools(args: GetComputePoolsArgs, opts?: InvokeOptions): Promise<GetComputePoolsResult>
    function getComputePoolsOutput(args: GetComputePoolsOutputArgs, opts?: InvokeOptions): Output<GetComputePoolsResult>
    def get_compute_pools(like: Optional[str] = None,
                          limit: Optional[GetComputePoolsLimit] = None,
                          starts_with: Optional[str] = None,
                          with_describe: Optional[bool] = None,
                          opts: Optional[InvokeOptions] = None) -> GetComputePoolsResult
    def get_compute_pools_output(like: Optional[pulumi.Input[str]] = None,
                          limit: Optional[pulumi.Input[GetComputePoolsLimitArgs]] = None,
                          starts_with: Optional[pulumi.Input[str]] = None,
                          with_describe: Optional[pulumi.Input[bool]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetComputePoolsResult]
    func GetComputePools(ctx *Context, args *GetComputePoolsArgs, opts ...InvokeOption) (*GetComputePoolsResult, error)
    func GetComputePoolsOutput(ctx *Context, args *GetComputePoolsOutputArgs, opts ...InvokeOption) GetComputePoolsResultOutput

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

    public static class GetComputePools 
    {
        public static Task<GetComputePoolsResult> InvokeAsync(GetComputePoolsArgs args, InvokeOptions? opts = null)
        public static Output<GetComputePoolsResult> Invoke(GetComputePoolsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetComputePoolsResult> getComputePools(GetComputePoolsArgs args, InvokeOptions options)
    public static Output<GetComputePoolsResult> getComputePools(GetComputePoolsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: snowflake:index/getComputePools:getComputePools
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe bool
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe bool
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe Boolean
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    startsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe boolean
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    starts_with str
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    with_describe bool
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit Property Map
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe Boolean
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.

    getComputePools Result

    The following output properties are available:

    ComputePools List<GetComputePoolsComputePool>
    Holds the aggregated output of all compute pools details queries.
    Id string
    The provider-assigned unique ID for this managed resource.
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe bool
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    ComputePools []GetComputePoolsComputePool
    Holds the aggregated output of all compute pools details queries.
    Id string
    The provider-assigned unique ID for this managed resource.
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe bool
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    computePools List<GetComputePoolsComputePool>
    Holds the aggregated output of all compute pools details queries.
    id String
    The provider-assigned unique ID for this managed resource.
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe Boolean
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    computePools GetComputePoolsComputePool[]
    Holds the aggregated output of all compute pools details queries.
    id string
    The provider-assigned unique ID for this managed resource.
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    startsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe boolean
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    compute_pools Sequence[GetComputePoolsComputePool]
    Holds the aggregated output of all compute pools details queries.
    id str
    The provider-assigned unique ID for this managed resource.
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetComputePoolsLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    starts_with str
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    with_describe bool
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.
    computePools List<Property Map>
    Holds the aggregated output of all compute pools details queries.
    id String
    The provider-assigned unique ID for this managed resource.
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit Property Map
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with starts_with or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe Boolean
    (Default: true) Runs DESC COMPUTE POOL for each compute pool returned by SHOW COMPUTE POOLS. The output of describe is saved to the description field. By default this value is set to true.

    Supporting Types

    GetComputePoolsComputePool

    DescribeOutputs List<GetComputePoolsComputePoolDescribeOutput>
    Holds the output of DESCRIBE COMPUTE POOL.
    ShowOutputs List<GetComputePoolsComputePoolShowOutput>
    Holds the output of SHOW COMPUTE POOLS.
    DescribeOutputs []GetComputePoolsComputePoolDescribeOutput
    Holds the output of DESCRIBE COMPUTE POOL.
    ShowOutputs []GetComputePoolsComputePoolShowOutput
    Holds the output of SHOW COMPUTE POOLS.
    describeOutputs List<GetComputePoolsComputePoolDescribeOutput>
    Holds the output of DESCRIBE COMPUTE POOL.
    showOutputs List<GetComputePoolsComputePoolShowOutput>
    Holds the output of SHOW COMPUTE POOLS.
    describeOutputs GetComputePoolsComputePoolDescribeOutput[]
    Holds the output of DESCRIBE COMPUTE POOL.
    showOutputs GetComputePoolsComputePoolShowOutput[]
    Holds the output of SHOW COMPUTE POOLS.
    describe_outputs Sequence[GetComputePoolsComputePoolDescribeOutput]
    Holds the output of DESCRIBE COMPUTE POOL.
    show_outputs Sequence[GetComputePoolsComputePoolShowOutput]
    Holds the output of SHOW COMPUTE POOLS.
    describeOutputs List<Property Map>
    Holds the output of DESCRIBE COMPUTE POOL.
    showOutputs List<Property Map>
    Holds the output of SHOW COMPUTE POOLS.

    GetComputePoolsComputePoolDescribeOutput

    activeNodes Integer
    application String
    autoResume Boolean
    autoSuspendSecs Integer
    comment String
    createdOn String
    errorCode String
    idleNodes Integer
    instanceFamily String
    isExclusive Boolean
    maxNodes Integer
    minNodes Integer
    name String
    numJobs Integer
    numServices Integer
    owner String
    resumedOn String
    state String
    statusMessage String
    targetNodes Integer
    updatedOn String
    activeNodes number
    application string
    autoResume boolean
    autoSuspendSecs number
    comment string
    createdOn string
    errorCode string
    idleNodes number
    instanceFamily string
    isExclusive boolean
    maxNodes number
    minNodes number
    name string
    numJobs number
    numServices number
    owner string
    resumedOn string
    state string
    statusMessage string
    targetNodes number
    updatedOn string
    activeNodes Number
    application String
    autoResume Boolean
    autoSuspendSecs Number
    comment String
    createdOn String
    errorCode String
    idleNodes Number
    instanceFamily String
    isExclusive Boolean
    maxNodes Number
    minNodes Number
    name String
    numJobs Number
    numServices Number
    owner String
    resumedOn String
    state String
    statusMessage String
    targetNodes Number
    updatedOn String

    GetComputePoolsComputePoolShowOutput

    activeNodes Integer
    application String
    autoResume Boolean
    autoSuspendSecs Integer
    comment String
    createdOn String
    idleNodes Integer
    instanceFamily String
    isExclusive Boolean
    maxNodes Integer
    minNodes Integer
    name String
    numJobs Integer
    numServices Integer
    owner String
    resumedOn String
    state String
    targetNodes Integer
    updatedOn String
    activeNodes number
    application string
    autoResume boolean
    autoSuspendSecs number
    comment string
    createdOn string
    idleNodes number
    instanceFamily string
    isExclusive boolean
    maxNodes number
    minNodes number
    name string
    numJobs number
    numServices number
    owner string
    resumedOn string
    state string
    targetNodes number
    updatedOn string
    activeNodes Number
    application String
    autoResume Boolean
    autoSuspendSecs Number
    comment String
    createdOn String
    idleNodes Number
    instanceFamily String
    isExclusive Boolean
    maxNodes Number
    minNodes Number
    name String
    numJobs Number
    numServices Number
    owner String
    resumedOn String
    state String
    targetNodes Number
    updatedOn String

    GetComputePoolsLimit

    Rows int
    The maximum number of rows to return.
    From string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    Rows int
    The maximum number of rows to return.
    From string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows Integer
    The maximum number of rows to return.
    from String
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows number
    The maximum number of rows to return.
    from string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows int
    The maximum number of rows to return.
    from_ str
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows Number
    The maximum number of rows to return.
    from String
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v2.1.0 published on Thursday, Jun 26, 2025 by Pulumi