integration_resource_properties

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

Overview

Name	integration_resource_properties
Type	Resource
Id	aws.glue.integration_resource_properties

Fields

The following fields are returned by SELECT queries:

get_integration_resource_property

Name	Datatype	Description
resource_arn	string	The connection ARN of the source, or the database ARN of the target.
resource_property_arn	string	The resource ARN created through this create API. The format is something like arn:aws:glue:<region>:<account_id>:integrationresourceproperty/*
source_processing_properties	object	The resource properties associated with the integration source.
target_processing_properties	object	The resource properties associated with the integration target.

list_integration_resource_properties

Name	Datatype	Description
integration_resource_property_list	array	A list of integration resource property meeting the filter criteria.
marker	string	This is the pagination token for the next page.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_integration_resource_property	select	region		This API is used for fetching the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target)
list_integration_resource_properties	select	region		List integration resource properties for a single customer. It supports the filters, maxRecords and markers.
create_integration_resource_property	insert	region, ResourceArn		This API can be used for setting up the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. To set both source and target properties the same API needs to be invoked with the Glue connection ARN as ResourceArn with SourceProcessingProperties and the Glue database ARN as ResourceArn with TargetProcessingProperties respectively.
update_integration_resource_property	update	region, ResourceArn		This API can be used for updating the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. Since the same resource can be used across multiple integrations, updating resource properties will impact all the integrations using it.
delete_integration_resource_property	delete	region		This API is used for deleting the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target).

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_resource_property

This API is used for fetching the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target)

SELECT
resource_arn,
resource_property_arn,
source_processing_properties,
target_processing_properties
FROM aws.glue.integration_resource_properties
WHERE region = '{{ region }}' -- required
;

list_integration_resource_properties

List integration resource properties for a single customer. It supports the filters, maxRecords and markers.

SELECT
integration_resource_property_list,
marker
FROM aws.glue.integration_resource_properties
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_integration_resource_property

This API can be used for setting up the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. To set both source and target properties the same API needs to be invoked with the Glue connection ARN as ResourceArn with SourceProcessingProperties and the Glue database ARN as ResourceArn with TargetProcessingProperties respectively.

INSERT INTO aws.glue.integration_resource_properties (
ResourceArn,
SourceProcessingProperties,
TargetProcessingProperties,
Tags,
region
)
SELECT 
'{{ ResourceArn }}' /* required */,
'{{ SourceProcessingProperties }}',
'{{ TargetProcessingProperties }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
resource_arn,
resource_property_arn,
source_processing_properties,
target_processing_properties
;

Manifest

# Description fields are for documentation purposes
- name: integration_resource_properties
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the integration_resource_properties resource.
  - name: ResourceArn
    value: "{{ ResourceArn }}"
    description: |
      The connection ARN of the source, or the database ARN of the target.
  - name: SourceProcessingProperties
    description: |
      The resource properties associated with the integration source.
    value:
      RoleArn: "{{ RoleArn }}"
  - name: TargetProcessingProperties
    description: |
      The resource properties associated with the integration target.
    value:
      RoleArn: "{{ RoleArn }}"
      KmsArn: "{{ KmsArn }}"
      ConnectionName: "{{ ConnectionName }}"
      EventBusArn: "{{ EventBusArn }}"
  - name: Tags
    description: |
      Metadata assigned to the resource consisting of a list of key-value pairs.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"

UPDATE examples

update_integration_resource_property

This API can be used for updating the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target). These properties can include the role to access the connection or database. Since the same resource can be used across multiple integrations, updating resource properties will impact all the integrations using it.

UPDATE aws.glue.integration_resource_properties
SET 
ResourceArn = '{{ ResourceArn }}',
SourceProcessingProperties = '{{ SourceProcessingProperties }}',
TargetProcessingProperties = '{{ TargetProcessingProperties }}'
WHERE 
region = '{{ region }}' --required
AND ResourceArn = '{{ ResourceArn }}' --required
RETURNING
resource_arn,
resource_property_arn,
source_processing_properties,
target_processing_properties;

DELETE examples

delete_integration_resource_property

This API is used for deleting the ResourceProperty of the Glue connection (for the source) or Glue database ARN (for the target).

DELETE FROM aws.glue.integration_resource_properties
WHERE region = '{{ region }}' --required
;