1. Packages
  2. Snowflake Provider
  3. API Docs
  4. ApiIntegration
Snowflake v2.12.0 published on Friday, Feb 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

snowflake.ApiIntegration

snowflake logo
Snowflake v2.12.0 published on Friday, Feb 13, 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 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.

    Note Currently, API integrations for git_https_api API provider are not supported. It will be added in the future.

    Example Usage

    Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

    import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const aws = new snowflake.ApiIntegration("aws", {
    name: "aws_integration",
    apiProvider: "aws_api_gateway",
    apiAwsRoleArn: "arn:aws:iam::000000000001:/role/test",
    apiAllowedPrefixes: ["https://123456.execute-api.us-west-2.amazonaws.com/prod/"],
    enabled: true,
});
const azure = new snowflake.ApiIntegration("azure", {
    name: "azure_integration",
    apiProvider: "azure_api_management",
    azureTenantId: "00000000-0000-0000-0000-000000000000",
    azureAdApplicationId: "11111111-1111-1111-1111-111111111111",
    apiAllowedPrefixes: ["https://apim-hello-world.azure-api.net/"],
    enabled: true,
});
const gcp = new snowflake.ApiIntegration("gcp", {
    name: "gcp_integration",
    apiProvider: "google_api_gateway",
    googleAudience: "api-gateway-id-123456.apigateway.gcp-project.cloud.goog",
    apiAllowedPrefixes: ["https://gateway-id-123456.uc.gateway.dev/"],
    enabled: true,
});

    import pulumi
import pulumi_snowflake as snowflake

aws = snowflake.ApiIntegration("aws",
    name="aws_integration",
    api_provider="aws_api_gateway",
    api_aws_role_arn="arn:aws:iam::000000000001:/role/test",
    api_allowed_prefixes=["https://123456.execute-api.us-west-2.amazonaws.com/prod/"],
    enabled=True)
azure = snowflake.ApiIntegration("azure",
    name="azure_integration",
    api_provider="azure_api_management",
    azure_tenant_id="00000000-0000-0000-0000-000000000000",
    azure_ad_application_id="11111111-1111-1111-1111-111111111111",
    api_allowed_prefixes=["https://apim-hello-world.azure-api.net/"],
    enabled=True)
