elasticsearch_domain_configs

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

Overview

Name	elasticsearch_domain_configs
Type	Resource
Id	aws.es.elasticsearch_domain_configs

Fields

The following fields are returned by SELECT queries:

describe_elasticsearch_domain_config

Name	Datatype	Description
access_policies	object	IAM access policy as a JSON-formatted string.
advanced_options	object	Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
advanced_security_options	object	Specifies AdvancedSecurityOptions for the domain.
auto_tune_options	object	Specifies AutoTuneOptions for the domain.
automated_snapshot_pause_options	object	Specifies AutomatedSnapshotPauseOptions for the domain.
change_progress_details	object	Specifies change details of the domain configuration change.
cognito_options	object	The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
deployment_strategy_options	object	Specifies DeploymentStrategyOptions for the domain.
domain_endpoint_options	object	Specifies the DomainEndpointOptions for the Elasticsearch domain.
ebs_options	object	Specifies the EBSOptions for the Elasticsearch domain.
elasticsearch_cluster_config	object	Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
elasticsearch_version	object	String of format X.Y to specify version for the Elasticsearch domain.
encryption_at_rest_options	object	Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
engine_mode	object	The engine mode configured for the domain.
log_publishing_options	object	Log publishing options for the given domain.
modifying_properties	array	Information about the domain properties that are currently being modified.
node_to_node_encryption_options	object	Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
snapshot_options	object	Specifies the SnapshotOptions for the Elasticsearch domain.
use_case	object	The use case configured for the domain.
vpc_options	object	The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_elasticsearch_domain_config	select	domain_name, region		Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
update_elasticsearch_domain_config	update	domain_name, region		Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

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
domain_name	string	The name of the Elasticsearch domain that you are updating.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_elasticsearch_domain_config

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

SELECT
access_policies,
advanced_options,
advanced_security_options,
auto_tune_options,
automated_snapshot_pause_options,
change_progress_details,
cognito_options,
deployment_strategy_options,
domain_endpoint_options,
ebs_options,
elasticsearch_cluster_config,
elasticsearch_version,
encryption_at_rest_options,
engine_mode,
log_publishing_options,
modifying_properties,
node_to_node_encryption_options,
snapshot_options,
use_case,
vpc_options
FROM aws.es.elasticsearch_domain_configs
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_elasticsearch_domain_config

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

UPDATE aws.es.elasticsearch_domain_configs
SET 
ElasticsearchClusterConfig = '{{ ElasticsearchClusterConfig }}',
EBSOptions = '{{ EBSOptions }}',
SnapshotOptions = '{{ SnapshotOptions }}',
VPCOptions = '{{ VPCOptions }}',
CognitoOptions = '{{ CognitoOptions }}',
AdvancedOptions = '{{ AdvancedOptions }}',
AccessPolicies = '{{ AccessPolicies }}',
LogPublishingOptions = '{{ LogPublishingOptions }}',
DomainEndpointOptions = '{{ DomainEndpointOptions }}',
AdvancedSecurityOptions = '{{ AdvancedSecurityOptions }}',
NodeToNodeEncryptionOptions = '{{ NodeToNodeEncryptionOptions }}',
EncryptionAtRestOptions = '{{ EncryptionAtRestOptions }}',
AutoTuneOptions = '{{ AutoTuneOptions }}',
DryRun = {{ DryRun }},
DeploymentStrategyOptions = '{{ DeploymentStrategyOptions }}',
AutomatedSnapshotPauseOptions = '{{ AutomatedSnapshotPauseOptions }}',
UseCase = '{{ UseCase }}',
EngineMode = '{{ EngineMode }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
RETURNING
domain_config,
dry_run_results;