steampipe plugin install aws

Table: aws_cloudsearch_domain - Query AWS CloudSearch Domain using SQL

The AWS CloudSearch Domain is a component of AWS CloudSearch, a fully-managed service that makes it easy to set up, manage, and scale a search solution for your website or application. AWS CloudSearch features include indexing of data, running search queries, and updating the search index. It provides a high level of flexibility and scalability, allowing you to search large collections of data efficiently.

Table Usage Guide

The aws_cloudsearch_domain table in Steampipe provides you with information about each search domain configured within your AWS account. This table allows you, as a DevOps engineer, data analyst, or other technical professional, to query domain-specific details, including the domain's ARN, creation date, domain ID, and associated metadata. You can utilize this table to gather insights on domains, such as the status, endpoint, and whether the domain requires signing. The schema outlines the various attributes of the CloudSearch domain for you, including the domain ARN, creation date, document count, and associated tags.

Examples

Basic info

Explore the basic information about your AWS CloudSearch domains, such as when they were created and the type and count of search instances. This can help manage resources and assess the capacity and usage of your search domains.

select
domain_name,
domain_id,
arn,
created,
search_instance_type,
search_instance_count
from
aws_cloudsearch_domain;
select
domain_name,
domain_id,
arn,
created,
search_instance_type,
search_instance_count
from
aws_cloudsearch_domain;

List domains by instance type

Identify instances where specific domains are linked to a certain type of search instance. This can be useful to understand the spread and usage of different search instances across your domains.

select
domain_name,
domain_id,
arn,
created,
search_instance_type
from
aws_cloudsearch_domain
where
search_instance_type = 'search.small';
select
domain_name,
domain_id,
arn,
created,
search_instance_type
from
aws_cloudsearch_domain
where
search_instance_type = 'search.small';

Get limit details for each domain

Explore the limits set for each domain in your AWS CloudSearch to understand how it may impact the performance and availability of your search service. This can help in optimizing the search service configuration for better resource management.

select
domain_name,
domain_id,
search_service ->> 'Endpoint' as search_service_endpoint,
limits ->> 'MaximumPartitionCount' as maximum_partition_count,
limits ->> 'MaximumReplicationCount' as maximum_replication_count
from
aws_cloudsearch_domain;
select
domain_name,
domain_id,
json_extract(search_service, '$.Endpoint') as search_service_endpoint,
json_extract(limits, '$.MaximumPartitionCount') as maximum_partition_count,
json_extract(limits, '$.MaximumReplicationCount') as maximum_replication_count
from
aws_cloudsearch_domain;

Schema for aws_cloudsearch_domain

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form.
account_idtext=, !=, ~~, ~~*, !~~, !~~*The AWS Account ID in which the resource is located.
akasjsonbArray of globally unique identifier strings (also known as) for the resource.
arntextThe Amazon Resource Name (ARN) of the search domain.
createdbooleanTrue if the search domain is created.
deletedbooleanTrue if the search domain has been deleted.
doc_servicejsonbThe service endpoint for updating documents in a search domain.
domain_idtextAn internally generated unique identifier for a domain.
domain_nametext=A string that represents the name of a domain.
limitsjsonbLimit details for a search domain.
partitiontextThe AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov).
processingbooleanTrue if processing is being done to activate the current domain configuration.
regiontextThe AWS Region in which the resource is located.
requires_index_documentsbooleanTrue if Index Documents need to be called to activate the current domain configuration.
search_instance_countbigintThe number of search instances that are available to process search requests.
search_instance_typetextThe instance type that is being used to process search requests.
search_partition_countbigintThe number of partitions across which the search index is spread.
search_servicejsonbThe service endpoint for requesting search results from a search domain.
sp_connection_nametext=, !=, ~~, ~~*, !~~, !~~*Steampipe connection name.
sp_ctxjsonbSteampipe context in JSON form.
titletextTitle of the resource.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- aws

You can pass the configuration to the command with the --config argument:

steampipe_export_aws --config '<your_config>' aws_cloudsearch_domain