Snowflake

Pulumi Official
Package maintained by Pulumi
v0.12.0 published on Wednesday, Jul 20, 2022 by Pulumi

ApiIntegration

Import

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

Example Usage

using Pulumi;
using Snowflake = Pulumi.Snowflake;

class MyStack : Stack
{
    public MyStack()
    {
        var apiIntegration = new Snowflake.ApiIntegration("apiIntegration", new Snowflake.ApiIntegrationArgs
        {
            ApiAllowedPrefixes = 
            {
                "https://123456.execute-api.us-west-2.amazonaws.com/prod/",
            },
            ApiAwsRoleArn = "arn:aws:iam::000000000001:/role/test",
            ApiProvider = "aws_api_gateway",
            Enabled = true,
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := snowflake.NewApiIntegration(ctx, "apiIntegration", &snowflake.ApiIntegrationArgs{
			ApiAllowedPrefixes: pulumi.StringArray{
				pulumi.String("https://123456.execute-api.us-west-2.amazonaws.com/prod/"),
			},
			ApiAwsRoleArn: pulumi.String("arn:aws:iam::000000000001:/role/test"),
			ApiProvider:   pulumi.String("aws_api_gateway"),
			Enabled:       pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

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

    }
}
import pulumi
import pulumi_snowflake as snowflake

api_integration = snowflake.ApiIntegration("apiIntegration",
    api_allowed_prefixes=["https://123456.execute-api.us-west-2.amazonaws.com/prod/"],
    api_aws_role_arn="arn:aws:iam::000000000001:/role/test",
    api_provider="aws_api_gateway",
    enabled=True)
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const apiIntegration = new snowflake.ApiIntegration("api_integration", {
    apiAllowedPrefixes: ["https://123456.execute-api.us-west-2.amazonaws.com/prod/"],
    apiAwsRoleArn: "arn:aws:iam::000000000001:/role/test",
    apiProvider: "aws_api_gateway",
    enabled: true,
});
resources:
  apiIntegration:
    type: snowflake:ApiIntegration
    properties:
      apiAllowedPrefixes:
        - https://123456.execute-api.us-west-2.amazonaws.com/prod/
      apiAwsRoleArn: arn:aws:iam::000000000001:/role/test
      apiProvider: aws_api_gateway
      enabled: true

Create a ApiIntegration Resource

new ApiIntegration(name: string, args: ApiIntegrationArgs, opts?: CustomResourceOptions);
@overload
def ApiIntegration(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_allowed_prefixes: Optional[Sequence[str]] = None,
                   api_aws_role_arn: Optional[str] = None,
                   api_blocked_prefixes: Optional[Sequence[str]] = None,
                   api_provider: Optional[str] = None,
                   azure_ad_application_id: Optional[str] = None,
                   azure_tenant_id: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   name: Optional[str] = None)
@overload
def ApiIntegration(resource_name: str,
                   args: ApiIntegrationArgs,
                   opts: Optional[ResourceOptions] = 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.

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.

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

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

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.

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.

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.

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

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.

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.

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.

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

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.

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.

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.

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

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.

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.

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.

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

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.

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.

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.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

id String

The provider-assigned unique ID for this managed resource.

Look up an 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_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,
        created_on: Optional[str] = None,
        enabled: Optional[bool] = 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)
Resource lookup is not supported in YAML
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

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.

ApiProvider 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.

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.

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

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.

ApiProvider 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.

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.

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

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.

apiProvider 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.

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.

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

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.

apiProvider 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.

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.

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

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_provider 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.

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.

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

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.

apiProvider 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.

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.

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.

Package Details

Repository
https://github.com/pulumi/pulumi-snowflake
License
Apache-2.0
Notes

This Pulumi package is based on the snowflake Terraform Provider.