Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Snowflake Provider
  4. API Docs
  5. ApiIntegrationAmazonApiGateway
Viewing docs for Snowflake v2.18.0
published on Wednesday, Jul 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

snowflake.ApiIntegrationAmazonApiGateway

snowflake logo
Viewing docs for Snowflake v2.18.0
published on Wednesday, Jul 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

    Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to previewFeaturesEnabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

    Resource used to manage API integration Amazon API Gateway objects. For more information, check api integration documentation.

    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";

// basic resource
const basic = new snowflake.ApiIntegrationAmazonApiGateway("basic", {
    name: "amazon_api_gateway_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,
});
// complete resource
const complete = new snowflake.ApiIntegrationAmazonApiGateway("complete", {
    name: "amazon_api_gateway_integration_complete",
    apiProvider: "aws_api_gateway",
    apiAwsRoleArn: "arn:aws:iam::000000000001:role/test",
    apiAllowedPrefixes: ["https://123456.execute-api.us-west-2.amazonaws.com/prod/"],
    apiBlockedPrefixes: ["https://123456.execute-api.us-west-2.amazonaws.com/prod/blocked/"],
    apiKey: "my-api-key",
    enabled: true,
    comment: "Example Amazon API Gateway integration",
});

    import pulumi
import pulumi_snowflake as snowflake

