snowflake.getComputePools
Explore with Pulumi AI
!> 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - Starts
With string - 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - Starts
With string - 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - 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 withstarts_with
orlike
. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe 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:
- Compute
Pools List<GetCompute Pools Compute Pool> - 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - Starts
With string - 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.
- Compute
Pools []GetCompute Pools Compute Pool - 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - Starts
With string - 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.
- compute
Pools List<GetCompute Pools Compute Pool> - 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe 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 GetCompute Pools Compute Pool[] - 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - starts
With string - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe 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[GetCompute Pools Compute Pool] - 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
Get
Compute Pools Limit - 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 withstarts_with
orlike
. - 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.
- compute
Pools 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 withstarts_with
orlike
. - starts
With String - Filters the output with case-sensitive characters indicating the beginning of the object name.
- with
Describe 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
- Describe
Outputs List<GetCompute Pools Compute Pool Describe Output> - Holds the output of DESCRIBE COMPUTE POOL.
- Show
Outputs List<GetCompute Pools Compute Pool Show Output> - Holds the output of SHOW COMPUTE POOLS.
- Describe
Outputs []GetCompute Pools Compute Pool Describe Output - Holds the output of DESCRIBE COMPUTE POOL.
- Show
Outputs []GetCompute Pools Compute Pool Show Output - Holds the output of SHOW COMPUTE POOLS.
- describe
Outputs List<GetCompute Pools Compute Pool Describe Output> - Holds the output of DESCRIBE COMPUTE POOL.
- show
Outputs List<GetCompute Pools Compute Pool Show Output> - Holds the output of SHOW COMPUTE POOLS.
- describe
Outputs GetCompute Pools Compute Pool Describe Output[] - Holds the output of DESCRIBE COMPUTE POOL.
- show
Outputs GetCompute Pools Compute Pool Show Output[] - Holds the output of SHOW COMPUTE POOLS.
- describe_
outputs Sequence[GetCompute Pools Compute Pool Describe Output] - Holds the output of DESCRIBE COMPUTE POOL.
- show_
outputs Sequence[GetCompute Pools Compute Pool Show Output] - Holds the output of SHOW COMPUTE POOLS.
- describe
Outputs List<Property Map> - Holds the output of DESCRIBE COMPUTE POOL.
- show
Outputs List<Property Map> - Holds the output of SHOW COMPUTE POOLS.
GetComputePoolsComputePoolDescribeOutput
- Active
Nodes int - Application string
- Auto
Resume bool - Auto
Suspend intSecs - Comment string
- Created
On string - Error
Code string - Idle
Nodes int - Instance
Family string - Is
Exclusive bool - Max
Nodes int - Min
Nodes int - Name string
- Num
Jobs int - Num
Services int - Owner string
- Resumed
On string - State string
- Status
Message string - Target
Nodes int - Updated
On string
- Active
Nodes int - Application string
- Auto
Resume bool - Auto
Suspend intSecs - Comment string
- Created
On string - Error
Code string - Idle
Nodes int - Instance
Family string - Is
Exclusive bool - Max
Nodes int - Min
Nodes int - Name string
- Num
Jobs int - Num
Services int - Owner string
- Resumed
On string - State string
- Status
Message string - Target
Nodes int - Updated
On string
- active
Nodes Integer - application String
- auto
Resume Boolean - auto
Suspend IntegerSecs - comment String
- created
On String - error
Code String - idle
Nodes Integer - instance
Family String - is
Exclusive Boolean - max
Nodes Integer - min
Nodes Integer - name String
- num
Jobs Integer - num
Services Integer - owner String
- resumed
On String - state String
- status
Message String - target
Nodes Integer - updated
On String
- active
Nodes number - application string
- auto
Resume boolean - auto
Suspend numberSecs - comment string
- created
On string - error
Code string - idle
Nodes number - instance
Family string - is
Exclusive boolean - max
Nodes number - min
Nodes number - name string
- num
Jobs number - num
Services number - owner string
- resumed
On string - state string
- status
Message string - target
Nodes number - updated
On string
- active_
nodes int - application str
- auto_
resume bool - auto_
suspend_ intsecs - comment str
- created_
on str - error_
code str - idle_
nodes int - instance_
family str - is_
exclusive bool - max_
nodes int - min_
nodes int - name str
- num_
jobs int - num_
services int - owner str
- resumed_
on str - state str
- status_
message str - target_
nodes int - updated_
on str
- active
Nodes Number - application String
- auto
Resume Boolean - auto
Suspend NumberSecs - comment String
- created
On String - error
Code String - idle
Nodes Number - instance
Family String - is
Exclusive Boolean - max
Nodes Number - min
Nodes Number - name String
- num
Jobs Number - num
Services Number - owner String
- resumed
On String - state String
- status
Message String - target
Nodes Number - updated
On String
GetComputePoolsComputePoolShowOutput
- Active
Nodes int - Application string
- Auto
Resume bool - Auto
Suspend intSecs - Comment string
- Created
On string - Idle
Nodes int - Instance
Family string - Is
Exclusive bool - Max
Nodes int - Min
Nodes int - Name string
- Num
Jobs int - Num
Services int - Owner string
- Resumed
On string - State string
- Target
Nodes int - Updated
On string
- Active
Nodes int - Application string
- Auto
Resume bool - Auto
Suspend intSecs - Comment string
- Created
On string - Idle
Nodes int - Instance
Family string - Is
Exclusive bool - Max
Nodes int - Min
Nodes int - Name string
- Num
Jobs int - Num
Services int - Owner string
- Resumed
On string - State string
- Target
Nodes int - Updated
On string
- active
Nodes Integer - application String
- auto
Resume Boolean - auto
Suspend IntegerSecs - comment String
- created
On String - idle
Nodes Integer - instance
Family String - is
Exclusive Boolean - max
Nodes Integer - min
Nodes Integer - name String
- num
Jobs Integer - num
Services Integer - owner String
- resumed
On String - state String
- target
Nodes Integer - updated
On String
- active
Nodes number - application string
- auto
Resume boolean - auto
Suspend numberSecs - comment string
- created
On string - idle
Nodes number - instance
Family string - is
Exclusive boolean - max
Nodes number - min
Nodes number - name string
- num
Jobs number - num
Services number - owner string
- resumed
On string - state string
- target
Nodes number - updated
On string
- active_
nodes int - application str
- auto_
resume bool - auto_
suspend_ intsecs - comment str
- created_
on str - idle_
nodes int - instance_
family str - is_
exclusive bool - max_
nodes int - min_
nodes int - name str
- num_
jobs int - num_
services int - owner str
- resumed_
on str - state str
- target_
nodes int - updated_
on str
- active
Nodes Number - application String
- auto
Resume Boolean - auto
Suspend NumberSecs - comment String
- created
On String - idle
Nodes Number - instance
Family String - is
Exclusive Boolean - max
Nodes Number - min
Nodes Number - name String
- num
Jobs Number - num
Services Number - owner String
- resumed
On String - state String
- target
Nodes Number - updated
On String
GetComputePoolsLimit
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflake
Terraform Provider.