integration

Documentation

Index

• Variables
• func IntegrationSchema() map[string]schema.Attribute
• func NewIntegrationResource() resource.Resource
• type IntegrationModel
• type IntegrationResource
  • func (r *IntegrationResource) Configure(ctx context.Context, req resource.ConfigureRequest, ...)
  • func (r *IntegrationResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)
  • func (r *IntegrationResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)
  • func (r *IntegrationResource) ImportState(ctx context.Context, req resource.ImportStateRequest, ...)
  • func (r *IntegrationResource) Metadata(ctx context.Context, req resource.MetadataRequest, ...)
  • func (r *IntegrationResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)
  • func (r *IntegrationResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)
  • func (r *IntegrationResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)
• type WebhookChangelogDestinationModel

Variables

var IntegrationResourceMarkdownDescription = `

# Integration resource

**NOTE:** This resource manages existing integration and integration mappings, not for creating new integrations.

Docs about integrations can be found [here](https://docs.getport.io/integrations-index/).

Docs about how to import existing integrations and manage their mappings can be found [here](https://docs.getport.io/guides/all/import-and-manage-integration).


` + "```hcl" + `
resource "port_integration" "my_custom_integration" {
	installation_id       = "my-custom-integration-id"
	title                 = "My Custom Integration"
	config = jsonencode({
		createMissingRelatedEntitiesboolean = true
		deleteDependentEntities = true,
		resources = [{
			kind = "my-custom-kind"
			selector = {
				query = ".title"
			}
			port = {
				entity = {
					mappings = [{
						identifier = "'my-identifier'"
						title      = ".title"
						blueprint  = "'my-blueprint'"
						properties = {
							my_property = 123
						}
						relations  = {}
					}]
				}
			}
		}]
	})
}


` + "```\n" + `
### NOTICE:

The following config properties (` + "`selector.query|entity.mappings.*`" + `) are jq expressions, which means that you need to input either a valid jq expression (E.g ` + "`.title`" + `), or if you want a string value, a qouted escaped string val (E.g ` + "`'my-string'`" + `).
`

Functions

func IntegrationSchema

func IntegrationSchema() map[string]schema.Attribute

func NewIntegrationResource

func NewIntegrationResource() resource.Resource

Types

type IntegrationModel

type IntegrationModel struct {
	ID                          types.String                      `tfsdk:"id"`
	InstallationId              types.String                      `tfsdk:"installation_id"`
	InstallationAppType         types.String                      `tfsdk:"installation_app_type"`
	Title                       types.String                      `tfsdk:"title"`
	Version                     types.String                      `tfsdk:"version"`
	Config                      types.String                      `tfsdk:"config"`
	KafkaChangelogDestination   types.Object                      `tfsdk:"kafka_changelog_destination"`
	WebhookChangelogDestination *WebhookChangelogDestinationModel `tfsdk:"webhook_changelog_destination"`
}

type IntegrationResource

type IntegrationResource struct {
	// contains filtered or unexported fields
}

func (*IntegrationResource) Configure

func (r *IntegrationResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)

func (*IntegrationResource) Create

func (r *IntegrationResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)

func (*IntegrationResource) Delete

func (r *IntegrationResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)

func (*IntegrationResource) ImportState

func (r *IntegrationResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)

func (*IntegrationResource) Metadata

func (r *IntegrationResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)

func (*IntegrationResource) Read

func (r *IntegrationResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)

func (*IntegrationResource) Schema

func (r *IntegrationResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)

func (*IntegrationResource) Update

func (r *IntegrationResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)

type WebhookChangelogDestinationModel

type WebhookChangelogDestinationModel struct {
	Url   types.String `tfsdk:"url"`
	Agent types.Bool   `tfsdk:"agent"`
}