# basic resource
basic = snowflake.ApiIntegrationAmazonApiGateway("basic",
    name="amazon_api_gateway_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)
# complete resource
complete = snowflake.ApiIntegrationAmazonApiGateway("complete",
    name="amazon_api_gateway_integration_complete",
    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/"],
    api_blocked_prefixes=["https://123456.execute-api.us-west-2.amazonaws.com/prod/blocked/"],
    api_key="my-api-key",
    enabled=True,
    comment="Example Amazon API Gateway integration")

    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 {
		// basic resource
		_, err := snowflake.NewApiIntegrationAmazonApiGateway(ctx, "basic", &snowflake.ApiIntegrationAmazonApiGatewayArgs{
			Name:          pulumi.String("amazon_api_gateway_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
		}
		// complete resource
		_, err = snowflake.NewApiIntegrationAmazonApiGateway(ctx, "complete", &snowflake.ApiIntegrationAmazonApiGatewayArgs{
			Name:          pulumi.String("amazon_api_gateway_integration_complete"),
			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/"),
			},
			ApiBlockedPrefixes: pulumi.StringArray{
				pulumi.String("https://123456.execute-api.us-west-2.amazonaws.com/prod/blocked/"),
			},
			ApiKey:  pulumi.String("my-api-key"),
			Enabled: pulumi.Bool(true),
			Comment: pulumi.String("Example Amazon API Gateway integration"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // basic resource
    var basic = new Snowflake.ApiIntegrationAmazonApiGateway("basic", new()
    {
        Name = "amazon_api_gateway_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,
    });

    // complete resource
    var complete = new Snowflake.ApiIntegrationAmazonApiGateway("complete", new()
    {
        Name = "amazon_api_gateway_integration_complete",
        ApiProvider = "aws_api_gateway",
        ApiAwsRoleArn = "arn:aws:iam::000000000001:role/test",
        ApiAllowedPrefixes = new[]
        {
            "https://123456.execute-api.us-west-2.amazonaws.com/prod/",
        },
        ApiBlockedPrefixes = new[]
        {
            "https://123456.execute-api.us-west-2.amazonaws.com/prod/blocked/",
        },
        ApiKey = "my-api-key",
        Enabled = true,
        Comment = "Example Amazon API Gateway integration",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.ApiIntegrationAmazonApiGateway;
import com.pulumi.snowflake.ApiIntegrationAmazonApiGatewayArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        // basic resource
        var basic = new ApiIntegrationAmazonApiGateway("basic", ApiIntegrationAmazonApiGatewayArgs.builder()
            .name("amazon_api_gateway_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());

        // complete resource
        var complete = new ApiIntegrationAmazonApiGateway("complete", ApiIntegrationAmazonApiGatewayArgs.builder()
            .name("amazon_api_gateway_integration_complete")
            .apiProvider("aws_api_gateway")
            .apiAwsRoleArn("arn:aws:iam::000000000001:role/test")
            .apiAllowedPrefixes("https://123456.execute-api.us-west-2.amazonaws.com/prod/")
            .apiBlockedPrefixes("https://123456.execute-api.us-west-2.amazonaws.com/prod/blocked/")
            .apiKey("my-api-key")
            .enabled(true)
            .comment("Example Amazon API Gateway integration")
            .build());

    }
}

    resources:
  # basic resource
  basic:
    type: snowflake:ApiIntegrationAmazonApiGateway
    properties:
      name: amazon_api_gateway_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
  # complete resource
  complete:
    type: snowflake:ApiIntegrationAmazonApiGateway
    properties:
      name: amazon_api_gateway_integration_complete
      apiProvider: aws_api_gateway
      apiAwsRoleArn: arn:aws:iam::000000000001:role/test
      apiAllowedPrefixes:
        - https://123456.execute-api.us-west-2.amazonaws.com/prod/
      apiBlockedPrefixes:
        - https://123456.execute-api.us-west-2.amazonaws.com/prod/blocked/
      apiKey: my-api-key
      enabled: true
      comment: Example Amazon API Gateway integration

    pulumi {
  required_providers {
    snowflake = {
      source = "pulumi/snowflake"
    }
  }
}

# basic resource
resource "snowflake_apiintegrationamazonapigateway" "basic" {
  name                 = "amazon_api_gateway_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
}
# complete resource
resource "snowflake_apiintegrationamazonapigateway" "complete" {
  name                 = "amazon_api_gateway_integration_complete"
  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/"]
  api_blocked_prefixes = ["https://123456.execute-api.us-west-2.amazonaws.com/prod/blocked/"]
  api_key              = "my-api-key"
  enabled              = true
  comment              = "Example Amazon API Gateway integration"
}

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

    Create ApiIntegrationAmazonApiGateway Resource

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

    Constructor syntax

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

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

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


    resource "snowflake_api_integration_amazon_api_gateway" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ApiIntegrationAmazonApiGatewayArgs
    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 ApiIntegrationAmazonApiGatewayArgs
    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 ApiIntegrationAmazonApiGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiIntegrationAmazonApiGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiIntegrationAmazonApiGatewayArgs
    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 apiIntegrationAmazonApiGatewayResource = new Snowflake.ApiIntegrationAmazonApiGateway("apiIntegrationAmazonApiGatewayResource", new()
{
    ApiAllowedPrefixes = new[]
    {
        "string",
    },
    ApiAwsRoleArn = "string",
    ApiProvider = "string",
    Enabled = false,
    ApiBlockedPrefixes = new[]
    {
        "string",
    },
    ApiKey = "string",
    Comment = "string",
    Name = "string",
});

    example, err := snowflake.NewApiIntegrationAmazonApiGateway(ctx, "apiIntegrationAmazonApiGatewayResource", &snowflake.ApiIntegrationAmazonApiGatewayArgs{
	ApiAllowedPrefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiAwsRoleArn: pulumi.String("string"),
	ApiProvider:   pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	ApiBlockedPrefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiKey:  pulumi.String("string"),
	Comment: pulumi.String("string"),
	Name:    pulumi.String("string"),
})

    resource "snowflake_api_integration_amazon_api_gateway" "apiIntegrationAmazonApiGatewayResource" {
  lifecycle {
    create_before_destroy = true
  }
  api_allowed_prefixes = ["string"]
  api_aws_role_arn     = "string"
  api_provider         = "string"
  enabled              = false
  api_blocked_prefixes = ["string"]
  api_key              = "string"
  comment              = "string"
  name                 = "string"
}

    var apiIntegrationAmazonApiGatewayResource = new ApiIntegrationAmazonApiGateway("apiIntegrationAmazonApiGatewayResource", ApiIntegrationAmazonApiGatewayArgs.builder()
    .apiAllowedPrefixes("string")
    .apiAwsRoleArn("string")
    .apiProvider("string")
    .enabled(false)
    .apiBlockedPrefixes("string")
    .apiKey("string")
    .comment("string")
    .name("string")
    .build());

    api_integration_amazon_api_gateway_resource = snowflake.ApiIntegrationAmazonApiGateway("apiIntegrationAmazonApiGatewayResource",
    api_allowed_prefixes=["string"],
    api_aws_role_arn="string",
    api_provider="string",
    enabled=False,
    api_blocked_prefixes=["string"],
    api_key="string",
    comment="string",
    name="string")

    const apiIntegrationAmazonApiGatewayResource = new snowflake.ApiIntegrationAmazonApiGateway("apiIntegrationAmazonApiGatewayResource", {
    apiAllowedPrefixes: ["string"],
    apiAwsRoleArn: "string",
    apiProvider: "string",
    enabled: false,
    apiBlockedPrefixes: ["string"],
    apiKey: "string",
    comment: "string",
    name: "string",
});

    type: snowflake:ApiIntegrationAmazonApiGateway
properties:
    apiAllowedPrefixes:
        - string
    apiAwsRoleArn: string
    apiBlockedPrefixes:
        - string
    apiKey: string
    apiProvider: string
    comment: string
    enabled: false
    name: string

    ApiIntegrationAmazonApiGateway 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 ApiIntegrationAmazonApiGateway 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 and remote service endpoints and resources.
    ApiAwsRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    ApiProvider string
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    Enabled bool
    Specifies whether this API integration is enabled or disabled.
    ApiBlockedPrefixes List<string>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    ApiKey string
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Comment string
    Specifies a comment for the integration.
    Name string
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ApiAllowedPrefixes []string
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    ApiAwsRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    ApiProvider string
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    Enabled bool
    Specifies whether this API integration is enabled or disabled.
    ApiBlockedPrefixes []string
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    ApiKey string
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    Comment string
    Specifies a comment for the integration.
    Name string
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    api_allowed_prefixes list(string)
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    api_aws_role_arn string
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    api_provider string
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    enabled bool
    Specifies whether this API integration is enabled or disabled.
    api_blocked_prefixes list(string)
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    api_key string
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment string
    Specifies a comment for the integration.
    name string
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    apiAllowedPrefixes List<String>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    apiAwsRoleArn String
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    apiProvider String
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    enabled Boolean
    Specifies whether this API integration is enabled or disabled.
    apiBlockedPrefixes List<String>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiKey String
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment String
    Specifies a comment for the integration.
    name String
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    apiAllowedPrefixes string[]
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    apiAwsRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    apiProvider string
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    enabled boolean
    Specifies whether this API integration is enabled or disabled.
    apiBlockedPrefixes string[]
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiKey string
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment string
    Specifies a comment for the integration.
    name string
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    api_allowed_prefixes Sequence[str]
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    api_aws_role_arn str
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    api_provider str
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    enabled bool
    Specifies whether this API integration is enabled or disabled.
    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_key str
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment str
    Specifies a comment for the integration.
    name str
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    apiAllowedPrefixes List<String>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    apiAwsRoleArn String
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    apiProvider String
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    enabled Boolean
    Specifies whether this API integration is enabled or disabled.
    apiBlockedPrefixes List<String>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiKey String
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    comment String
    Specifies a comment for the integration.
    name String
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

    Outputs

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

    DescribeOutputs List<ApiIntegrationAmazonApiGatewayDescribeOutput>
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    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.
    ShowOutputs List<ApiIntegrationAmazonApiGatewayShowOutput>
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    DescribeOutputs []ApiIntegrationAmazonApiGatewayDescribeOutput
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    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.
    ShowOutputs []ApiIntegrationAmazonApiGatewayShowOutput
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    describe_outputs list(object)
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    fully_qualified_name 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.
    show_outputs list(object)
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    describeOutputs List<ApiIntegrationAmazonApiGatewayDescribeOutput>
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    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.
    showOutputs List<ApiIntegrationAmazonApiGatewayShowOutput>
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    describeOutputs ApiIntegrationAmazonApiGatewayDescribeOutput[]
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    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.
    showOutputs ApiIntegrationAmazonApiGatewayShowOutput[]
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    describe_outputs Sequence[ApiIntegrationAmazonApiGatewayDescribeOutput]
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    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.
    show_outputs Sequence[ApiIntegrationAmazonApiGatewayShowOutput]
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    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.
    showOutputs List<Property Map>
    Outputs the result of SHOW API INTEGRATIONS for the given integration.

    Look up Existing ApiIntegrationAmazonApiGateway Resource

    Get an existing ApiIntegrationAmazonApiGateway 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?: ApiIntegrationAmazonApiGatewayState, opts?: CustomResourceOptions): ApiIntegrationAmazonApiGateway
    @staticmethod
def get(resource_name: str,
        id: 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_key: Optional[str] = None,
        api_provider: Optional[str] = None,
        comment: Optional[str] = None,
        describe_outputs: Optional[Sequence[ApiIntegrationAmazonApiGatewayDescribeOutputArgs]] = None,
        enabled: Optional[bool] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        show_outputs: Optional[Sequence[ApiIntegrationAmazonApiGatewayShowOutputArgs]] = None) -> ApiIntegrationAmazonApiGateway
    func GetApiIntegrationAmazonApiGateway(ctx *Context, name string, id IDInput, state *ApiIntegrationAmazonApiGatewayState, opts ...ResourceOption) (*ApiIntegrationAmazonApiGateway, error)
    public static ApiIntegrationAmazonApiGateway Get(string name, Input<string> id, ApiIntegrationAmazonApiGatewayState? state, CustomResourceOptions? opts = null)
    public static ApiIntegrationAmazonApiGateway get(String name, Output<String> id, ApiIntegrationAmazonApiGatewayState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:ApiIntegrationAmazonApiGateway    get:      id: ${id}
    import {
  to = snowflake_api_integration_amazon_api_gateway.example
  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 and remote service endpoints and resources.
    ApiAwsRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    ApiBlockedPrefixes List<string>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    ApiKey string
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    ApiProvider string
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    Comment string
    Specifies a comment for the integration.
    DescribeOutputs List<ApiIntegrationAmazonApiGatewayDescribeOutput>
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    Enabled bool
    Specifies whether this API integration is enabled or disabled.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs List<ApiIntegrationAmazonApiGatewayShowOutput>
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    ApiAllowedPrefixes []string
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    ApiAwsRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    ApiBlockedPrefixes []string
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    ApiKey string
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    ApiProvider string
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    Comment string
    Specifies a comment for the integration.
    DescribeOutputs []ApiIntegrationAmazonApiGatewayDescribeOutputArgs
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    Enabled bool
    Specifies whether this API integration is enabled or disabled.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs []ApiIntegrationAmazonApiGatewayShowOutputArgs
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    api_allowed_prefixes list(string)
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    api_aws_role_arn string
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    api_blocked_prefixes list(string)
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    api_key string
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    api_provider string
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    comment string
    Specifies a comment for the integration.
    describe_outputs list(object)
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    enabled bool
    Specifies whether this API integration is enabled or disabled.
    fully_qualified_name string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs list(object)
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    apiAllowedPrefixes List<String>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    apiAwsRoleArn String
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    apiBlockedPrefixes List<String>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiKey String
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    apiProvider String
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    comment String
    Specifies a comment for the integration.
    describeOutputs List<ApiIntegrationAmazonApiGatewayDescribeOutput>
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    enabled Boolean
    Specifies whether this API integration is enabled or disabled.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<ApiIntegrationAmazonApiGatewayShowOutput>
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    apiAllowedPrefixes string[]
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    apiAwsRoleArn string
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    apiBlockedPrefixes string[]
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiKey string
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    apiProvider string
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    comment string
    Specifies a comment for the integration.
    describeOutputs ApiIntegrationAmazonApiGatewayDescribeOutput[]
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    enabled boolean
    Specifies whether this API integration is enabled or disabled.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs ApiIntegrationAmazonApiGatewayShowOutput[]
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    api_allowed_prefixes Sequence[str]
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    api_aws_role_arn str
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    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_key str
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    api_provider str
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    comment str
    Specifies a comment for the integration.
    describe_outputs Sequence[ApiIntegrationAmazonApiGatewayDescribeOutputArgs]
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    enabled bool
    Specifies whether this API integration is enabled or disabled.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    name str
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs Sequence[ApiIntegrationAmazonApiGatewayShowOutputArgs]
    Outputs the result of SHOW API INTEGRATIONS for the given integration.
    apiAllowedPrefixes List<String>
    Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service and remote service endpoints and resources.
    apiAwsRoleArn String
    The Amazon Resource Name (ARN) of the IAM role that grants Snowflake permission to call the API endpoint.
    apiBlockedPrefixes List<String>
    Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
    apiKey String
    Specifies the API key (secret) that Snowflake uses to authenticate when making calls to the proxy service. External changes for this field won't be detected. In case you want to apply external changes, you can re-create the resource manually using "terraform taint".
    apiProvider String
    Specifies the type of AWS gateway. Valid values are (case-insensitive): awsApiGateway | awsPrivateApiGateway | awsGovApiGateway | awsGovPrivateApiGateway.
    comment String
    Specifies a comment for the integration.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE API INTEGRATION for the given integration.
    enabled Boolean
    Specifies whether this API integration is enabled or disabled.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier (i.e. name) for the integration. This value must be unique in your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<Property Map>
    Outputs the result of SHOW API INTEGRATIONS for the given integration.

    Supporting Types

    ApiIntegrationAmazonApiGatewayDescribeOutput, ApiIntegrationAmazonApiGatewayDescribeOutputArgs

    AllowedPrefixes List<string>
    ApiAwsExternalId string
    ApiAwsIamUserArn string
    ApiAwsRoleArn string
    ApiKey string
    ApiProvider string
    BlockedPrefixes List<string>
    Comment string
    Enabled bool
    allowedPrefixes List<String>
    apiAwsExternalId String
    apiAwsIamUserArn String
    apiAwsRoleArn String
    apiKey String
    apiProvider String
    blockedPrefixes List<String>
    comment String
    enabled Boolean
    allowedPrefixes List<String>
    apiAwsExternalId String
    apiAwsIamUserArn String
    apiAwsRoleArn String
    apiKey String
    apiProvider String
    blockedPrefixes List<String>
    comment String
    enabled Boolean

    ApiIntegrationAmazonApiGatewayShowOutput, ApiIntegrationAmazonApiGatewayShowOutputArgs

    ApiType string
    Category string
    Comment string
    CreatedOn string
    Enabled bool
    Name string
    ApiType string
    Category string
    Comment string
    CreatedOn string
    Enabled bool
    Name string
    api_type string
    category string
    comment string
    created_on string
    enabled bool
    name string
    apiType String
    category String
    comment String
    createdOn String
    enabled Boolean
    name String
    apiType string
    category string
    comment string
    createdOn string
    enabled boolean
    name string
    apiType String
    category String
    comment String
    createdOn String
    enabled Boolean
    name String

    Import

    $ pulumi import snowflake:index/apiIntegrationAmazonApiGateway:ApiIntegrationAmazonApiGateway 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
    Viewing docs for Snowflake v2.18.0
    published on Wednesday, Jul 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-snowflake

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial