published on Saturday, May 9, 2026 by Pulumi
published on Saturday, May 9, 2026 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 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 catalog integrations. Filtering is aligned with the current possibilities for SHOW CATALOG INTEGRATIONS query. The results of SHOW and DESCRIBE are encapsulated in one output collection catalogIntegrations.
Using getCatalogIntegrations
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 getCatalogIntegrations(args: GetCatalogIntegrationsArgs, opts?: InvokeOptions): Promise<GetCatalogIntegrationsResult>
function getCatalogIntegrationsOutput(args: GetCatalogIntegrationsOutputArgs, opts?: InvokeOptions): Output<GetCatalogIntegrationsResult>def get_catalog_integrations(like: Optional[str] = None,
with_describe: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetCatalogIntegrationsResult
def get_catalog_integrations_output(like: pulumi.Input[Optional[str]] = None,
with_describe: pulumi.Input[Optional[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCatalogIntegrationsResult]func GetCatalogIntegrations(ctx *Context, args *GetCatalogIntegrationsArgs, opts ...InvokeOption) (*GetCatalogIntegrationsResult, error)
func GetCatalogIntegrationsOutput(ctx *Context, args *GetCatalogIntegrationsOutputArgs, opts ...InvokeOption) GetCatalogIntegrationsResultOutput> Note: This function is named GetCatalogIntegrations in the Go SDK.
public static class GetCatalogIntegrations
{
public static Task<GetCatalogIntegrationsResult> InvokeAsync(GetCatalogIntegrationsArgs args, InvokeOptions? opts = null)
public static Output<GetCatalogIntegrationsResult> Invoke(GetCatalogIntegrationsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCatalogIntegrationsResult> getCatalogIntegrations(GetCatalogIntegrationsArgs args, InvokeOptions options)
public static Output<GetCatalogIntegrationsResult> getCatalogIntegrations(GetCatalogIntegrationsArgs args, InvokeOptions options)
fn::invoke:
function: snowflake:index/getCatalogIntegrations:getCatalogIntegrations
arguments:
# arguments dictionaryThe following arguments are supported:
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - With
Describe bool - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. 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_). - With
Describe bool - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. 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_). - with
Describe Boolean - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. 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_). - with
Describe boolean - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. 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_). - with_
describe bool - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. 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_). - with
Describe Boolean - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. The output of describe is saved to the description field. By default this value is set to true.
getCatalogIntegrations Result
The following output properties are available:
- Catalog
Integrations List<GetCatalog Integrations Catalog Integration> - Holds the aggregated output of all catalog integrations 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 CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. The output of describe is saved to the description field. By default this value is set to true.
- Catalog
Integrations []GetCatalog Integrations Catalog Integration - Holds the aggregated output of all catalog integrations 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 CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. The output of describe is saved to the description field. By default this value is set to true.
- catalog
Integrations List<GetCatalog Integrations Catalog Integration> - Holds the aggregated output of all catalog integrations 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 Boolean - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. The output of describe is saved to the description field. By default this value is set to true.
- catalog
Integrations GetCatalog Integrations Catalog Integration[] - Holds the aggregated output of all catalog integrations 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 boolean - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. The output of describe is saved to the description field. By default this value is set to true.
- catalog_
integrations Sequence[GetCatalog Integrations Catalog Integration] - Holds the aggregated output of all catalog integrations 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 CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. The output of describe is saved to the description field. By default this value is set to true.
- catalog
Integrations List<Property Map> - Holds the aggregated output of all catalog integrations 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 Boolean - (Default:
true) Runs DESC CATALOG INTEGRATION for each catalog integration returned by SHOW CATALOG INTEGRATIONS. The output of describe is saved to the description field. By default this value is set to true.
Supporting Types
GetCatalogIntegrationsCatalogIntegration
- Describe
Outputs List<GetCatalog Integrations Catalog Integration Describe Output> - Holds the output of DESCRIBE CATALOG INTEGRATION.
- Show
Outputs List<GetCatalog Integrations Catalog Integration Show Output> - Holds the output of SHOW CATALOG INTEGRATIONS.
- Describe
Outputs []GetCatalog Integrations Catalog Integration Describe Output - Holds the output of DESCRIBE CATALOG INTEGRATION.
- Show
Outputs []GetCatalog Integrations Catalog Integration Show Output - Holds the output of SHOW CATALOG INTEGRATIONS.
- describe
Outputs List<GetCatalog Integrations Catalog Integration Describe Output> - Holds the output of DESCRIBE CATALOG INTEGRATION.
- show
Outputs List<GetCatalog Integrations Catalog Integration Show Output> - Holds the output of SHOW CATALOG INTEGRATIONS.
- describe
Outputs GetCatalog Integrations Catalog Integration Describe Output[] - Holds the output of DESCRIBE CATALOG INTEGRATION.
- show
Outputs GetCatalog Integrations Catalog Integration Show Output[] - Holds the output of SHOW CATALOG INTEGRATIONS.
- describe_
outputs Sequence[GetCatalog Integrations Catalog Integration Describe Output] - Holds the output of DESCRIBE CATALOG INTEGRATION.
- show_
outputs Sequence[GetCatalog Integrations Catalog Integration Show Output] - Holds the output of SHOW CATALOG INTEGRATIONS.
- describe
Outputs List<Property Map> - Holds the output of DESCRIBE CATALOG INTEGRATION.
- show
Outputs List<Property Map> - Holds the output of SHOW CATALOG INTEGRATIONS.
GetCatalogIntegrationsCatalogIntegrationDescribeOutput
- Bearer
Rest List<GetAuthentications Catalog Integrations Catalog Integration Describe Output Bearer Rest Authentication> - Catalog
Namespace string - Catalog
Source string - Comment string
- Enabled bool
- Glue
Aws stringRole Arn - Glue
Catalog stringId - Glue
Region string - Id string
- Oauth
Rest List<GetAuthentications Catalog Integrations Catalog Integration Describe Output Oauth Rest Authentication> - Refresh
Interval intSeconds - Rest
Configs List<GetCatalog Integrations Catalog Integration Describe Output Rest Config> - Sigv4Rest
Authentications List<GetCatalog Integrations Catalog Integration Describe Output Sigv4Rest Authentication> - Table
Format string
- Bearer
Rest []GetAuthentications Catalog Integrations Catalog Integration Describe Output Bearer Rest Authentication - Catalog
Namespace string - Catalog
Source string - Comment string
- Enabled bool
- Glue
Aws stringRole Arn - Glue
Catalog stringId - Glue
Region string - Id string
- Oauth
Rest []GetAuthentications Catalog Integrations Catalog Integration Describe Output Oauth Rest Authentication - Refresh
Interval intSeconds - Rest
Configs []GetCatalog Integrations Catalog Integration Describe Output Rest Config - Sigv4Rest
Authentications []GetCatalog Integrations Catalog Integration Describe Output Sigv4Rest Authentication - Table
Format string
- bearer
Rest List<GetAuthentications Catalog Integrations Catalog Integration Describe Output Bearer Rest Authentication> - catalog
Namespace String - catalog
Source String - comment String
- enabled Boolean
- glue
Aws StringRole Arn - glue
Catalog StringId - glue
Region String - id String
- oauth
Rest List<GetAuthentications Catalog Integrations Catalog Integration Describe Output Oauth Rest Authentication> - refresh
Interval IntegerSeconds - rest
Configs List<GetCatalog Integrations Catalog Integration Describe Output Rest Config> - sigv4Rest
Authentications List<GetCatalog Integrations Catalog Integration Describe Output Sigv4Rest Authentication> - table
Format String
- bearer
Rest GetAuthentications Catalog Integrations Catalog Integration Describe Output Bearer Rest Authentication[] - catalog
Namespace string - catalog
Source string - comment string
- enabled boolean
- glue
Aws stringRole Arn - glue
Catalog stringId - glue
Region string - id string
- oauth
Rest GetAuthentications Catalog Integrations Catalog Integration Describe Output Oauth Rest Authentication[] - refresh
Interval numberSeconds - rest
Configs GetCatalog Integrations Catalog Integration Describe Output Rest Config[] - sigv4Rest
Authentications GetCatalog Integrations Catalog Integration Describe Output Sigv4Rest Authentication[] - table
Format string
- bearer_
rest_ Sequence[Getauthentications Catalog Integrations Catalog Integration Describe Output Bearer Rest Authentication] - catalog_
namespace str - catalog_
source str - comment str
- enabled bool
- glue_
aws_ strrole_ arn - glue_
catalog_ strid - glue_
region str - id str
- oauth_
rest_ Sequence[Getauthentications Catalog Integrations Catalog Integration Describe Output Oauth Rest Authentication] - refresh_
interval_ intseconds - rest_
configs Sequence[GetCatalog Integrations Catalog Integration Describe Output Rest Config] - sigv4_
rest_ Sequence[Getauthentications Catalog Integrations Catalog Integration Describe Output Sigv4Rest Authentication] - table_
format str
- bearer
Rest List<Property Map>Authentications - catalog
Namespace String - catalog
Source String - comment String
- enabled Boolean
- glue
Aws StringRole Arn - glue
Catalog StringId - glue
Region String - id String
- oauth
Rest List<Property Map>Authentications - refresh
Interval NumberSeconds - rest
Configs List<Property Map> - sigv4Rest
Authentications List<Property Map> - table
Format String
GetCatalogIntegrationsCatalogIntegrationDescribeOutputOauthRestAuthentication
- Oauth
Allowed List<string>Scopes - Oauth
Client stringId - Oauth
Token stringUri
- Oauth
Allowed []stringScopes - Oauth
Client stringId - Oauth
Token stringUri
- oauth
Allowed List<String>Scopes - oauth
Client StringId - oauth
Token StringUri
- oauth
Allowed string[]Scopes - oauth
Client stringId - oauth
Token stringUri
- oauth_
allowed_ Sequence[str]scopes - oauth_
client_ strid - oauth_
token_ struri
- oauth
Allowed List<String>Scopes - oauth
Client StringId - oauth
Token StringUri
GetCatalogIntegrationsCatalogIntegrationDescribeOutputRestConfig
- Access
Delegation stringMode - Catalog
Api stringType - Catalog
Name string - Catalog
Uri string - Prefix string
- Access
Delegation stringMode - Catalog
Api stringType - Catalog
Name string - Catalog
Uri string - Prefix string
- access
Delegation StringMode - catalog
Api StringType - catalog
Name String - catalog
Uri String - prefix String
- access
Delegation stringMode - catalog
Api stringType - catalog
Name string - catalog
Uri string - prefix string
- access_
delegation_ strmode - catalog_
api_ strtype - catalog_
name str - catalog_
uri str - prefix str
- access
Delegation StringMode - catalog
Api StringType - catalog
Name String - catalog
Uri String - prefix String
GetCatalogIntegrationsCatalogIntegrationDescribeOutputSigv4RestAuthentication
- Sigv4Iam
Role string - Sigv4Signing
Region string
- Sigv4Iam
Role string - Sigv4Signing
Region string
- sigv4Iam
Role String - sigv4Signing
Region String
- sigv4Iam
Role string - sigv4Signing
Region string
- sigv4Iam
Role String - sigv4Signing
Region String
GetCatalogIntegrationsCatalogIntegrationShowOutput
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflakeTerraform Provider.
published on Saturday, May 9, 2026 by Pulumi
