Skip to content

Latest commit

 

History

History
1401 lines (878 loc) · 56 KB

apiIntegration.go.md

File metadata and controls

1401 lines (878 loc) · 56 KB

apiIntegration Submodule

Constructs

ApiIntegration

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration snowflake_api_integration}.

Initializers 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/apiintegration"

apiintegration.NewApiIntegration(scope Construct, id *string, config ApiIntegrationConfig) ApiIntegration
Name Type Description
scope github.com/aws/constructs-go/constructs/v10.Construct The scope in which to define this construct.
id *string The scoped construct ID.
config ApiIntegrationConfig No description.
scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

idRequired
  • Type: *string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
ToString Returns a string representation of this construct.
AddOverride No description.
OverrideLogicalId Overrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform No description.
ToMetadata No description.
ToTerraform Adds this resource to the terraform JSON output.
AddMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
GetAnyMapAttribute No description.
GetBooleanAttribute No description.
GetBooleanMapAttribute No description.
GetListAttribute No description.
GetNumberAttribute No description.
GetNumberListAttribute No description.
GetNumberMapAttribute No description.
GetStringAttribute No description.
GetStringMapAttribute No description.
HasResourceMove No description.
ImportFrom No description.
InterpolationForAttribute No description.
MoveFromId Move the resource corresponding to "id" to this resource.
MoveTo Moves this resource to the target resource given by moveTarget.
MoveToId Moves this resource to the resource corresponding to "id".
ResetApiAwsRoleArn No description.
ResetApiBlockedPrefixes No description.
ResetApiGcpServiceAccount No description.
ResetApiKey No description.
ResetAzureAdApplicationId No description.
ResetAzureTenantId No description.
ResetComment No description.
ResetEnabled No description.
ResetGoogleAudience No description.
ResetId No description.
ToString 
func ToString() *string

Returns a string representation of this construct.

AddOverride 
func AddOverride(path *string, value interface{})
pathRequired
  • Type: *string
valueRequired
  • Type: interface{}
OverrideLogicalId 
func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: *string

The new logical ID to use for this stack element.

ResetOverrideLogicalId 
func ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

ToHclTerraform 
func ToHclTerraform() interface{}
ToMetadata 
func ToMetadata() interface{}
ToTerraform 
func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget 
func AddMoveTarget(moveTarget *string)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: *string

The string move target that will correspond to this resource.

GetAnyMapAttribute 
func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
terraformAttributeRequired
  • Type: *string
GetBooleanAttribute 
func GetBooleanAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
GetBooleanMapAttribute 
func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
terraformAttributeRequired
  • Type: *string
GetListAttribute 
func GetListAttribute(terraformAttribute *string) *[]*string
terraformAttributeRequired
  • Type: *string
GetNumberAttribute 
func GetNumberAttribute(terraformAttribute *string) *f64
terraformAttributeRequired
  • Type: *string
GetNumberListAttribute 
func GetNumberListAttribute(terraformAttribute *string) *[]*f64
terraformAttributeRequired
  • Type: *string
GetNumberMapAttribute 
func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64
terraformAttributeRequired
  • Type: *string
GetStringAttribute 
func GetStringAttribute(terraformAttribute *string) *string
terraformAttributeRequired
  • Type: *string
GetStringMapAttribute 
func GetStringMapAttribute(terraformAttribute *string) *map[string]*string
terraformAttributeRequired
  • Type: *string
HasResourceMove 
func HasResourceMove() interface{}
ImportFrom 
func ImportFrom(id *string, provider TerraformProvider)
idRequired
  • Type: *string
providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
InterpolationForAttribute 
func InterpolationForAttribute(terraformAttribute *string) IResolvable
terraformAttributeRequired
  • Type: *string
MoveFromId 
func MoveFromId(id *string)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: *string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo 
func MoveTo(moveTarget *string, index interface{})

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: *string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: interface{}

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId 
func MoveToId(id *string)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: *string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

