snowflake.ApiIntegration
Explore with Pulumi AI
Import
$ pulumi import snowflake:index/apiIntegration:ApiIntegration example name
Create ApiIntegration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiIntegration(name: string, args: ApiIntegrationArgs, opts?: CustomResourceOptions);@overload
def ApiIntegration(resource_name: str,
                   args: ApiIntegrationArgs,
                   opts: Optional[ResourceOptions] = None)
@overload
def ApiIntegration(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   api_allowed_prefixes: Optional[Sequence[str]] = None,
                   api_provider: Optional[str] = None,
                   api_aws_role_arn: Optional[str] = None,
                   api_blocked_prefixes: Optional[Sequence[str]] = None,
                   api_gcp_service_account: Optional[str] = None,
                   api_key: Optional[str] = None,
                   azure_ad_application_id: Optional[str] = None,
                   azure_tenant_id: Optional[str] = None,
                   comment: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   google_audience: Optional[str] = None,
                   name: Optional[str] = None)func NewApiIntegration(ctx *Context, name string, args ApiIntegrationArgs, opts ...ResourceOption) (*ApiIntegration, error)public ApiIntegration(string name, ApiIntegrationArgs args, CustomResourceOptions? opts = null)
public ApiIntegration(String name, ApiIntegrationArgs args)
public ApiIntegration(String name, ApiIntegrationArgs args, CustomResourceOptions options)
type: snowflake:ApiIntegration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ApiIntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ApiIntegrationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ApiIntegrationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiIntegrationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiIntegrationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var apiIntegrationResource = new Snowflake.ApiIntegration("apiIntegrationResource", new()
{
    ApiAllowedPrefixes = new[]
    {
        "string",
    },
    ApiProvider = "string",
    ApiAwsRoleArn = "string",
    ApiBlockedPrefixes = new[]
    {
        "string",
    },
    ApiGcpServiceAccount = "string",
    ApiKey = "string",
    AzureAdApplicationId = "string",
    AzureTenantId = "string",
    Comment = "string",
    Enabled = false,
    GoogleAudience = "string",
    Name = "string",
});
example, err := snowflake.NewApiIntegration(ctx, "apiIntegrationResource", &snowflake.ApiIntegrationArgs{
	ApiAllowedPrefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiProvider:   pulumi.String("string"),
	ApiAwsRoleArn: pulumi.String("string"),
	ApiBlockedPrefixes: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiGcpServiceAccount: pulumi.String("string"),
	ApiKey:               pulumi.String("string"),
	AzureAdApplicationId: pulumi.String("string"),
	AzureTenantId:        pulumi.String("string"),
	Comment:              pulumi.String("string"),
	Enabled:              pulumi.Bool(false),
	GoogleAudience:       pulumi.String("string"),
	Name:                 pulumi.String("string"),
})
var apiIntegrationResource = new ApiIntegration("apiIntegrationResource", ApiIntegrationArgs.builder()
    .apiAllowedPrefixes("string")
    .apiProvider("string")
    .apiAwsRoleArn("string")
    .apiBlockedPrefixes("string")
    .apiGcpServiceAccount("string")
    .apiKey("string")
    .azureAdApplicationId("string")
    .azureTenantId("string")
    .comment("string")
    .enabled(false)
    .googleAudience("string")
    .name("string")
    .build());
api_integration_resource = snowflake.ApiIntegration("apiIntegrationResource",
    api_allowed_prefixes=["string"],
    api_provider="string",
    api_aws_role_arn="string",
    api_blocked_prefixes=["string"],
    api_gcp_service_account="string",
    api_key="string",
    azure_ad_application_id="string",
    azure_tenant_id="string",
    comment="string",
    enabled=False,
    google_audience="string",
    name="string")
const apiIntegrationResource = new snowflake.ApiIntegration("apiIntegrationResource", {
    apiAllowedPrefixes: ["string"],
    apiProvider: "string",
    apiAwsRoleArn: "string",
    apiBlockedPrefixes: ["string"],
    apiGcpServiceAccount: "string",
    apiKey: "string",
    azureAdApplicationId: "string",
    azureTenantId: "string",
    comment: "string",
    enabled: false,
    googleAudience: "string",
    name: "string",
});
type: snowflake:ApiIntegration
properties:
    apiAllowedPrefixes:
        - string
    apiAwsRoleArn: string
    apiBlockedPrefixes:
        - string
    apiGcpServiceAccount: string
    apiKey: string
    apiProvider: string
    azureAdApplicationId: string
    azureTenantId: string
    comment: string
    enabled: false
    googleAudience: string
    name: string
