integrations

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

Overview

Name	integrations
Type	Resource
Id	aws.logs.integrations

Fields

The following fields are returned by SELECT queries:

get_integration

Name	Datatype	Description
integration_details	object	A structure that contains information about the integration configuration. For an integration with OpenSearch Service, this includes information about OpenSearch Service resources such as the collection, the workspace, and policies.
integration_name	string	The name of the integration. (pattern: <code>[.-_/#A-Za-z0-9]+</code>)
integration_status	string	The current status of this integration. (PROVISIONING, ACTIVE, FAILED)
integration_type	string	The type of integration. Integrations with OpenSearch Service have the type OPENSEARCH. (OPENSEARCH)

list_integrations

Name	Datatype	Description
integration_summaries	array	An array, where each object in the array contains information about one CloudWatch Logs integration in this account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_integration	select	region		Returns information about one integration between CloudWatch Logs and OpenSearch Service.
list_integrations	select	region		Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.
associate_source_to_s3_table_integration	update	region, integrationArn, dataSource		Associates a data source with an S3 Table Integration for query access in the 'logs' namespace. This enables querying log data using analytics engines that support Iceberg such as Amazon Athena, Amazon Redshift, and Apache Spark.
disassociate_source_from_s3_table_integration	update	region, identifier		Disassociates a data source from an S3 Table Integration, removing query access and deleting all associated data from the integration.
put_integration	replace	region, integrationName, resourceConfig, integrationType		Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account. Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see Vended log dashboards powered by Amazon OpenSearch Service. You can use this operation only to create a new integration. You can't modify an existing integration.
delete_integration	delete	region		Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, you must specify true for the force parameter, otherwise the operation will fail. If you delete the integration by setting force to true, all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them will no longer be accessible.

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

Returns information about one integration between CloudWatch Logs and OpenSearch Service.

SELECT
integration_details,
integration_name,
integration_status,
integration_type
FROM aws.logs.integrations
WHERE region = '{{ region }}' -- required
;

list_integrations

Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one integration can be created in an account, and this integration must be with OpenSearch Service.

SELECT
integration_summaries
FROM aws.logs.integrations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

associate_source_to_s3_table_integration

Associates a data source with an S3 Table Integration for query access in the 'logs' namespace. This enables querying log data using analytics engines that support Iceberg such as Amazon Athena, Amazon Redshift, and Apache Spark.

UPDATE aws.logs.integrations
SET 
integrationArn = '{{ integrationArn }}',
dataSource = '{{ dataSource }}'
WHERE 
region = '{{ region }}' --required
AND integrationArn = '{{ integrationArn }}' --required
AND dataSource = '{{ dataSource }}' --required
RETURNING
identifier;

disassociate_source_from_s3_table_integration

Disassociates a data source from an S3 Table Integration, removing query access and deleting all associated data from the integration.

UPDATE aws.logs.integrations
SET 
identifier = '{{ identifier }}'
WHERE 
region = '{{ region }}' --required
AND identifier = '{{ identifier }}' --required
RETURNING
identifier;

REPLACE examples

put_integration

Creates an integration between CloudWatch Logs and another service in this account. Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account. Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see Vended log dashboards powered by Amazon OpenSearch Service. You can use this operation only to create a new integration. You can't modify an existing integration.

REPLACE aws.logs.integrations
SET 
integrationName = '{{ integrationName }}',
resourceConfig = '{{ resourceConfig }}',
integrationType = '{{ integrationType }}'
WHERE 
region = '{{ region }}' --required
AND integrationName = '{{ integrationName }}' --required
AND resourceConfig = '{{ resourceConfig }}' --required
AND integrationType = '{{ integrationType }}' --required
RETURNING
integration_name,
integration_status;

DELETE examples

delete_integration

Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards, you must specify true for the force parameter, otherwise the operation will fail. If you delete the integration by setting force to true, all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them will no longer be accessible.

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