ResetApiAwsRoleArn 
func ResetApiAwsRoleArn()
ResetApiBlockedPrefixes 
func ResetApiBlockedPrefixes()
ResetApiGcpServiceAccount 
func ResetApiGcpServiceAccount()
ResetApiKey 
func ResetApiKey()
ResetAzureAdApplicationId 
func ResetAzureAdApplicationId()
ResetAzureTenantId 
func ResetAzureTenantId()
ResetComment 
func ResetComment()
ResetEnabled 
func ResetEnabled()
ResetGoogleAudience 
func ResetGoogleAudience()
ResetId 
func ResetId()

Static Functions

Name Description
IsConstruct Checks if x is a construct.
IsTerraformElement No description.
IsTerraformResource No description.
GenerateConfigForImport Generates CDKTF code for importing a ApiIntegration resource upon running "cdktf plan ".
IsConstruct 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/apiintegration"

apiintegration.ApiIntegration_IsConstruct(x interface{}) *bool

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: interface{}

Any object.

IsTerraformElement 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/apiintegration"

apiintegration.ApiIntegration_IsTerraformElement(x interface{}) *bool
xRequired
  • Type: interface{}
IsTerraformResource 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/apiintegration"

apiintegration.ApiIntegration_IsTerraformResource(x interface{}) *bool
xRequired
  • Type: interface{}
GenerateConfigForImport 
import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/apiintegration"

apiintegration.ApiIntegration_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

Generates CDKTF code for importing a ApiIntegration resource upon running "cdktf plan ".

scopeRequired
  • Type: github.com/aws/constructs-go/constructs/v10.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: *string

The construct id used in the generated config for the ApiIntegration to import.

importFromIdRequired
  • Type: *string

The id of the existing ApiIntegration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

? Optional instance of the provider where the ApiIntegration to import is found.

Properties

Name Type Description
Node github.com/aws/constructs-go/constructs/v10.Node The tree node.
CdktfStack github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack No description.
Fqn *string No description.
FriendlyUniqueId *string No description.
TerraformMetaArguments *map[string]interface{} No description.
TerraformResourceType *string No description.
TerraformGeneratorMetadata github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata No description.
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]*string No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
ApiAwsExternalId *string No description.
ApiAwsIamUserArn *string No description.
AzureConsentUrl *string No description.
AzureMultiTenantAppName *string No description.
CreatedOn *string No description.
FullyQualifiedName *string No description.
ApiAllowedPrefixesInput *[]*string No description.
ApiAwsRoleArnInput *string No description.
ApiBlockedPrefixesInput *[]*string No description.
ApiGcpServiceAccountInput *string No description.
ApiKeyInput *string No description.
ApiProviderInput *string No description.
AzureAdApplicationIdInput *string No description.
AzureTenantIdInput *string No description.
CommentInput *string No description.
EnabledInput interface{} No description.
GoogleAudienceInput *string No description.
IdInput *string No description.
NameInput *string No description.
ApiAllowedPrefixes *[]*string No description.
ApiAwsRoleArn *string No description.
ApiBlockedPrefixes *[]*string No description.
ApiGcpServiceAccount *string No description.
ApiKey *string No description.
ApiProvider *string No description.
AzureAdApplicationId *string No description.
AzureTenantId *string No description.
Comment *string No description.
Enabled interface{} No description.
GoogleAudience *string No description.
Id *string No description.
Name *string No description.
NodeRequired 
func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

CdktfStackRequired 
func CdktfStack() TerraformStack
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack
FqnRequired 
func Fqn() *string
  • Type: *string
FriendlyUniqueIdRequired 
func FriendlyUniqueId() *string
  • Type: *string
TerraformMetaArgumentsRequired 
func TerraformMetaArguments() *map[string]interface{}
  • Type: *map[string]interface{}
TerraformResourceTypeRequired 
func TerraformResourceType() *string
  • Type: *string