ApiIntegration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ApiIntegration resource accepts the following input properties:
- ApiAllowed List<string>Prefixes 
- 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.
- ApiAws stringRole Arn 
- ARN of a cloud platform role.
- ApiBlocked List<string>Prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- ApiGcp stringService Account 
- The service account used for communication with the Google API Gateway.
- ApiKey string
- The API key (also called a “subscription key”).
- AzureAd stringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- AzureTenant stringId 
- 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 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.
- ApiAllowed []stringPrefixes 
- 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.
- ApiAws stringRole Arn 
- ARN of a cloud platform role.
- ApiBlocked []stringPrefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- ApiGcp stringService Account 
- The service account used for communication with the Google API Gateway.
- ApiKey string
- The API key (also called a “subscription key”).
- AzureAd stringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- AzureTenant stringId 
- 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 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.
- apiAllowed List<String>Prefixes 
- 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.
- apiAws StringRole Arn 
- ARN of a cloud platform role.
- apiBlocked List<String>Prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- apiGcp StringService Account 
- The service account used for communication with the Google API Gateway.
- apiKey String
- The API key (also called a “subscription key”).
- azureAd StringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- azureTenant StringId 
- 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 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.
- apiAllowed string[]Prefixes 
- 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.
- apiAws stringRole Arn 
- ARN of a cloud platform role.
- apiBlocked string[]Prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- apiGcp stringService Account 
- The service account used for communication with the Google API Gateway.
- apiKey string
- The API key (also called a “subscription key”).
- azureAd stringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- azureTenant stringId 
- 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 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_ Sequence[str]prefixes 
- 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_ strrole_ arn 
- ARN of a cloud platform role.
- api_blocked_ Sequence[str]prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- api_gcp_ strservice_ account 
- The service account used for communication with the Google API Gateway.
- api_key str
- The API key (also called a “subscription key”).
- azure_ad_ strapplication_ id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- azure_tenant_ strid 
- 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 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.
- apiAllowed List<String>Prefixes 
- 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.
- apiAws StringRole Arn 
- ARN of a cloud platform role.
- apiBlocked List<String>Prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- apiGcp StringService Account 
- The service account used for communication with the Google API Gateway.
- apiKey String
- The API key (also called a “subscription key”).
- azureAd StringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- azureTenant StringId 
- 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 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:
- ApiAws stringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- ApiAws stringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- AzureConsent stringUrl 
- AzureMulti stringTenant App Name 
- CreatedOn string
- Date and time when the API integration was created.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- ApiAws stringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- ApiAws stringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- AzureConsent stringUrl 
- AzureMulti stringTenant App Name 
- CreatedOn string
- Date and time when the API integration was created.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- apiAws StringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- apiAws StringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- azureConsent StringUrl 
- azureMulti StringTenant App Name 
- createdOn String
- Date and time when the API integration was created.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- apiAws stringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- apiAws stringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- azureConsent stringUrl 
- azureMulti stringTenant App Name 
- createdOn string
- Date and time when the API integration was created.
- fullyQualified stringName 
- 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_ strexternal_ id 
- The external ID that Snowflake will use when assuming the AWS role.
- api_aws_ striam_ user_ arn 
- The Snowflake user that will attempt to assume the AWS role.
- azure_consent_ strurl 
- azure_multi_ strtenant_ app_ name 
- created_on str
- Date and time when the API integration was created.
- fully_qualified_ strname 
- Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- apiAws StringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- apiAws StringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- azureConsent StringUrl 
- azureMulti StringTenant App Name 
- createdOn String
- Date and time when the API integration was created.
- fullyQualified StringName 
- 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) -> ApiIntegrationfunc GetApiIntegration(ctx *Context, name string, id IDInput, state *ApiIntegrationState, opts ...ResourceOption) (*ApiIntegration, error)public static ApiIntegration Get(string name, Input<string> id, ApiIntegrationState? state, CustomResourceOptions? opts = null)public static ApiIntegration get(String name, Output<String> id, ApiIntegrationState state, CustomResourceOptions options)resources:  _:    type: snowflake:ApiIntegration    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- ApiAllowed List<string>Prefixes 
- Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
- ApiAws stringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- ApiAws stringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- ApiAws stringRole Arn 
- ARN of a cloud platform role.
- ApiBlocked List<string>Prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- ApiGcp stringService Account 
- The service account used for communication with the Google API Gateway.
- ApiKey string
- The API key (also called a “subscription key”).
- ApiProvider string
- Specifies the HTTPS proxy service type.
- AzureAd stringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- AzureConsent stringUrl 
- AzureMulti stringTenant App Name 
- AzureTenant stringId 
- 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.
- FullyQualified stringName 
- 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 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.
- ApiAllowed []stringPrefixes 
- Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
- ApiAws stringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- ApiAws stringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- ApiAws stringRole Arn 
- ARN of a cloud platform role.
- ApiBlocked []stringPrefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- ApiGcp stringService Account 
- The service account used for communication with the Google API Gateway.
- ApiKey string
- The API key (also called a “subscription key”).
- ApiProvider string
- Specifies the HTTPS proxy service type.
- AzureAd stringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- AzureConsent stringUrl 
- AzureMulti stringTenant App Name 
- AzureTenant stringId 
- 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.
- FullyQualified stringName 
- 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 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.
- apiAllowed List<String>Prefixes 
- Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
- apiAws StringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- apiAws StringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- apiAws StringRole Arn 
- ARN of a cloud platform role.
- apiBlocked List<String>Prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- apiGcp StringService Account 
- The service account used for communication with the Google API Gateway.
- apiKey String
- The API key (also called a “subscription key”).
- apiProvider String
- Specifies the HTTPS proxy service type.
- azureAd StringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- azureConsent StringUrl 
- azureMulti StringTenant App Name 
- azureTenant StringId 
- 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.
- fullyQualified StringName 
- 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 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.
- apiAllowed string[]Prefixes 
- Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
- apiAws stringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- apiAws stringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- apiAws stringRole Arn 
- ARN of a cloud platform role.
- apiBlocked string[]Prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- apiGcp stringService Account 
- The service account used for communication with the Google API Gateway.
- apiKey string
- The API key (also called a “subscription key”).
- apiProvider string
- Specifies the HTTPS proxy service type.
- azureAd stringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- azureConsent stringUrl 
- azureMulti stringTenant App Name 
- azureTenant stringId 
- 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.
- fullyQualified stringName 
- 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 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_ Sequence[str]prefixes 
- Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
- api_aws_ strexternal_ id 
- The external ID that Snowflake will use when assuming the AWS role.
- api_aws_ striam_ user_ arn 
- The Snowflake user that will attempt to assume the AWS role.
- api_aws_ strrole_ arn 
- ARN of a cloud platform role.
- api_blocked_ Sequence[str]prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- api_gcp_ strservice_ account 
- The service account used for communication with the Google API Gateway.
- api_key str
- The API key (also called a “subscription key”).
- api_provider str
- Specifies the HTTPS proxy service type.
- azure_ad_ strapplication_ id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- azure_consent_ strurl 
- azure_multi_ strtenant_ app_ name 
- azure_tenant_ strid 
- 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_ strname 
- 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 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.
- apiAllowed List<String>Prefixes 
- Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.
- apiAws StringExternal Id 
- The external ID that Snowflake will use when assuming the AWS role.
- apiAws StringIam User Arn 
- The Snowflake user that will attempt to assume the AWS role.
- apiAws StringRole Arn 
- ARN of a cloud platform role.
- apiBlocked List<String>Prefixes 
- Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
- apiGcp StringService Account 
- The service account used for communication with the Google API Gateway.
- apiKey String
- The API key (also called a “subscription key”).
- apiProvider String
- Specifies the HTTPS proxy service type.
- azureAd StringApplication Id 
- The 'Application (client) id' of the Azure AD app for your remote service.
- azureConsent StringUrl 
- azureMulti StringTenant App Name 
- azureTenant StringId 
- 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.
- fullyQualified StringName 
- 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 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 snowflakeTerraform Provider.