snowflake.getWarehouses

Explore with Pulumi AI

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

!> V1 release candidate This data source was reworked and is a release candidate for the V1. We do not expect significant changes in it before the V1. We will welcome any feedback and adjust the data source if needed. Any errors reported will be resolved with a higher priority. We encourage checking this data source out before the V1 release. Please follow the migration guide to use it.

Datasource used to get details of filtered warehouses. Filtering is aligned with the current possibilities for SHOW WAREHOUSES query (only like is supported). The results of SHOW, DESCRIBE, and SHOW PARAMETERS IN are encapsulated in one output collection.

Using getWarehouses

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 getWarehouses(args: GetWarehousesArgs, opts?: InvokeOptions): Promise<GetWarehousesResult>
function getWarehousesOutput(args: GetWarehousesOutputArgs, opts?: InvokeOptions): Output<GetWarehousesResult>

def get_warehouses(like: Optional[str] = None,
                   with_describe: Optional[bool] = None,
                   with_parameters: Optional[bool] = None,
                   opts: Optional[InvokeOptions] = None) -> GetWarehousesResult
def get_warehouses_output(like: Optional[pulumi.Input[str]] = None,
                   with_describe: Optional[pulumi.Input[bool]] = None,
                   with_parameters: Optional[pulumi.Input[bool]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetWarehousesResult]

func GetWarehouses(ctx *Context, args *GetWarehousesArgs, opts ...InvokeOption) (*GetWarehousesResult, error)
func GetWarehousesOutput(ctx *Context, args *GetWarehousesOutputArgs, opts ...InvokeOption) GetWarehousesResultOutput

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

public static class GetWarehouses 
{
    public static Task<GetWarehousesResult> InvokeAsync(GetWarehousesArgs args, InvokeOptions? opts = null)
    public static Output<GetWarehousesResult> Invoke(GetWarehousesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWarehousesResult> getWarehouses(GetWarehousesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: snowflake:index/getWarehouses:getWarehouses
  arguments:
    # arguments dictionary

The following arguments are supported:

Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe Boolean: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe boolean: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters boolean: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
with_describe bool: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
with_parameters bool: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe Boolean: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

getWarehouses Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Warehouses List<GetWarehousesWarehouse>: Holds the aggregated output of all warehouse details queries.
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

Id string: The provider-assigned unique ID for this managed resource.
Warehouses []GetWarehousesWarehouse: Holds the aggregated output of all warehouse details queries.
Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
WithParameters bool: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
warehouses List<GetWarehousesWarehouse>: Holds the aggregated output of all warehouse details queries.
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe Boolean: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id string: The provider-assigned unique ID for this managed resource.
warehouses GetWarehousesWarehouse[]: Holds the aggregated output of all warehouse details queries.
like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe boolean: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters boolean: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id str: The provider-assigned unique ID for this managed resource.
warehouses Sequence[GetWarehousesWarehouse]: Holds the aggregated output of all warehouse details queries.
like str: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
with_describe bool: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
with_parameters bool: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
warehouses List<Property Map>: Holds the aggregated output of all warehouse details queries.
like String: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
withDescribe Boolean: Runs DESC WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the description field. By default this value is set to true.
withParameters Boolean: Runs SHOW PARAMETERS FOR WAREHOUSE for each warehouse returned by SHOW WAREHOUSES. The output of describe is saved to the parameters field as a map. By default this value is set to true.