TerraformGeneratorMetadataOptional 
func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata
ConnectionOptional 
func Connection() interface{}
  • Type: interface{}
CountOptional 
func Count() interface{}
  • Type: interface{}
DependsOnOptional 
func DependsOn() *[]*string
  • Type: *[]*string
ForEachOptional 
func ForEach() ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
func Lifecycle() TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
func Provider() TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
func Provisioners() *[]interface{}
  • Type: *[]interface{}
ApiAwsExternalIdRequired 
func ApiAwsExternalId() *string
  • Type: *string
ApiAwsIamUserArnRequired 
func ApiAwsIamUserArn() *string
  • Type: *string
AzureConsentUrlRequired 
func AzureConsentUrl() *string
  • Type: *string
AzureMultiTenantAppNameRequired 
func AzureMultiTenantAppName() *string
  • Type: *string
CreatedOnRequired 
func CreatedOn() *string
  • Type: *string
FullyQualifiedNameRequired 
func FullyQualifiedName() *string
  • Type: *string
ApiAllowedPrefixesInputOptional 
func ApiAllowedPrefixesInput() *[]*string
  • Type: *[]*string
ApiAwsRoleArnInputOptional 
func ApiAwsRoleArnInput() *string
  • Type: *string
ApiBlockedPrefixesInputOptional 
func ApiBlockedPrefixesInput() *[]*string
  • Type: *[]*string
ApiGcpServiceAccountInputOptional 
func ApiGcpServiceAccountInput() *string
  • Type: *string
ApiKeyInputOptional 
func ApiKeyInput() *string
  • Type: *string
ApiProviderInputOptional 
func ApiProviderInput() *string
  • Type: *string
AzureAdApplicationIdInputOptional 
func AzureAdApplicationIdInput() *string
  • Type: *string
AzureTenantIdInputOptional 
func AzureTenantIdInput() *string
  • Type: *string
CommentInputOptional 
func CommentInput() *string
  • Type: *string
EnabledInputOptional 
func EnabledInput() interface{}
  • Type: interface{}
GoogleAudienceInputOptional 
func GoogleAudienceInput() *string
  • Type: *string
IdInputOptional 
func IdInput() *string
  • Type: *string
NameInputOptional 
func NameInput() *string
  • Type: *string
ApiAllowedPrefixesRequired 
func ApiAllowedPrefixes() *[]*string
  • Type: *[]*string
ApiAwsRoleArnRequired 
func ApiAwsRoleArn() *string
  • Type: *string
ApiBlockedPrefixesRequired 
func ApiBlockedPrefixes() *[]*string
  • Type: *[]*string
ApiGcpServiceAccountRequired 
func ApiGcpServiceAccount() *string
  • Type: *string
ApiKeyRequired 
func ApiKey() *string
  • Type: *string
ApiProviderRequired 
func ApiProvider() *string
  • Type: *string
AzureAdApplicationIdRequired 
func AzureAdApplicationId() *string
  • Type: *string
AzureTenantIdRequired 
func AzureTenantId() *string
  • Type: *string
CommentRequired 
func Comment() *string
  • Type: *string
EnabledRequired 
func Enabled() interface{}
  • Type: interface{}
GoogleAudienceRequired 
func GoogleAudience() *string
  • Type: *string
IdRequired 
func Id() *string
  • Type: *string
NameRequired 
func Name() *string
  • Type: *string

Constants

Name Type Description
TfResourceType *string No description.
TfResourceTypeRequired 
func TfResourceType() *string
  • Type: *string

Structs

ApiIntegrationConfig

Initializer 

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/apiintegration"

&apiintegration.ApiIntegrationConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	ApiAllowedPrefixes: *[]*string,
	ApiProvider: *string,
	Name: *string,
	ApiAwsRoleArn: *string,
	ApiBlockedPrefixes: *[]*string,
	ApiGcpServiceAccount: *string,
	ApiKey: *string,
	AzureAdApplicationId: *string,
	AzureTenantId: *string,
	Comment: *string,
	Enabled: interface{},
	GoogleAudience: *string,
	Id: *string,
}

