aws.opensearch.describe_domain_config

Example SQL Queries

SELECT * FROM
aws.opensearch.describe_domain_config
WHERE
"domain_name" = 'VALUE';

Description

Returns the configuration of an Amazon OpenSearch Service domain.

• View All OpenSearch Tables
• Boto3 Reference

Table Definition

Column Name	Column Data Type
domain_name Required Input Column Name of the OpenSearch Service domain configuration that you want to describe.	VARCHAR
_aws_profile Input Column The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.	STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) )
Show child fields _aws_profile.account_id The AWS account id _aws_profile.assumed_role_arn The ARN of the assumed role _aws_profile.name The unique name of the profile. _aws_profile.organization Information about this profile's membership in the AWS organization. Show child fields _aws_profile.organization.account_name The name of account speciifed by the organization _aws_profile.organization.id The organization id _aws_profile.organization.master_account Show child fields _aws_profile.organization.master_account.email The organization master account email address _aws_profile.organization.master_account.id The organization master account id _aws_profile.organization.parents[] Show child fields _aws_profile.organization.parents[].id The id of the parent _aws_profile.organization.parents[].name The name of the parent _aws_profile.organization.parents[].tags[] Show child fields _aws_profile.organization.parents[].tags[].key _aws_profile.organization.parents[].tags[].value _aws_profile.organization.parents[].type The type of parent can be an organization unit or a root _aws_profile.organization.tags[] Show child fields _aws_profile.organization.tags[].key _aws_profile.organization.tags[].value _aws_profile.type The type of profile, either 'credentials' or 'assumed_role' _aws_profile.via_profile_name This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
domain_config Container for the configuration of the OpenSearch Service domain.	STRUCT( "engine_version" STRUCT( "options" VARCHAR, "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "cluster_config" STRUCT( "options" STRUCT( "instance_type" VARCHAR, "instance_count" BIGINT, "dedicated_master_enabled" BOOLEAN, "zone_awareness_enabled" BOOLEAN, "zone_awareness_config" STRUCT( "availability_zone_count" BIGINT ), "dedicated_master_type" VARCHAR, "dedicated_master_count" BIGINT, "warm_enabled" BOOLEAN, "warm_type" VARCHAR, "warm_count" BIGINT, "cold_storage_options" STRUCT( "enabled" BOOLEAN ), "multi_az_with_standby_enabled" BOOLEAN ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "ebs_options" STRUCT( "options" STRUCT( "ebs_enabled" BOOLEAN, "volume_type" VARCHAR, "volume_size" BIGINT, "iops" BIGINT, "throughput" BIGINT ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "access_policies" STRUCT( "options" VARCHAR, "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "ip_address_type" STRUCT( "options" VARCHAR, "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "snapshot_options" STRUCT( "options" STRUCT( "automated_snapshot_start_hour" BIGINT ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "vpc_options" STRUCT( "options" STRUCT( "vpc_id" VARCHAR, "subnet_ids" VARCHAR[], "availability_zones" VARCHAR[], "security_group_ids" VARCHAR[] ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "cognito_options" STRUCT( "options" STRUCT( "enabled" BOOLEAN, "user_pool_id" VARCHAR, "identity_pool_id" VARCHAR, "role_arn" VARCHAR ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "encryption_at_rest_options" STRUCT( "options" STRUCT( "enabled" BOOLEAN, "kms_key_id" VARCHAR ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "node_to_node_encryption_options" STRUCT( "options" STRUCT( "enabled" BOOLEAN ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "advanced_options" STRUCT( "options" MAP(VARCHAR, VARCHAR), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "log_publishing_options" STRUCT( "options" MAP(VARCHAR, STRUCT( "cloud_watch_logs_log_group_arn" VARCHAR, "enabled" BOOLEAN )), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "domain_endpoint_options" STRUCT( "options" STRUCT( "enforce_https" BOOLEAN, "tls_security_policy" VARCHAR, "custom_endpoint_enabled" BOOLEAN, "custom_endpoint" VARCHAR, "custom_endpoint_certificate_arn" VARCHAR ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "advanced_security_options" STRUCT( "options" STRUCT( "enabled" BOOLEAN, "internal_user_database_enabled" BOOLEAN, "saml_options" STRUCT( "enabled" BOOLEAN, "idp" STRUCT( "metadata_content" VARCHAR, "entity_id" VARCHAR ), "subject_key" VARCHAR, "roles_key" VARCHAR, "session_timeout_minutes" BIGINT ), "jwt_options" STRUCT( "enabled" BOOLEAN, "subject_key" VARCHAR, "roles_key" VARCHAR, "public_key" VARCHAR ), "anonymous_auth_disable_date" TIMESTAMP_S, "anonymous_auth_enabled" BOOLEAN ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "auto_tune_options" STRUCT( "options" STRUCT( "desired_state" VARCHAR, "rollback_on_disable" VARCHAR, "maintenance_schedules" STRUCT( "start_at" TIMESTAMP_S, "duration" STRUCT( "value" BIGINT, "unit" VARCHAR ), "cron_expression_for_recurrence" VARCHAR )[], "use_off_peak_window" BOOLEAN ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "error_message" VARCHAR, "pending_deletion" BOOLEAN ) ), "change_progress_details" STRUCT( "change_id" VARCHAR, "message" VARCHAR, "config_change_status" VARCHAR, "initiated_by" VARCHAR, "start_time" TIMESTAMP_S, "last_updated_time" TIMESTAMP_S ), "off_peak_window_options" STRUCT( "options" STRUCT( "enabled" BOOLEAN, "off_peak_window" STRUCT( "window_start_time" STRUCT( "hours" BIGINT, "minutes" BIGINT ) ) ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "software_update_options" STRUCT( "options" STRUCT( "auto_software_update_enabled" BOOLEAN ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ), "modifying_properties" STRUCT( "name" VARCHAR, "active_value" VARCHAR, "pending_value" VARCHAR, "value_type" VARCHAR )[], "aiml_options" STRUCT( "options" STRUCT( "natural_language_query_generation_options" STRUCT( "desired_state" VARCHAR, "current_state" VARCHAR ) ), "status" STRUCT( "creation_date" TIMESTAMP_S, "update_date" TIMESTAMP_S, "update_version" BIGINT, "state" VARCHAR, "pending_deletion" BOOLEAN ) ) )
Show child fields domain_config.access_policies Specifies the access policies for the domain. Show child fields domain_config.access_policies.options The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies. domain_config.access_policies.status The status of the access policy for the domain. Show child fields domain_config.access_policies.status.creation_date The timestamp when the entity was created. domain_config.access_policies.status.pending_deletion Indicates whether the entity is being deleted. domain_config.access_policies.status.state The state of the entity. domain_config.access_policies.status.update_date The timestamp of the last time the entity was updated. domain_config.access_policies.status.update_version The latest version of the entity. domain_config.advanced_options Key-value pairs to specify advanced configuration options. For more information, see Advanced options. Show child fields domain_config.advanced_options.options The status of advanced options for the specified domain. domain_config.advanced_options.status The status of advanced options for the specified domain. Show child fields domain_config.advanced_options.status.creation_date The timestamp when the entity was created. domain_config.advanced_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.advanced_options.status.state The state of the entity. domain_config.advanced_options.status.update_date The timestamp of the last time the entity was updated. domain_config.advanced_options.status.update_version The latest version of the entity. domain_config.advanced_security_options Container for fine-grained access control settings for the domain. Show child fields domain_config.advanced_security_options.options Container for fine-grained access control settings. Show child fields domain_config.advanced_security_options.options.anonymous_auth_disable_date Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain. domain_config.advanced_security_options.options.anonymous_auth_enabled True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain. domain_config.advanced_security_options.options.enabled True if fine-grained access control is enabled. domain_config.advanced_security_options.options.internal_user_database_enabled True if the internal user database is enabled. domain_config.advanced_security_options.options.jwt_options Container for information about the JWT configuration of the Amazon OpenSearch Service. Show child fields domain_config.advanced_security_options.options.jwt_options.enabled True if JWT use is enabled. domain_config.advanced_security_options.options.jwt_options.public_key The key used to verify the signature of incoming JWT requests. domain_config.advanced_security_options.options.jwt_options.roles_key The key used for matching the JWT roles attribute. domain_config.advanced_security_options.options.jwt_options.subject_key The key used for matching the JWT subject attribute. domain_config.advanced_security_options.options.saml_options Container for information about the SAML configuration for OpenSearch Dashboards. Show child fields domain_config.advanced_security_options.options.saml_options.enabled True if SAML is enabled. domain_config.advanced_security_options.options.saml_options.idp Describes the SAML identity provider's information. Show child fields domain_config.advanced_security_options.options.saml_options.idp.entity_id The unique entity ID of the application in the SAML identity provider. domain_config.advanced_security_options.options.saml_options.idp.metadata_content The metadata of the SAML application, in XML format. domain_config.advanced_security_options.options.saml_options.roles_key The key used for matching the SAML roles attribute. domain_config.advanced_security_options.options.saml_options.session_timeout_minutes The duration, in minutes, after which a user session becomes inactive. domain_config.advanced_security_options.options.saml_options.subject_key The key used for matching the SAML subject attribute. domain_config.advanced_security_options.status Status of the fine-grained access control settings for a domain. Show child fields domain_config.advanced_security_options.status.creation_date The timestamp when the entity was created. domain_config.advanced_security_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.advanced_security_options.status.state The state of the entity. domain_config.advanced_security_options.status.update_date The timestamp of the last time the entity was updated. domain_config.advanced_security_options.status.update_version The latest version of the entity. domain_config.aiml_options Container for parameters required to enable all machine learning features. Show child fields domain_config.aiml_options.options Machine learning options on the specified domain. Show child fields domain_config.aiml_options.options.natural_language_query_generation_options Container for parameters required for natural language query generation on the specified domain. Show child fields domain_config.aiml_options.options.natural_language_query_generation_options.current_state The current state of the natural language query generation feature, indicating completion, in progress, or failure. domain_config.aiml_options.options.natural_language_query_generation_options.desired_state The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED. domain_config.aiml_options.status Provides the current status of an entity. Show child fields domain_config.aiml_options.status.creation_date The timestamp when the entity was created. domain_config.aiml_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.aiml_options.status.state The state of the entity. domain_config.aiml_options.status.update_date The timestamp of the last time the entity was updated. domain_config.aiml_options.status.update_version The latest version of the entity. domain_config.auto_tune_options Container for Auto-Tune settings for the domain. Show child fields domain_config.auto_tune_options.options Auto-Tune settings for updating a domain. Show child fields domain_config.auto_tune_options.options.desired_state Whether Auto-Tune is enabled or disabled. domain_config.auto_tune_options.options.maintenance_schedules[] Show child fields domain_config.auto_tune_options.options.maintenance_schedules[].cron_expression_for_recurrence A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes. domain_config.auto_tune_options.options.maintenance_schedules[].duration The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}. Show child fields domain_config.auto_tune_options.options.maintenance_schedules[].duration.unit The unit of measurement for the duration of a maintenance schedule. domain_config.auto_tune_options.options.maintenance_schedules[].duration.value Integer to specify the value of a maintenance schedule duration. domain_config.auto_tune_options.options.maintenance_schedules[].start_at The Epoch timestamp at which the Auto-Tune maintenance schedule starts. domain_config.auto_tune_options.options.rollback_on_disable When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback. domain_config.auto_tune_options.options.use_off_peak_window Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule. domain_config.auto_tune_options.status The current status of Auto-Tune for a domain. Show child fields domain_config.auto_tune_options.status.creation_date Date and time when Auto-Tune was enabled for the domain. domain_config.auto_tune_options.status.error_message Any errors that occurred while enabling or disabling Auto-Tune. domain_config.auto_tune_options.status.pending_deletion Indicates whether the domain is being deleted. domain_config.auto_tune_options.status.state The current state of Auto-Tune on the domain. domain_config.auto_tune_options.status.update_date Date and time when the Auto-Tune options were last updated for the domain. domain_config.auto_tune_options.status.update_version The latest version of the Auto-Tune options. domain_config.change_progress_details Container for information about the progress of an existing configuration change. Show child fields domain_config.change_progress_details.change_id The ID of the configuration change. domain_config.change_progress_details.config_change_status The current status of the configuration change. domain_config.change_progress_details.initiated_by The IAM principal who initiated the configuration change. domain_config.change_progress_details.last_updated_time The last time that the configuration change was updated. domain_config.change_progress_details.message A message corresponding to the status of the configuration change. domain_config.change_progress_details.start_time The time that the configuration change was initiated, in Universal Coordinated Time (UTC). domain_config.cluster_config Container for the cluster configuration of a the domain. Show child fields domain_config.cluster_config.options Cluster configuration options for the specified domain. Show child fields domain_config.cluster_config.options.cold_storage_options Container for cold storage configuration options. Show child fields domain_config.cluster_config.options.cold_storage_options.enabled Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage. domain_config.cluster_config.options.dedicated_master_count Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception. domain_config.cluster_config.options.dedicated_master_enabled Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not. domain_config.cluster_config.options.dedicated_master_type OpenSearch Service instance type of the dedicated master nodes in the cluster. domain_config.cluster_config.options.instance_count Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception. domain_config.cluster_config.options.instance_type Instance type of data nodes in the cluster. domain_config.cluster_config.options.multi_az_with_standby_enabled A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. domain_config.cluster_config.options.warm_count The number of warm nodes in the cluster. domain_config.cluster_config.options.warm_enabled Whether to enable warm storage for the cluster. domain_config.cluster_config.options.warm_type The instance type for the cluster's warm nodes. domain_config.cluster_config.options.zone_awareness_config Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true. Show child fields domain_config.cluster_config.options.zone_awareness_config.availability_zone_count If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets. domain_config.cluster_config.options.zone_awareness_enabled Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service. domain_config.cluster_config.status The status of cluster configuration options for the specified domain. Show child fields domain_config.cluster_config.status.creation_date The timestamp when the entity was created. domain_config.cluster_config.status.pending_deletion Indicates whether the entity is being deleted. domain_config.cluster_config.status.state The state of the entity. domain_config.cluster_config.status.update_date The timestamp of the last time the entity was updated. domain_config.cluster_config.status.update_version The latest version of the entity. domain_config.cognito_options Container for Amazon Cognito options for the domain. Show child fields domain_config.cognito_options.options Cognito options for the specified domain. Show child fields domain_config.cognito_options.options.enabled Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards. domain_config.cognito_options.options.identity_pool_id The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. domain_config.cognito_options.options.role_arn The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool. domain_config.cognito_options.options.user_pool_id The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication. domain_config.cognito_options.status The status of the Cognito options for the specified domain. Show child fields domain_config.cognito_options.status.creation_date The timestamp when the entity was created. domain_config.cognito_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.cognito_options.status.state The state of the entity. domain_config.cognito_options.status.update_date The timestamp of the last time the entity was updated. domain_config.cognito_options.status.update_version The latest version of the entity. domain_config.domain_endpoint_options Additional options for the domain endpoint, such as whether to require HTTPS for all traffic. Show child fields domain_config.domain_endpoint_options.options Options to configure the endpoint for a domain. Show child fields domain_config.domain_endpoint_options.options.custom_endpoint The fully qualified URL for the custom endpoint. domain_config.domain_endpoint_options.options.custom_endpoint_certificate_arn The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM). domain_config.domain_endpoint_options.options.custom_endpoint_enabled Whether to enable a custom endpoint for the domain. domain_config.domain_endpoint_options.options.enforce_https True to require that all traffic to the domain arrive over HTTPS. domain_config.domain_endpoint_options.options.tls_security_policy Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values: Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2 Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2 Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites domain_config.domain_endpoint_options.status The status of the endpoint options for a domain. Show child fields domain_config.domain_endpoint_options.status.creation_date The timestamp when the entity was created. domain_config.domain_endpoint_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.domain_endpoint_options.status.state The state of the entity. domain_config.domain_endpoint_options.status.update_date The timestamp of the last time the entity was updated. domain_config.domain_endpoint_options.status.update_version The latest version of the entity. domain_config.ebs_options Container for EBS options configured for the domain. Show child fields domain_config.ebs_options.options The configured EBS options for the specified domain. Show child fields domain_config.ebs_options.options.ebs_enabled Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain. domain_config.ebs_options.options.iops Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types. domain_config.ebs_options.options.throughput Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type. domain_config.ebs_options.options.volume_size Specifies the size (in GiB) of EBS volumes attached to data nodes. domain_config.ebs_options.options.volume_type Specifies the type of EBS volumes attached to data nodes. domain_config.ebs_options.status The status of the EBS options for the specified domain. Show child fields domain_config.ebs_options.status.creation_date The timestamp when the entity was created. domain_config.ebs_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.ebs_options.status.state The state of the entity. domain_config.ebs_options.status.update_date The timestamp of the last time the entity was updated. domain_config.ebs_options.status.update_version The latest version of the entity. domain_config.encryption_at_rest_options Key-value pairs to enable encryption at rest. Show child fields domain_config.encryption_at_rest_options.options Encryption at rest options for the specified domain. Show child fields domain_config.encryption_at_rest_options.options.enabled True to enable encryption at rest. domain_config.encryption_at_rest_options.options.kms_key_id The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a. domain_config.encryption_at_rest_options.status The status of the encryption at rest options for the specified domain. Show child fields domain_config.encryption_at_rest_options.status.creation_date The timestamp when the entity was created. domain_config.encryption_at_rest_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.encryption_at_rest_options.status.state The state of the entity. domain_config.encryption_at_rest_options.status.update_date The timestamp of the last time the entity was updated. domain_config.encryption_at_rest_options.status.update_version The latest version of the entity. domain_config.engine_version The OpenSearch or Elasticsearch version that the domain is running. Show child fields domain_config.engine_version.options The OpenSearch or Elasticsearch version for the specified domain. domain_config.engine_version.status The status of the version options for the specified domain. Show child fields domain_config.engine_version.status.creation_date The timestamp when the entity was created. domain_config.engine_version.status.pending_deletion Indicates whether the entity is being deleted. domain_config.engine_version.status.state The state of the entity. domain_config.engine_version.status.update_date The timestamp of the last time the entity was updated. domain_config.engine_version.status.update_version The latest version of the entity. domain_config.ip_address_type 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. Show child fields domain_config.ip_address_type.options The IP address options for the domain. domain_config.ip_address_type.status Provides the current status of an entity. Show child fields domain_config.ip_address_type.status.creation_date The timestamp when the entity was created. domain_config.ip_address_type.status.pending_deletion Indicates whether the entity is being deleted. domain_config.ip_address_type.status.state The state of the entity. domain_config.ip_address_type.status.update_date The timestamp of the last time the entity was updated. domain_config.ip_address_type.status.update_version The latest version of the entity. domain_config.log_publishing_options Key-value pairs to configure log publishing. Show child fields domain_config.log_publishing_options.options The log publishing options configured for the domain. domain_config.log_publishing_options.status The status of the log publishing options for the domain. Show child fields domain_config.log_publishing_options.status.creation_date The timestamp when the entity was created. domain_config.log_publishing_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.log_publishing_options.status.state The state of the entity. domain_config.log_publishing_options.status.update_date The timestamp of the last time the entity was updated. domain_config.log_publishing_options.status.update_version The latest version of the entity. domain_config.modifying_properties[] Show child fields domain_config.modifying_properties[].active_value The current value of the domain property that is being modified. domain_config.modifying_properties[].name The name of the property that is currently being modified. domain_config.modifying_properties[].pending_value The value that the property that is currently being modified will eventually have. domain_config.modifying_properties[].value_type The type of value that is currently being modified. Properties can have two types: PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search". STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}". domain_config.node_to_node_encryption_options Whether node-to-node encryption is enabled or disabled. Show child fields domain_config.node_to_node_encryption_options.options The node-to-node encryption options for the specified domain. Show child fields domain_config.node_to_node_encryption_options.options.enabled True to enable node-to-node encryption. domain_config.node_to_node_encryption_options.status The status of the node-to-node encryption options for the specified domain. Show child fields domain_config.node_to_node_encryption_options.status.creation_date The timestamp when the entity was created. domain_config.node_to_node_encryption_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.node_to_node_encryption_options.status.state The state of the entity. domain_config.node_to_node_encryption_options.status.update_date The timestamp of the last time the entity was updated. domain_config.node_to_node_encryption_options.status.update_version The latest version of the entity. domain_config.off_peak_window_options Container for off-peak window options for the domain. Show child fields domain_config.off_peak_window_options.options The domain's off-peak window configuration. Show child fields domain_config.off_peak_window_options.options.enabled Whether to enable an off-peak window. This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain. domain_config.off_peak_window_options.options.off_peak_window Off-peak window settings for the domain. Show child fields domain_config.off_peak_window_options.options.off_peak_window.window_start_time A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M. Show child fields domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC. domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes The start minute of the window, in UTC. domain_config.off_peak_window_options.status The current status of off-peak window options. Show child fields domain_config.off_peak_window_options.status.creation_date The timestamp when the entity was created. domain_config.off_peak_window_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.off_peak_window_options.status.state The state of the entity. domain_config.off_peak_window_options.status.update_date The timestamp of the last time the entity was updated. domain_config.off_peak_window_options.status.update_version The latest version of the entity. domain_config.snapshot_options DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes. Show child fields domain_config.snapshot_options.options The daily snapshot options specified for the domain. Show child fields domain_config.snapshot_options.options.automated_snapshot_start_hour The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours. domain_config.snapshot_options.status The status of a daily automated snapshot. Show child fields domain_config.snapshot_options.status.creation_date The timestamp when the entity was created. domain_config.snapshot_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.snapshot_options.status.state The state of the entity. domain_config.snapshot_options.status.update_date The timestamp of the last time the entity was updated. domain_config.snapshot_options.status.update_version The latest version of the entity. domain_config.software_update_options Software update options for the domain. Show child fields domain_config.software_update_options.options The service software update options for a domain. Show child fields domain_config.software_update_options.options.auto_software_update_enabled Whether automatic service software updates are enabled for the domain. domain_config.software_update_options.status The status of service software update options, including creation date and last updated date. Show child fields domain_config.software_update_options.status.creation_date The timestamp when the entity was created. domain_config.software_update_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.software_update_options.status.state The state of the entity. domain_config.software_update_options.status.update_date The timestamp of the last time the entity was updated. domain_config.software_update_options.status.update_version The latest version of the entity. domain_config.vpc_options The current VPC options for the domain and the status of any updates to their configuration. Show child fields domain_config.vpc_options.options The VPC options for the specified domain. Show child fields domain_config.vpc_options.options.availability_zones[] domain_config.vpc_options.options.security_group_ids[] domain_config.vpc_options.options.subnet_ids[] domain_config.vpc_options.options.vpc_id The ID for your VPC. Amazon VPC generates this value when you create a VPC. domain_config.vpc_options.status The status of the VPC options for the specified domain. Show child fields domain_config.vpc_options.status.creation_date The timestamp when the entity was created. domain_config.vpc_options.status.pending_deletion Indicates whether the entity is being deleted. domain_config.vpc_options.status.state The state of the entity. domain_config.vpc_options.status.update_date The timestamp of the last time the entity was updated. domain_config.vpc_options.status.update_version The latest version of the entity.

Note

Tables may require input columns to have values specified before the table can return it’s rows. The values for input parameters are set in the where clause of the query typically using = or IN.