integrations

Creates, updates, deletes, gets or lists an integrations resource.

Overview

Name	integrations
Type	Resource
Id	aws.securityagent.integrations

Fields

The following fields are returned by SELECT queries:

get_integration

Name	Datatype	Description
display_name	string	The display name of the integration.
installation_id	string	The installation identifier from the integration provider.
integration_id	string	Unique identifier for an integration.
kms_key_id	string	Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
private_connection_name	string	The unique name of a private connection within your account.
provider	string	Third-party provider type. (GITHUB, GITLAB, BITBUCKET, CONFLUENCE)
provider_type	string	The type of the integration provider. (SOURCE_CODE, DOCUMENTATION)
target_url	string	The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.

list_integrations

Name	Datatype	Description
display_name	string	The display name of the integration.
installation_id	string	The installation identifier from the integration provider.
integration_id	string	The unique identifier of the integration.
private_connection_name	string	The unique name of a private connection within your account.
provider	string	Third-party provider type. (GITHUB, GITLAB, BITBUCKET, CONFLUENCE)
provider_type	string	The type of the integration provider. (SOURCE_CODE, DOCUMENTATION)
target_url	string	The HTTPS URL of the customer self-hosted instance, such as a GitHub Enterprise Server or self-managed GitLab instance. This value is absent for SaaS integrations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_integration	select	region		Retrieves information about an integration.
list_integrations	select	region		Lists the integrations in your account, optionally filtered by provider or provider type.
create_integration	insert	region, provider, input, integrationDisplayName		Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.
delete_integration	delete	region		Deletes an integration with a third-party provider.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_integration

Retrieves information about an integration.

SELECT
display_name,
installation_id,
integration_id,
kms_key_id,
private_connection_name,
provider,
provider_type,
target_url
FROM aws.securityagent.integrations
WHERE region = '{{ region }}' -- required
;

list_integrations

Lists the integrations in your account, optionally filtered by provider or provider type.

SELECT
display_name,
installation_id,
integration_id,
private_connection_name,
provider,
provider_type,
target_url
FROM aws.securityagent.integrations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_integration

Creates a new integration with a third-party provider, such as GitHub, for code review and remediation.

INSERT INTO aws.securityagent.integrations (
provider,
input,
integrationDisplayName,
kmsKeyId,
tags,
privateConnectionName,
region
)
SELECT 
'{{ provider }}' /* required */,
'{{ input }}' /* required */,
'{{ integrationDisplayName }}' /* required */,
'{{ kmsKeyId }}',
'{{ tags }}',
'{{ privateConnectionName }}',
'{{ region }}'
RETURNING
integration_id
;

Manifest

# Description fields are for documentation purposes
- name: integrations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the integrations resource.
  - name: provider
    value: "{{ provider }}"
    description: |
      Third-party provider type.
    valid_values: ['GITHUB', 'GITLAB', 'BITBUCKET', 'CONFLUENCE']
  - name: input
    description: |
      The provider-specific input for creating an integration. This is a union type that contains provider-specific configuration.
    value:
      github:
        code: "{{ code }}"
        state: "{{ state }}"
        organizationName: "{{ organizationName }}"
        targetUrl: "{{ targetUrl }}"
        installationId: "{{ installationId }}"
      gitlab:
        accessToken: "{{ accessToken }}"
        targetUrl: "{{ targetUrl }}"
        tokenType: "{{ tokenType }}"
        groupId: "{{ groupId }}"
      bitbucket:
        installationId: "{{ installationId }}"
        workspace: "{{ workspace }}"
        code: "{{ code }}"
        state: "{{ state }}"
      confluence:
        installationId: "{{ installationId }}"
        code: "{{ code }}"
        state: "{{ state }}"
        siteUrl: "{{ siteUrl }}"
  - name: integrationDisplayName
    value: "{{ integrationDisplayName }}"
  - name: kmsKeyId
    value: "{{ kmsKeyId }}"
    description: |
      Identifier of a KMS key. Can be a key ID, key ARN, alias name, or alias ARN.
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tags for a resource.
  - name: privateConnectionName
    value: "{{ privateConnectionName }}"
    description: |
      The unique name of a private connection within your account.

DELETE examples

delete_integration

Deletes an integration with a third-party provider.

DELETE FROM aws.securityagent.integrations
WHERE region = '{{ region }}' --required
;