snowflake.getExternalVolumes

Snowflake v2.15.0, May 9 26

Viewing docs for Snowflake v2.15.0
published on Saturday, May 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

Viewing docs for Snowflake v2.15.0
published on Saturday, May 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

!> 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 previewFeaturesEnabled 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 external volumes. Filtering is aligned with the current possibilities for SHOW EXTERNAL VOLUMES query. The results of SHOW and DESCRIBE are encapsulated in one output collection externalVolumes.

Using getExternalVolumes

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 getExternalVolumes(args: GetExternalVolumesArgs, opts?: InvokeOptions): Promise<GetExternalVolumesResult>
function getExternalVolumesOutput(args: GetExternalVolumesOutputArgs, opts?: InvokeOptions): Output<GetExternalVolumesResult>

def get_external_volumes(like: Optional[str] = None,
                         with_describe: Optional[bool] = None,
                         opts: Optional[InvokeOptions] = None) -> GetExternalVolumesResult
def get_external_volumes_output(like: pulumi.Input[Optional[str]] = None,
                         with_describe: pulumi.Input[Optional[bool]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetExternalVolumesResult]

func GetExternalVolumes(ctx *Context, args *GetExternalVolumesArgs, opts ...InvokeOption) (*GetExternalVolumesResult, error)
func GetExternalVolumesOutput(ctx *Context, args *GetExternalVolumesOutputArgs, opts ...InvokeOption) GetExternalVolumesResultOutput

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

public static class GetExternalVolumes 
{
    public static Task<GetExternalVolumesResult> InvokeAsync(GetExternalVolumesArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalVolumesResult> Invoke(GetExternalVolumesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalVolumesResult> getExternalVolumes(GetExternalVolumesArgs args, InvokeOptions options)
public static Output<GetExternalVolumesResult> getExternalVolumes(GetExternalVolumesArgs args, InvokeOptions options)

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

data "snowflake_getexternalvolumes" "name" {
    # arguments
}

The following arguments are supported:

Like string: Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
WithDescribe bool: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput 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 _).
WithDescribe bool: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput 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 _).
with_describe bool: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput 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 _).
withDescribe Boolean: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput 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 _).
withDescribe boolean: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput 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 _).
with_describe bool: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput 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 _).
withDescribe Boolean: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput field. By default this value is set to true.

getExternalVolumes Result

The following output properties are available:

ExternalVolumes List<GetExternalVolumesExternalVolume>: Holds the aggregated output of all external volume 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 _).
WithDescribe bool: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput field. By default this value is set to true.

ExternalVolumes []GetExternalVolumesExternalVolume: Holds the aggregated output of all external volume 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 _).
WithDescribe bool: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput field. By default this value is set to true.

external_volumes list(object): Holds the aggregated output of all external volume 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 _).
with_describe bool: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput field. By default this value is set to true.

externalVolumes List<GetExternalVolumesExternalVolume>: Holds the aggregated output of all external volume 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 _).
withDescribe Boolean: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput field. By default this value is set to true.

externalVolumes GetExternalVolumesExternalVolume[]: Holds the aggregated output of all external volume 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 _).
withDescribe boolean: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput field. By default this value is set to true.

external_volumes Sequence[GetExternalVolumesExternalVolume]: Holds the aggregated output of all external volume 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 _).
with_describe bool: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput field. By default this value is set to true.

externalVolumes List<Property Map>: Holds the aggregated output of all external volume 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 _).
withDescribe Boolean: (Default: true) Runs DESC EXTERNAL VOLUME for each external volume returned by SHOW EXTERNAL VOLUMES. The output of describe is saved to the describeOutput field. By default this value is set to true.

Supporting Types

GetExternalVolumesExternalVolume

DescribeOutputs List<GetExternalVolumesExternalVolumeDescribeOutput>: Holds the output of DESCRIBE EXTERNAL VOLUME.
ShowOutputs List<GetExternalVolumesExternalVolumeShowOutput>: Holds the output of SHOW EXTERNAL VOLUMES.

DescribeOutputs []GetExternalVolumesExternalVolumeDescribeOutput: Holds the output of DESCRIBE EXTERNAL VOLUME.
ShowOutputs []GetExternalVolumesExternalVolumeShowOutput: Holds the output of SHOW EXTERNAL VOLUMES.

describe_outputs list(object): Holds the output of DESCRIBE EXTERNAL VOLUME.
show_outputs list(object): Holds the output of SHOW EXTERNAL VOLUMES.