steampipe plugin install awssteampipe plugin install aws

Table: aws_opensearch_domain

Amazon OpenSearch Service is a managed service that makes it easy to deploy, operate, and scale OpenSearch clusters in the AWS Clouds. Domains are clusters with the settings, instance types, instance counts, and storage resources that you specify.

Example

Basic info

select
  domain_name,
  domain_id,
  arn,
  engine_version,
  created
from
  aws_opensearch_domain;

List domains that are not encrypted at rest

select
  domain_name,
  domain_id,
  encryption_at_rest_options ->> 'Enabled' as enabled,
  encryption_at_rest_options ->> 'KmsKeyId' as kms_key_id
from
  aws_opensearch_domain
where
  encryption_at_rest_options ->> 'Enabled' = 'false';

Get storage details for domains that are using EBS storage type

select
  domain_name,
  domain_id,
  ebs_options ->> 'VolumeSize' as volume_size,
  ebs_options ->> 'VolumeType' as volume_type,
  ebs_options ->> 'EBSEnabled' as ebs_enabled
from
  aws_opensearch_domain
where
  ebs_options ->> 'EBSEnabled' = 'true';

Get network details for each domain

select
  domain_name,
  vpc_options ->> 'AvailabilityZones' as availability_zones,
  vpc_options ->> 'SecurityGroupIds' as security_group_ids,
  vpc_options ->> 'SubnetIds' as subnet_ids,
  vpc_options ->> 'VPCId' as vpc_id
from
  aws_opensearch_domain
where
  vpc_options ->> 'AvailabilityZones' is not null;

Get the instance details for each domain

select
  domain_name,
  domain_id,
  cluster_config ->> 'InstanceType' as instance_type,
  cluster_config ->> 'InstanceCount' as instance_count
from
  aws_opensearch_domain;

List domains that are publicly accessible

select
  domain_name,
  domain_id,
  arn,
  engine_version,
  created
from
  aws_opensearch_domain
where
  vpc_options is null;

List domain log publishing options

select
  domain_name,
  domain_id,
  log_publishing_options
from
  aws_opensearch_domain;

List domain Search slow logs details

select
  domain_name,
  domain_id,
  log_publishing_options -> 'SEARCH_SLOW_LOGS' -> 'Enabled' as enabled,
  log_publishing_options -> 'SEARCH_SLOW_LOGS' -> 'CloudWatchLogsLogGroupArn' as cloud_watch_logs_log_group_arn
from
  aws_opensearch_domain;

Query examples

opensearch_domains_for_acm_certificate

Control examples

.inspect aws_opensearch_domain

AWS OpenSearch Domain

Name	Type	Description
_ctx	jsonb	Steampipe context in JSON form, e.g. connection_name.
access_policies	text	The IAM access policies of the domain.
account_id	text	The AWS Account ID in which the resource is located.
advanced_options	jsonb	Specifies the status of the advanced options.
advanced_security_options	jsonb	Specifies The current status of the OpenSearch domain's advanced security options.
akas	jsonb	Array of globally unique identifier strings (also known as) for the resource.
arn	text	The Amazon Resource Name (ARN) of the domain.
auto_tune_options	jsonb	The current status of the domain's auto-tune options.
cluster_config	jsonb	The type and number of instances in the domain.
cognito_options	jsonb	The cognito options for the specified domain.
created	boolean	The domain creation status.
deleted	boolean	The domain deletion status.
domain_endpoint_options	jsonb	The current status of the domain's endpoint options.
domain_id	text	The unique identifier for the specified domain.
domain_name	text	The name of the domain.
ebs_options	jsonb	The EBSOptions for the specified domain.
encryption_at_rest_options	jsonb	The status of the encryption at rest options.
endpoint	text	The domain endpoint that is used to submit index and search requests.
endpoints	jsonb	Map containing the domain endpoints used to submit index and search requests.
engine_version	text	The domain's OpenSearch version.
log_publishing_options	jsonb	Log publishing options for the given domain.
node_to_node_encryption_options_enabled	boolean	Specifies the status of the node to node encryption status.
partition	text	The AWS partition in which the resource is located (aws, aws-cn, or aws-us-gov).
processing	boolean	The status of the domain configuration.
region	text	The AWS Region in which the resource is located.
service_software_options	jsonb	The current status of the domain's service software.
snapshot_options	jsonb	Specifies the status of the snapshot options.
tags	jsonb	A map of tags for the resource.
tags_src	jsonb	A list of tags assigned to the domain.
title	text	Title of the resource.
upgrade_processing	boolean	The status of the domain version upgrade.
vpc_options	jsonb	The vpc options for the specified domain.

turbot/aws