Properties

Name Type Description
Connection interface{} No description.
Count interface{} No description.
DependsOn *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable No description.
ForEach github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator No description.
Lifecycle github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle No description.
Provider github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider No description.
Provisioners *[]interface{} No description.
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.
Name *string Specifies the name of the API integration.
ApiAwsRoleArn *string ARN of a cloud platform role.
ApiBlockedPrefixes *[]*string Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.
ApiGcpServiceAccount *string The service account used for communication with the Google API Gateway.
ApiKey *string The API key (also called a “subscription key”).
AzureAdApplicationId *string The 'Application (client) id' of the Azure AD app for your remote service.
AzureTenantId *string Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.
Comment *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#comment ApiIntegration#comment}.
Enabled interface{} Specifies whether this API integration is enabled or disabled.
GoogleAudience *string The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.
Id *string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#id ApiIntegration#id}.
ConnectionOptional 
Connection interface{}
  • Type: interface{}
CountOptional 
Count interface{}
  • Type: interface{}
DependsOnOptional 
DependsOn *[]ITerraformDependable
  • Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable
ForEachOptional 
ForEach ITerraformIterator
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator
LifecycleOptional 
Lifecycle TerraformResourceLifecycle
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle
ProviderOptional 
Provider TerraformProvider
  • Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider
ProvisionersOptional 
Provisioners *[]interface{}
  • Type: *[]interface{}
ApiAllowedPrefixesRequired 
ApiAllowedPrefixes *[]*string
  • Type: *[]*string

Explicitly limits external functions that use the integration to reference one or more HTTPS proxy service endpoints and resources within those proxies.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#api_allowed_prefixes ApiIntegration#api_allowed_prefixes}

ApiProviderRequired 
ApiProvider *string
  • Type: *string

Specifies the HTTPS proxy service type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#api_provider ApiIntegration#api_provider}

NameRequired 
Name *string
  • Type: *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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#name ApiIntegration#name}

ApiAwsRoleArnOptional 
ApiAwsRoleArn *string
  • Type: *string

ARN of a cloud platform role.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#api_aws_role_arn ApiIntegration#api_aws_role_arn}

ApiBlockedPrefixesOptional 
ApiBlockedPrefixes *[]*string
  • Type: *[]*string

Lists the endpoints and resources in the HTTPS proxy service that are not allowed to be called from Snowflake.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#api_blocked_prefixes ApiIntegration#api_blocked_prefixes}

ApiGcpServiceAccountOptional 
ApiGcpServiceAccount *string
  • Type: *string

The service account used for communication with the Google API Gateway.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#api_gcp_service_account ApiIntegration#api_gcp_service_account}

ApiKeyOptional 
ApiKey *string
  • Type: *string

The API key (also called a “subscription key”).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#api_key ApiIntegration#api_key}

AzureAdApplicationIdOptional 
AzureAdApplicationId *string
  • Type: *string

The 'Application (client) id' of the Azure AD app for your remote service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#azure_ad_application_id ApiIntegration#azure_ad_application_id}

AzureTenantIdOptional 
AzureTenantId *string
  • Type: *string

Specifies the ID for your Office 365 tenant that all Azure API Management instances belong to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#azure_tenant_id ApiIntegration#azure_tenant_id}

CommentOptional 
Comment *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#comment ApiIntegration#comment}.

EnabledOptional 
Enabled interface{}
  • Type: interface{}

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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#enabled ApiIntegration#enabled}

GoogleAudienceOptional 
GoogleAudience *string
  • Type: *string

The audience claim when generating the JWT (JSON Web Token) to authenticate to the Google API Gateway.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#google_audience ApiIntegration#google_audience}

IdOptional 
Id *string
  • Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/api_integration#id ApiIntegration#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.