gcp = snowflake.ApiIntegration("gcp",
    name="gcp_integration",
    api_provider="google_api_gateway",
    google_audience="api-gateway-id-123456.apigateway.gcp-project.cloud.goog",
    api_allowed_prefixes=["https://gateway-id-123456.uc.gateway.dev/"],
    enabled=True)

    package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := snowflake.NewApiIntegration(ctx, "aws", &snowflake.ApiIntegrationArgs{
			Name:          pulumi.String("aws_integration"),
			ApiProvider:   pulumi.String("aws_api_gateway"),
			ApiAwsRoleArn: pulumi.String("arn:aws:iam::000000000001:/role/test"),
			ApiAllowedPrefixes: pulumi.StringArray{
				pulumi.String("https://123456.execute-api.us-west-2.amazonaws.com/prod/"),
			},
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = snowflake.NewApiIntegration(ctx, "azure", &snowflake.ApiIntegrationArgs{
			Name:                 pulumi.String("azure_integration"),
			ApiProvider:          pulumi.String("azure_api_management"),
			AzureTenantId:        pulumi.String("00000000-0000-0000-0000-000000000000"),
			AzureAdApplicationId: pulumi.String("11111111-1111-1111-1111-111111111111"),
			ApiAllowedPrefixes: pulumi.StringArray{
				pulumi.String("https://apim-hello-world.azure-api.net/"),
			},
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = snowflake.NewApiIntegration(ctx, "gcp", &snowflake.ApiIntegrationArgs{
			Name:           pulumi.String("gcp_integration"),
			ApiProvider:    pulumi.String("google_api_gateway"),
			GoogleAudience: pulumi.String("api-gateway-id-123456.apigateway.gcp-project.cloud.goog"),
			ApiAllowedPrefixes: pulumi.StringArray{
				pulumi.String("https://gateway-id-123456.uc.gateway.dev/"),
			},
			Enabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    var aws = new Snowflake.ApiIntegration("aws", new()
    {
        Name = "aws_integration",
        ApiProvider = "aws_api_gateway",
        ApiAwsRoleArn = "arn:aws:iam::000000000001:/role/test",
        ApiAllowedPrefixes = new[]
        {
            "https://123456.execute-api.us-west-2.amazonaws.com/prod/",
        },
        Enabled = true,
    });

    var azure = new Snowflake.ApiIntegration("azure", new()
    {
        Name = "azure_integration",
        ApiProvider = "azure_api_management",
        AzureTenantId = "00000000-0000-0000-0000-000000000000",
        AzureAdApplicationId = "11111111-1111-1111-1111-111111111111",
        ApiAllowedPrefixes = new[]
        {
            "https://apim-hello-world.azure-api.net/",
        },
        Enabled = true,
    });

    var gcp = new Snowflake.ApiIntegration("gcp", new()
    {
        Name = "gcp_integration",
        ApiProvider = "google_api_gateway",
        GoogleAudience = "api-gateway-id-123456.apigateway.gcp-project.cloud.goog",
        ApiAllowedPrefixes = new[]
        {
            "https://gateway-id-123456.uc.gateway.dev/",
        },
        Enabled = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.ApiIntegration;
import com.pulumi.snowflake.ApiIntegrationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var aws = new ApiIntegration("aws", ApiIntegrationArgs.builder()
            .name("aws_integration")
            .apiProvider("aws_api_gateway")
            .apiAwsRoleArn("arn:aws:iam::000000000001:/role/test")
            .apiAllowedPrefixes("https://123456.execute-api.us-west-2.amazonaws.com/prod/")
            .enabled(true)
            .build());

        var azure = new ApiIntegration("azure", ApiIntegrationArgs.builder()
            .name("azure_integration")
            .apiProvider("azure_api_management")
            .azureTenantId("00000000-0000-0000-0000-000000000000")
            .azureAdApplicationId("11111111-1111-1111-1111-111111111111")
            .apiAllowedPrefixes("https://apim-hello-world.azure-api.net/")
            .enabled(true)
            .build());

        var gcp = new ApiIntegration("gcp", ApiIntegrationArgs.builder()
            .name("gcp_integration")
            .apiProvider("google_api_gateway")
            .googleAudience("api-gateway-id-123456.apigateway.gcp-project.cloud.goog")
            .apiAllowedPrefixes("https://gateway-id-123456.uc.gateway.dev/")
            .enabled(true)
            .build());

    }
}

    resources:
  aws:
    type: snowflake:ApiIntegration
    properties:
      name: aws_integration
      apiProvider: aws_api_gateway
      apiAwsRoleArn: arn:aws:iam::000000000001:/role/test
      apiAllowedPrefixes:
        - https://123456.execute-api.us-west-2.amazonaws.com/prod/
      enabled: true
  azure:
    type: snowflake:ApiIntegration
    properties:
      name: azure_integration
      apiProvider: azure_api_management
      azureTenantId: 00000000-0000-0000-0000-000000000000
      azureAdApplicationId: 11111111-1111-1111-1111-111111111111
      apiAllowedPrefixes:
        - https://apim-hello-world.azure-api.net/
      enabled: true
  gcp:
    type: snowflake:ApiIntegration
    properties:
      name: gcp_integration
      apiProvider: google_api_gateway
      googleAudience: api-gateway-id-123456.apigateway.gcp-project.cloud.goog
      apiAllowedPrefixes:
        - https://gateway-id-123456.uc.gateway.dev/
      enabled: true

    Note If a field has a default value, it is shown next to the type in the schema.

    Create ApiIntegration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiIntegration(name: string, args: ApiIntegrationArgs, opts?: CustomResourceOptions);
    @overload
def ApiIntegration(resource_name: str,
                   args: ApiIntegrationArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ApiIntegration(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_allowed_prefixes: Optional[Sequence[str]] = None,
                   api_provider: Optional[str] = None,
                   api_aws_role_arn: Optional[str] = None,
                   api_blocked_prefixes: Optional[Sequence[str]] = None,
                   api_gcp_service_account: Optional[str] = None,
                   api_key: Optional[str] = None,
                   azure_ad_application_id: Optional[str] = None,
                   azure_tenant_id: Optional[str] = None,
                   comment: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   google_audience: Optional[str] = None,
                   name: Optional[str] = None)
    func NewApiIntegration(ctx *Context, name string, args ApiIntegrationArgs, opts ...ResourceOption) (*ApiIntegration, error)
    public ApiIntegration(string name, ApiIntegrationArgs args, CustomResourceOptions? opts = null)
    public ApiIntegration(String name, ApiIntegrationArgs args)
public ApiIntegration(String name, ApiIntegrationArgs args, CustomResourceOptions options)

    type: snowflake:ApiIntegration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiIntegrationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiIntegrationResource = new Snowflake.ApiIntegration("apiIntegrationResource", new()
{
    ApiAllowedPrefixes = new[]
    {
        "string",
    },
    ApiProvider = "string",
    ApiAwsRoleArn = "string",
    ApiBlockedPrefixes = new[]
    {
        "string",
    },
    ApiGcpServiceAccount = "string",
    ApiKey = "string",
    AzureAdApplicationId = "string",
    AzureTenantId = "string",
    Comment = "string",
    Enabled = false,
    GoogleAudience = "string",
    Name = "string",
});

    example, err := snowflake.NewApiIntegration(ctx, "apiIntegrationResource", &snowflake.ApiIntegrationArgs{
	ApiAllowedPrefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiProvider:   pulumi.String("string"),
	ApiAwsRoleArn: pulumi.String("string"),
	ApiBlockedPrefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiGcpServiceAccount: pulumi.String("string"),
	ApiKey:               pulumi.String("string"),
	AzureAdApplicationId: pulumi.String("string"),
	AzureTenantId:        pulumi.String("string"),
	Comment:              pulumi.String("string"),
	Enabled:              pulumi.Bool(false),
	GoogleAudience:       pulumi.String("string"),
	Name:                 pulumi.String("string"),
})

    var apiIntegrationResource = new ApiIntegration("apiIntegrationResource", ApiIntegrationArgs.builder()
    .apiAllowedPrefixes("string")
    .apiProvider("string")
    .apiAwsRoleArn("string")
    .apiBlockedPrefixes("string")
    .apiGcpServiceAccount("string")
    .apiKey("string")
    .azureAdApplicationId("string")
    .azureTenantId("string")
    .comment("string")
    .enabled(false)
    .googleAudience("string")
    .name("string")
    .build());

    api_integration_resource = snowflake.ApiIntegration("apiIntegrationResource",
    api_allowed_prefixes=["string"],
    api_provider="string",
    api_aws_role_arn="string",
    api_blocked_prefixes=["string"],
    api_gcp_service_account="string",
    api_key="string",
    azure_ad_application_id="string",
    azure_tenant_id="string",
    comment="string",
    enabled=False,
    google_audience="string",
    name="string")

    const apiIntegrationResource = new snowflake.ApiIntegration("apiIntegrationResource", {
    apiAllowedPrefixes: ["string"],
    apiProvider: "string",
    apiAwsRoleArn: "string",
    apiBlockedPrefixes: ["string"],
    apiGcpServiceAccount: "string",
    apiKey: "string",
    azureAdApplicationId: "string",
    azureTenantId: "string",
    comment: "string",
    enabled: false,
    googleAudience: "string",
    name: "string",
});

    type: snowflake:ApiIntegration
properties:
    apiAllowedPrefixes:
        - string
    apiAwsRoleArn: string
    apiBlockedPrefixes:
        - string
    apiGcpServiceAccount: string
    apiKey: string
    apiProvider: string
    azureAdApplicationId: string
    azureTenantId: string
    comment: string
    enabled: false
    googleAudience: string
    name: string

    ApiIntegration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApiIntegration resource accepts the following input properties:

    ApiAllowedPrefixes List<string>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    ApiProvider string
    Specifies the HTTPS proxy service type.
    ApiAwsRoleArn string
    (Default: ``) ARN of a cloud platform role.
    ApiBlockedPrefixes List<string>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    ApiGcpServiceAccount string
    The service account used for communication with the Google API Gateway.
    ApiKey string
    The API key (also called a “subscription key”).
    AzureAdApplicationId string
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    AzureTenantId string
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    Comment string
    Enabled bool
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    GoogleAudience string
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    Name string
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    ApiAllowedPrefixes []string
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    ApiProvider string
    Specifies the HTTPS proxy service type.
    ApiAwsRoleArn string
    (Default: ``) ARN of a cloud platform role.
    ApiBlockedPrefixes []string
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    ApiGcpServiceAccount string
    The service account used for communication with the Google API Gateway.
    ApiKey string
    The API key (also called a “subscription key”).
    AzureAdApplicationId string
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    AzureTenantId string
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    Comment string
    Enabled bool
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    GoogleAudience string
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    Name string
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    apiAllowedPrefixes List<String>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    apiProvider String
    Specifies the HTTPS proxy service type.
    apiAwsRoleArn String
    (Default: ``) ARN of a cloud platform role.
    apiBlockedPrefixes List<String>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiGcpServiceAccount String
    The service account used for communication with the Google API Gateway.
    apiKey String
    The API key (also called a “subscription key”).
    azureAdApplicationId String
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    azureTenantId String
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    comment String
    enabled Boolean
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    googleAudience String
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    name String
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    apiAllowedPrefixes string[]
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    apiProvider string
    Specifies the HTTPS proxy service type.
    apiAwsRoleArn string
    (Default: ``) ARN of a cloud platform role.
    apiBlockedPrefixes string[]
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiGcpServiceAccount string
    The service account used for communication with the Google API Gateway.
    apiKey string
    The API key (also called a “subscription key”).
    azureAdApplicationId string
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    azureTenantId string
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    comment string
    enabled boolean
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    googleAudience string
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    name string
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    api_allowed_prefixes Sequence[str]
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    api_provider str
    Specifies the HTTPS proxy service type.
    api_aws_role_arn str
    (Default: ``) ARN of a cloud platform role.
    api_blocked_prefixes Sequence[str]
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    api_gcp_service_account str
    The service account used for communication with the Google API Gateway.
    api_key str
    The API key (also called a “subscription key”).
    azure_ad_application_id str
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    azure_tenant_id str
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    comment str
    enabled bool
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    google_audience str
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    name str
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    apiAllowedPrefixes List<String>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    apiProvider String
    Specifies the HTTPS proxy service type.
    apiAwsRoleArn String
    (Default: ``) ARN of a cloud platform role.
    apiBlockedPrefixes List<String>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiGcpServiceAccount String
    The service account used for communication with the Google API Gateway.
    apiKey String
    The API key (also called a “subscription key”).
    azureAdApplicationId String
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    azureTenantId String
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    comment String
    enabled Boolean
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    googleAudience String
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    name String
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiIntegration resource produces the following output properties:

    ApiAwsExternalId string
    The external ID that Snowflake will use when assuming the AWS role.
    ApiAwsIamUserArn string
    The Snowflake user that will attempt to assume the AWS role.
    AzureConsentUrl string
    AzureMultiTenantAppName string
    CreatedOn string
    Date and time when the API integration was created.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    ApiAwsExternalId string
    The external ID that Snowflake will use when assuming the AWS role.
    ApiAwsIamUserArn string
    The Snowflake user that will attempt to assume the AWS role.
    AzureConsentUrl string
    AzureMultiTenantAppName string
    CreatedOn string
    Date and time when the API integration was created.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Id string
    The provider-assigned unique ID for this managed resource.
    apiAwsExternalId String
    The external ID that Snowflake will use when assuming the AWS role.
    apiAwsIamUserArn String
    The Snowflake user that will attempt to assume the AWS role.
    azureConsentUrl String
    azureMultiTenantAppName String
    createdOn String
    Date and time when the API integration was created.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.
    apiAwsExternalId string
    The external ID that Snowflake will use when assuming the AWS role.
    apiAwsIamUserArn string
    The Snowflake user that will attempt to assume the AWS role.
    azureConsentUrl string
    azureMultiTenantAppName string
    createdOn string
    Date and time when the API integration was created.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    id string
    The provider-assigned unique ID for this managed resource.
    api_aws_external_id str
    The external ID that Snowflake will use when assuming the AWS role.
    api_aws_iam_user_arn str
    The Snowflake user that will attempt to assume the AWS role.
    azure_consent_url str
    azure_multi_tenant_app_name str
    created_on str
    Date and time when the API integration was created.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    id str
    The provider-assigned unique ID for this managed resource.
    apiAwsExternalId String
    The external ID that Snowflake will use when assuming the AWS role.
    apiAwsIamUserArn String
    The Snowflake user that will attempt to assume the AWS role.
    azureConsentUrl String
    azureMultiTenantAppName String
    createdOn String
    Date and time when the API integration was created.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApiIntegration Resource

    Get an existing ApiIntegration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiIntegrationState, opts?: CustomResourceOptions): ApiIntegration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_allowed_prefixes: Optional[Sequence[str]] = None,
        api_aws_external_id: Optional[str] = None,
        api_aws_iam_user_arn: Optional[str] = None,
        api_aws_role_arn: Optional[str] = None,
        api_blocked_prefixes: Optional[Sequence[str]] = None,
        api_gcp_service_account: Optional[str] = None,
        api_key: Optional[str] = None,
        api_provider: Optional[str] = None,
        azure_ad_application_id: Optional[str] = None,
        azure_consent_url: Optional[str] = None,
        azure_multi_tenant_app_name: Optional[str] = None,
        azure_tenant_id: Optional[str] = None,
        comment: Optional[str] = None,
        created_on: Optional[str] = None,
        enabled: Optional[bool] = None,
        fully_qualified_name: Optional[str] = None,
        google_audience: Optional[str] = None,
        name: Optional[str] = None) -> ApiIntegration
    func GetApiIntegration(ctx *Context, name string, id IDInput, state *ApiIntegrationState, opts ...ResourceOption) (*ApiIntegration, error)
    public static ApiIntegration Get(string name, Input<string> id, ApiIntegrationState? state, CustomResourceOptions? opts = null)
    public static ApiIntegration get(String name, Output<String> id, ApiIntegrationState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:ApiIntegration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiAllowedPrefixes List<string>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    ApiAwsExternalId string
    The external ID that Snowflake will use when assuming the AWS role.
    ApiAwsIamUserArn string
    The Snowflake user that will attempt to assume the AWS role.
    ApiAwsRoleArn string
    (Default: ``) ARN of a cloud platform role.
    ApiBlockedPrefixes List<string>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    ApiGcpServiceAccount string
    The service account used for communication with the Google API Gateway.
    ApiKey string
    The API key (also called a “subscription key”).
    ApiProvider string
    Specifies the HTTPS proxy service type.
    AzureAdApplicationId string
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    AzureConsentUrl string
    AzureMultiTenantAppName string
    AzureTenantId string
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    Comment string
    CreatedOn string
    Date and time when the API integration was created.
    Enabled bool
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    GoogleAudience string
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    Name string
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    ApiAllowedPrefixes []string
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    ApiAwsExternalId string
    The external ID that Snowflake will use when assuming the AWS role.
    ApiAwsIamUserArn string
    The Snowflake user that will attempt to assume the AWS role.
    ApiAwsRoleArn string
    (Default: ``) ARN of a cloud platform role.
    ApiBlockedPrefixes []string
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    ApiGcpServiceAccount string
    The service account used for communication with the Google API Gateway.
    ApiKey string
    The API key (also called a “subscription key”).
    ApiProvider string
    Specifies the HTTPS proxy service type.
    AzureAdApplicationId string
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    AzureConsentUrl string
    AzureMultiTenantAppName string
    AzureTenantId string
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    Comment string
    CreatedOn string
    Date and time when the API integration was created.
    Enabled bool
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    GoogleAudience string
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    Name string
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    apiAllowedPrefixes List<String>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    apiAwsExternalId String
    The external ID that Snowflake will use when assuming the AWS role.
    apiAwsIamUserArn String
    The Snowflake user that will attempt to assume the AWS role.
    apiAwsRoleArn String
    (Default: ``) ARN of a cloud platform role.
    apiBlockedPrefixes List<String>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiGcpServiceAccount String
    The service account used for communication with the Google API Gateway.
    apiKey String
    The API key (also called a “subscription key”).
    apiProvider String
    Specifies the HTTPS proxy service type.
    azureAdApplicationId String
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    azureConsentUrl String
    azureMultiTenantAppName String
    azureTenantId String
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    comment String
    createdOn String
    Date and time when the API integration was created.
    enabled Boolean
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    googleAudience String
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    name String
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    apiAllowedPrefixes string[]
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    apiAwsExternalId string
    The external ID that Snowflake will use when assuming the AWS role.
    apiAwsIamUserArn string
    The Snowflake user that will attempt to assume the AWS role.
    apiAwsRoleArn string
    (Default: ``) ARN of a cloud platform role.
    apiBlockedPrefixes string[]
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiGcpServiceAccount string
    The service account used for communication with the Google API Gateway.
    apiKey string
    The API key (also called a “subscription key”).
    apiProvider string
    Specifies the HTTPS proxy service type.
    azureAdApplicationId string
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    azureConsentUrl string
    azureMultiTenantAppName string
    azureTenantId string
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    comment string
    createdOn string
    Date and time when the API integration was created.
    enabled boolean
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    googleAudience string
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    name string
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    api_allowed_prefixes Sequence[str]
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    api_aws_external_id str
    The external ID that Snowflake will use when assuming the AWS role.
    api_aws_iam_user_arn str
    The Snowflake user that will attempt to assume the AWS role.
    api_aws_role_arn str
    (Default: ``) ARN of a cloud platform role.
    api_blocked_prefixes Sequence[str]
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    api_gcp_service_account str
    The service account used for communication with the Google API Gateway.
    api_key str
    The API key (also called a “subscription key”).
    api_provider str
    Specifies the HTTPS proxy service type.
    azure_ad_application_id str
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    azure_consent_url str
    azure_multi_tenant_app_name str
    azure_tenant_id str
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    comment str
    created_on str
    Date and time when the API integration was created.
    enabled bool
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    google_audience str
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    name str
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.
    apiAllowedPrefixes List<String>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
    apiAwsExternalId String
    The external ID that Snowflake will use when assuming the AWS role.
    apiAwsIamUserArn String
    The Snowflake user that will attempt to assume the AWS role.
    apiAwsRoleArn String
    (Default: ``) ARN of a cloud platform role.
    apiBlockedPrefixes List<String>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiGcpServiceAccount String
    The service account used for communication with the Google API Gateway.
    apiKey String
    The API key (also called a “subscription key”).
    apiProvider String
    Specifies the HTTPS proxy service type.
    azureAdApplicationId String
    (Default: ``) The 'Application (client) id' of the Azure AD app for your remote service.
    azureConsentUrl String
    azureMultiTenantAppName String
    azureTenantId String
    (Default: ``) Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
    comment String
    createdOn String
    Date and time when the API integration was created.
    enabled Boolean
    (Default: true) Specifies whether this API integration is enabled or disabled. If the API integration is disabled, any external function that relies on it will not work.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    googleAudience String
    (Default: ``) The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
    name String
    Specifies the name of the API integration. This name follows the rules for Object Identifiers. The name should be unique among api integrations in your account.

    Import

    $ pulumi import snowflake:index/apiIntegration:ApiIntegration example name

    To learn more about importing existing cloud resources, see Importing resources.

    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.12.0 published on Friday, Feb 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-snowflake
      Meet Neo: Your AI Platform Teammate