domain

Gets an individual domain resource

Overview

Name	domain
Type	Resource
Description	domain
Id	awscc.opensearchservice.domain

Fields

Name	Datatype	Description
cluster_config	object
domain_name	string
access_policies	object
ip_address_type	string
engine_version	string
advanced_options	object
log_publishing_options	object
snapshot_options	object
vpc_options	object
node_to_node_encryption_options	object
domain_endpoint_options	object
cognito_options	object
advanced_security_options	object
domain_endpoint	string
domain_endpoint_v2	string
domain_endpoints	object
ebs_options	object
id	string
arn	string
domain_arn	string
encryption_at_rest_options	object
tags	array	An arbitrary set of tags (key-value pairs) for this Domain.
service_software_options	object
off_peak_window_options	object
software_update_options	object
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
cluster_config,
domain_name,
access_policies,
ip_address_type,
engine_version,
advanced_options,
log_publishing_options,
snapshot_options,
vpc_options,
node_to_node_encryption_options,
domain_endpoint_options,
cognito_options,
advanced_security_options,
domain_endpoint,
domain_endpoint_v2,
domain_endpoints,
ebs_options,
id,
arn,
domain_arn,
encryption_at_rest_options,
tags,
service_software_options,
off_peak_window_options,
software_update_options
FROM awscc.opensearchservice.domain
WHERE data__Identifier = '<DomainName>';

Permissions

To operate on the domain resource, the following permissions are required:

Read

es:DescribeDomain,
es:ListTags

Update

es:UpdateDomain,
es:UpgradeDomain,
es:DescribeDomain,
es:AddTags,
es:RemoveTags,
es:ListTags,
es:DescribeDomainChangeProgress

Delete

es:DeleteDomain,
es:DescribeDomain