integrations

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

Overview

Name	integrations
Type	Resource
Id	aws.redshift.integrations

Fields

The following fields are returned by SELECT queries:

describe_integrations

Name	Datatype	Description
additional_encryption_context	string	The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide.
create_time	string	The time (UTC) when the integration was created.
description	string	The description of the integration.
errors	string	Any errors associated with the integration.
integration_arn	string	The Amazon Resource Name (ARN) of the integration.
integration_name	string	The name of the integration.
kms_key_id	string	The Key Management Service (KMS) key identifier for the key used to encrypt the integration.
source_arn	string	The Amazon Resource Name (ARN) of the database used as the source for replication.
status	string	The current status of the integration.
tags	string	The list of tags associated with the integration.
target_arn	string	The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_integrations	select	region	IntegrationArn, MaxRecords, Marker, Filters	Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.
create_integration	insert	SourceArn, TargetArn, IntegrationName, region	KMSKeyId, TagList, AdditionalEncryptionContext, Description	Creates a zero-ETL integration or S3 event integration with Amazon Redshift.
modify_integration	update	IntegrationArn, region	Description, IntegrationName	Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.
delete_integration	delete	IntegrationArn, region		Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.

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
IntegrationArn	string	The unique identifier of the integration to delete.
IntegrationName	string	The name of the integration.
SourceArn	string	The Amazon Resource Name (ARN) of the database to use as the source for replication.
TargetArn	string	The Amazon Resource Name (ARN) of the Amazon Redshift data warehouse to use as the target for replication.
region	string	AWS region (default: us-east-1)
AdditionalEncryptionContext	object	An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
Description	string	A new description for the integration.
Filters	array	A filter that specifies one or more resources to return.
IntegrationArn	string	The unique identifier of the integration.
IntegrationName	string	A new name for the integration.
KMSKeyId	string	An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default Amazon Web Services owned key is used.
Marker	string	An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100.
TagList	array	A list of tags.

SELECT examples

describe_integrations

Describes one or more zero-ETL or S3 event integrations with Amazon Redshift.

SELECT
additional_encryption_context,
create_time,
description,
errors,
integration_arn,
integration_name,
kms_key_id,
source_arn,
status,
tags,
target_arn
FROM aws.redshift.integrations
WHERE region = '{{ region }}' -- required
AND IntegrationArn = '{{ IntegrationArn }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
AND Filters = '{{ Filters }}'
;

INSERT examples

create_integration

Creates a zero-ETL integration or S3 event integration with Amazon Redshift.

INSERT INTO aws.redshift.integrations (
SourceArn,
TargetArn,
IntegrationName,
region,
KMSKeyId,
TagList,
AdditionalEncryptionContext,
Description
)
SELECT 
'{{ SourceArn }}',
'{{ TargetArn }}',
'{{ IntegrationName }}',
'{{ region }}',
'{{ KMSKeyId }}',
'{{ TagList }}',
'{{ AdditionalEncryptionContext }}',
'{{ Description }}'
RETURNING
additional_encryption_context,
create_time,
description,
errors,
integration_arn,
integration_name,
kms_key_id,
source_arn,
status,
tags,
target_arn
;

Manifest

# Description fields are for documentation purposes
- name: integrations
props:
  - name: SourceArn
    value: "{{ SourceArn }}"
    description: Required parameter for the integrations resource.
  - name: TargetArn
    value: "{{ TargetArn }}"
    description: Required parameter for the integrations resource.
  - name: IntegrationName
    value: "{{ IntegrationName }}"
    description: Required parameter for the integrations resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the integrations resource.
  - name: KMSKeyId
    value: "{{ KMSKeyId }}"
    description: An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default Amazon Web Services owned key is used.
    description: An Key Management Service (KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, the default Amazon Web Services owned key is used.
  - name: TagList
    value: "{{ TagList }}"
    description: A list of tags.
    description: A list of tags.
  - name: AdditionalEncryptionContext
    value: "{{ AdditionalEncryptionContext }}"
    description: An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
    description: An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide. You can only include this parameter if you specify the KMSKeyId parameter.
  - name: Description
    value: "{{ Description }}"
    description: A description of the integration.
    description: A description of the integration.

UPDATE examples

modify_integration

Modifies a zero-ETL integration or S3 event integration with Amazon Redshift.

UPDATE aws.redshift.integrations
SET 
-- No updatable properties
WHERE 
IntegrationArn = '{{ IntegrationArn }}' --required
AND region = '{{ region }}' --required
AND Description = '{{ Description}}'
AND IntegrationName = '{{ IntegrationName}}'
RETURNING
additional_encryption_context,
create_time,
description,
errors,
integration_arn,
integration_name,
kms_key_id,
source_arn,
status,
tags,
target_arn;

DELETE examples

delete_integration

Deletes a zero-ETL integration or S3 event integration with Amazon Redshift.

DELETE FROM aws.redshift.integrations
WHERE IntegrationArn = '{{ IntegrationArn }}' --required
AND region = '{{ region }}' --required
;