direct_query_data_sources

Creates, updates, deletes, gets or lists a direct_query_data_sources resource.

Overview

Name	direct_query_data_sources
Type	Resource
Id	aws.opensearch.direct_query_data_sources

Fields

The following fields are returned by SELECT queries:

get_direct_query_data_source

Name	Datatype	Description
data_source_access_policy	string	Access policy rules for an Amazon OpenSearch Service domain endpoint. For more information, see Configuring access policies. The maximum size of a policy document is 100 KB. (pattern: <code>.*</code>)
data_source_arn	string	The unique, system-generated identifier that represents the data source.
data_source_name	string	A unique, user-defined label to identify the data source within your OpenSearch Service environment. (pattern: <code>[a-z][a-z0-9_]+</code>)
data_source_type	object	The type of data source that is used for direct queries. This is a supported Amazon Web Services service, such as CloudWatch Logs or Security Lake.
description	string	A description that provides additional context and details about the data source. (pattern: <code>^([a-zA-Z0-9_])[\a-zA-Z0-9_@#%+=:?./!\s-]*$</code>)
open_search_arns	array	A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.

list_direct_query_data_sources

Name	Datatype	Description
direct_query_data_sources	array	A list of the direct query data sources that are returned by the ListDirectQueryDataSources API operation.
next_token	string	When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_direct_query_data_source	select	data_source_name, region		Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.
list_direct_query_data_sources	select	region	nexttoken	Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.
add_direct_query_data_source	update	region, DataSourceName, DataSourceType		Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.
update_direct_query_data_source	update	data_source_name, region, DataSourceType		Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.
delete_direct_query_data_source	delete	data_source_name, region		Deletes a previously configured direct query data source from Amazon OpenSearch Service.

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
data_source_name	string	A unique, user-defined label to identify the data source within your OpenSearch Service environment.
region	string	AWS region (default: us-east-1)
nexttoken	string

SELECT examples

get_direct_query_data_source

Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.

SELECT
data_source_access_policy,
data_source_arn,
data_source_name,
data_source_type,
description,
open_search_arns
FROM aws.opensearch.direct_query_data_sources
WHERE data_source_name = '{{ data_source_name }}' -- required
AND region = '{{ region }}' -- required
;

list_direct_query_data_sources

Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.

SELECT
direct_query_data_sources,
next_token
FROM aws.opensearch.direct_query_data_sources
WHERE region = '{{ region }}' -- required
AND nexttoken = '{{ nexttoken }}'
;

UPDATE examples

add_direct_query_data_source

Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.

UPDATE aws.opensearch.direct_query_data_sources
SET 
DataSourceName = '{{ DataSourceName }}',
DataSourceType = '{{ DataSourceType }}',
Description = '{{ Description }}',
OpenSearchArns = '{{ OpenSearchArns }}',
DataSourceAccessPolicy = '{{ DataSourceAccessPolicy }}',
TagList = '{{ TagList }}'
WHERE 
region = '{{ region }}' --required
AND DataSourceName = '{{ DataSourceName }}' --required
AND DataSourceType = '{{ DataSourceType }}' --required
RETURNING
data_source_arn;

update_direct_query_data_source

Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.

UPDATE aws.opensearch.direct_query_data_sources
SET 
DataSourceType = '{{ DataSourceType }}',
Description = '{{ Description }}',
OpenSearchArns = '{{ OpenSearchArns }}',
DataSourceAccessPolicy = '{{ DataSourceAccessPolicy }}'
WHERE 
data_source_name = '{{ data_source_name }}' --required
AND region = '{{ region }}' --required
AND DataSourceType = '{{ DataSourceType }}' --required
RETURNING
data_source_arn;

DELETE examples

delete_direct_query_data_source

Deletes a previously configured direct query data source from Amazon OpenSearch Service.

DELETE FROM aws.opensearch.direct_query_data_sources
WHERE data_source_name = '{{ data_source_name }}' --required
AND region = '{{ region }}' --required
;