domain_configs

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

Overview

Name	domain_configs
Type	Resource
Id	aws.opensearch.domain_configs

Fields

The following fields are returned by SELECT queries:

describe_domain_config

Name	Datatype	Description
aiml_options	object	Container for parameters required to enable all machine learning features.
access_policies	object	Specifies the access policies for the domain.
advanced_options	object	Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
advanced_security_options	object	Container for fine-grained access control settings for the domain.
auto_tune_options	object	Container for Auto-Tune settings for the domain.
automated_snapshot_pause_options	object	Specifies AutomatedSnapshotPauseOptions for the domain.
change_progress_details	object	Container for information about the progress of an existing configuration change.
cluster_config	object	Container for the cluster configuration of a the domain.
cognito_options	object	Container for Amazon Cognito options for the domain.
deployment_strategy_options	object	Specifies DeploymentStrategyOptions for the domain.
domain_endpoint_options	object	Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
ebs_options	object	Container for EBS options configured for the domain.
encryption_at_rest_options	object	Key-value pairs to enable encryption at rest.
engine_mode	object	The engine mode configured for the domain.
engine_version	object	The OpenSearch or Elasticsearch version that the domain is running.
ip_address_type	object	Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
identity_center_options	object	Configuration options for enabling and managing IAM Identity Center integration within a domain.
log_publishing_options	object	Key-value pairs to configure log publishing.
modifying_properties	array	Information about the domain properties that are currently being modified.
node_to_node_encryption_options	object	Whether node-to-node encryption is enabled or disabled.
off_peak_window_options	object	Container for off-peak window options for the domain.
snapshot_options	object	DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
software_update_options	object	Software update options for the domain.
use_case	object	The use case configured for the domain.
vpc_options	object	The current VPC options for the domain and the status of any updates to their configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain_config	select	domain_name, region		Returns the configuration of an Amazon OpenSearch Service domain.
update_domain_config	update	domain_name, region		Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
cancel_domain_config_change	exec	domain_name, region		Cancels a pending configuration change on an Amazon OpenSearch Service domain.

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
region	string	AWS region (default: us-east-1)

SELECT examples

describe_domain_config

Returns the configuration of an Amazon OpenSearch Service domain.

SELECT
aiml_options,
access_policies,
advanced_options,
advanced_security_options,
auto_tune_options,
automated_snapshot_pause_options,
change_progress_details,
cluster_config,
cognito_options,
deployment_strategy_options,
domain_endpoint_options,
ebs_options,
encryption_at_rest_options,
engine_mode,
engine_version,
ip_address_type,
identity_center_options,
log_publishing_options,
modifying_properties,
node_to_node_encryption_options,
off_peak_window_options,
snapshot_options,
software_update_options,
use_case,
vpc_options
FROM aws.opensearch.domain_configs
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_domain_config

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

UPDATE aws.opensearch.domain_configs
SET 
ClusterConfig = '{{ ClusterConfig }}',
EBSOptions = '{{ EBSOptions }}',
SnapshotOptions = '{{ SnapshotOptions }}',
VPCOptions = '{{ VPCOptions }}',
CognitoOptions = '{{ CognitoOptions }}',
AdvancedOptions = '{{ AdvancedOptions }}',
AccessPolicies = '{{ AccessPolicies }}',
IPAddressType = '{{ IPAddressType }}',
LogPublishingOptions = '{{ LogPublishingOptions }}',
EncryptionAtRestOptions = '{{ EncryptionAtRestOptions }}',
DomainEndpointOptions = '{{ DomainEndpointOptions }}',
NodeToNodeEncryptionOptions = '{{ NodeToNodeEncryptionOptions }}',
AdvancedSecurityOptions = '{{ AdvancedSecurityOptions }}',
IdentityCenterOptions = '{{ IdentityCenterOptions }}',
AutoTuneOptions = '{{ AutoTuneOptions }}',
DryRun = {{ DryRun }},
DryRunMode = '{{ DryRunMode }}',
OffPeakWindowOptions = '{{ OffPeakWindowOptions }}',
SoftwareUpdateOptions = '{{ SoftwareUpdateOptions }}',
AIMLOptions = '{{ AIMLOptions }}',
DeploymentStrategyOptions = '{{ DeploymentStrategyOptions }}',
AutomatedSnapshotPauseOptions = '{{ AutomatedSnapshotPauseOptions }}',
UseCase = '{{ UseCase }}',
EngineMode = '{{ EngineMode }}'
WHERE 
domain_name = '{{ domain_name }}' --required
AND region = '{{ region }}' --required
RETURNING
domain_config,
dry_run_progress_status,
dry_run_results;

Lifecycle Methods

cancel_domain_config_change

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

EXEC aws.opensearch.domain_configs.cancel_domain_config_change 
@domain_name='{{ domain_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"DryRun": {{ DryRun }}
}'
;