integration_table_properties

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

Overview

Name	integration_table_properties
Type	Resource
Id	aws.glue.integration_table_properties

Fields

The following fields are returned by SELECT queries:

get_integration_table_properties

Name	Datatype	Description
resource_arn	string	The Amazon Resource Name (ARN) of the target table for which to retrieve integration table properties. Currently, this API only supports retrieving properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for retrieving integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
source_table_config	object	A structure for the source table configuration.
table_name	string	The name of the table to be replicated.
target_table_config	object	A structure for the target table configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_integration_table_properties	select	region		This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.
create_integration_table_properties	insert	region, ResourceArn, TableName		This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively.
update_integration_table_properties	update	region, ResourceArn, TableName		This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively. The override will be reflected across all the integrations using same ResourceArn and source table.
delete_integration_table_properties	delete	region		Deletes the table properties that have been created for the tables that need to be replicated.

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_table_properties

This API is used to retrieve optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partition for source and target tables.

SELECT
resource_arn,
source_table_config,
table_name,
target_table_config
FROM aws.glue.integration_table_properties
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_integration_table_properties

This API is used to provide optional override properties for the the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively.

INSERT INTO aws.glue.integration_table_properties (
ResourceArn,
TableName,
SourceTableConfig,
TargetTableConfig,
region
)
SELECT 
'{{ ResourceArn }}' /* required */,
'{{ TableName }}' /* required */,
'{{ SourceTableConfig }}',
'{{ TargetTableConfig }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: integration_table_properties
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the integration_table_properties resource.
  - name: ResourceArn
    value: "{{ ResourceArn }}"
    description: |
      The Amazon Resource Name (ARN) of the target table for which to create integration table properties. Currently, this API only supports creating integration table properties for target tables, and the provided ARN should be the ARN of the target table in the Glue Data Catalog. Support for creating integration table properties for source connections (using the connection ARN) is not yet implemented and will be added in a future release.
  - name: TableName
    value: "{{ TableName }}"
    description: |
      The name of the table to be replicated.
  - name: SourceTableConfig
    description: |
      A structure for the source table configuration. See the SourceTableConfig structure to see list of supported source properties.
    value:
      Fields:
        - "{{ Fields }}"
      FilterPredicate: "{{ FilterPredicate }}"
      PrimaryKey:
        - "{{ PrimaryKey }}"
      RecordUpdateField: "{{ RecordUpdateField }}"
  - name: TargetTableConfig
    description: |
      A structure for the target table configuration.
    value:
      UnnestSpec: "{{ UnnestSpec }}"
      PartitionSpec:
        - FieldName: "{{ FieldName }}"
          FunctionSpec: "{{ FunctionSpec }}"
          ConversionSpec: "{{ ConversionSpec }}"
      TargetTableName: "{{ TargetTableName }}"

UPDATE examples

update_integration_table_properties

This API is used to provide optional override properties for the tables that need to be replicated. These properties can include properties for filtering and partitioning for the source and target tables. To set both source and target properties the same API need to be invoked with the Glue connection ARN as ResourceArn with SourceTableConfig, and the Glue database ARN as ResourceArn with TargetTableConfig respectively. The override will be reflected across all the integrations using same ResourceArn and source table.

UPDATE aws.glue.integration_table_properties
SET 
ResourceArn = '{{ ResourceArn }}',
TableName = '{{ TableName }}',
SourceTableConfig = '{{ SourceTableConfig }}',
TargetTableConfig = '{{ TargetTableConfig }}'
WHERE 
region = '{{ region }}' --required
AND ResourceArn = '{{ ResourceArn }}' --required
AND TableName = '{{ TableName }}' --required;

DELETE examples

delete_integration_table_properties

Deletes the table properties that have been created for the tables that need to be replicated.

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