Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. ApiIntegration
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.ApiIntegration

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

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

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 This property is required. string
The unique name of the resource.
args This property is required. ApiIntegrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ApiIntegrationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiIntegrationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
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"),
})
Copy
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());
Copy
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")
Copy
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",
});
Copy
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
Copy

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 This property is required. 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
This property is required.
Changes to this property will trigger replacement.
string
Specifies the HTTPS proxy service type.
ApiAwsRoleArn string
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
The 'Application (client) id' of the Azure AD app for your remote service.
AzureTenantId string
Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
Comment string
Enabled bool
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
Name Changes to this property will trigger replacement. 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 This property is required. []string
Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
ApiProvider
This property is required.
Changes to this property will trigger replacement.
string
Specifies the HTTPS proxy service type.
ApiAwsRoleArn string
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
The 'Application (client) id' of the Azure AD app for your remote service.
AzureTenantId string
Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
Comment string
Enabled bool
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
Name Changes to this property will trigger replacement. 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 This property is required. 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
This property is required.
Changes to this property will trigger replacement.
String
Specifies the HTTPS proxy service type.
apiAwsRoleArn String
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
The 'Application (client) id' of the Azure AD app for your remote service.
azureTenantId String
Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
comment String
enabled Boolean
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
name Changes to this property will trigger replacement. 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 This property is required. string[]
Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
apiProvider
This property is required.
Changes to this property will trigger replacement.
string
Specifies the HTTPS proxy service type.
apiAwsRoleArn string
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
The 'Application (client) id' of the Azure AD app for your remote service.
azureTenantId string
Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
comment string
enabled boolean
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
name Changes to this property will trigger replacement. 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 This property is required. 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
This property is required.
Changes to this property will trigger replacement.
str
Specifies the HTTPS proxy service type.
api_aws_role_arn str
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
The 'Application (client) id' of the Azure AD app for your remote service.
azure_tenant_id str
Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
comment str
enabled bool
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
name Changes to this property will trigger replacement. 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 This property is required. 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
This property is required.
Changes to this property will trigger replacement.
String
Specifies the HTTPS proxy service type.
apiAwsRoleArn String
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
The 'Application (client) id' of the Azure AD app for your remote service.
azureTenantId String
Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
comment String
enabled Boolean
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
name Changes to this property will trigger replacement. 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
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 Changes to this property will trigger replacement. string
Specifies the HTTPS proxy service type.
AzureAdApplicationId string
The 'Application (client) id' of the Azure AD app for your remote service.
AzureConsentUrl string
AzureMultiTenantAppName string
AzureTenantId string
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
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
Name Changes to this property will trigger replacement. 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
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 Changes to this property will trigger replacement. string
Specifies the HTTPS proxy service type.
AzureAdApplicationId string
The 'Application (client) id' of the Azure AD app for your remote service.
AzureConsentUrl string
AzureMultiTenantAppName string
AzureTenantId string
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
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
Name Changes to this property will trigger replacement. 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
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 Changes to this property will trigger replacement. String
Specifies the HTTPS proxy service type.
azureAdApplicationId String
The 'Application (client) id' of the Azure AD app for your remote service.
azureConsentUrl String
azureMultiTenantAppName String
azureTenantId String
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
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
name Changes to this property will trigger replacement. 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
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 Changes to this property will trigger replacement. string
Specifies the HTTPS proxy service type.
azureAdApplicationId string
The 'Application (client) id' of the Azure AD app for your remote service.
azureConsentUrl string
azureMultiTenantAppName string
azureTenantId string
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
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
name Changes to this property will trigger replacement. 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
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 Changes to this property will trigger replacement. str
Specifies the HTTPS proxy service type.
azure_ad_application_id str
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
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
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
name Changes to this property will trigger replacement. 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
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 Changes to this property will trigger replacement. String
Specifies the HTTPS proxy service type.
azureAdApplicationId String
The 'Application (client) id' of the Azure AD app for your remote service.
azureConsentUrl String
azureMultiTenantAppName String
azureTenantId String
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
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
The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
name Changes to this property will trigger replacement. 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.

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake