Skip to content
AWS for Query.Farm

aws.es.describe_elasticsearch_domain_config

Example SQL Queries

SELECT * FROM
aws.es.describe_elasticsearch_domain_config
WHERE
"domain_name" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The Elasticsearch domain that you want to get information about.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
domain_config

The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

STRUCT(
    "elasticsearch_version" STRUCT(
        "options" VARCHAR,
        "status" STRUCT(
            "creation_date" TIMESTAMP_S,
            "update_date" TIMESTAMP_S,
            "update_version" BIGINT,
            "state" VARCHAR,
            "pending_deletion" BOOLEAN
        )
    ),
    "elasticsearch_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
            )
        ),
        "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
        )
    ),
    "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
            ),
            "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
            )[]
        ),
        "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,
        "start_time" TIMESTAMP_S,
        "last_updated_time" TIMESTAMP_S,
        "initiated_by" VARCHAR
    ),
    "modifying_properties" STRUCT(
        "name" VARCHAR,
        "active_value" VARCHAR,
        "pending_value" VARCHAR,
        "value_type" VARCHAR
    )[]
)
Show child fields
domain_config.access_policies

IAM access policy as a JSON-formatted string.

Show child fields
domain_config.access_policies.options

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

domain_config.access_policies.status

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.

Show child fields
domain_config.access_policies.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.access_policies.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.access_policies.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.access_policies.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.access_policies.status.update_version

Specifies the latest version for the entity.

domain_config.advanced_options

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

Show child fields
domain_config.advanced_options.options

Specifies the status of advanced options for the specified Elasticsearch domain.

domain_config.advanced_options.status

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

Show child fields
domain_config.advanced_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.advanced_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.advanced_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.advanced_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.advanced_options.status.update_version

Specifies the latest version for the entity.

domain_config.advanced_security_options

Specifies AdvancedSecurityOptions for the domain.

Show child fields
domain_config.advanced_security_options.options

Specifies advanced security options for the specified Elasticsearch domain.

Show child fields
domain_config.advanced_security_options.options.anonymous_auth_disable_date

Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

domain_config.advanced_security_options.options.anonymous_auth_enabled

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

domain_config.advanced_security_options.options.enabled

True if advanced security 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.saml_options

Describes the SAML application configured for a domain.

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 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 advanced security options for the specified Elasticsearch domain.

Show child fields
domain_config.advanced_security_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.advanced_security_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.advanced_security_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.advanced_security_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.advanced_security_options.status.update_version

Specifies the latest version for the entity.

domain_config.auto_tune_options

Specifies AutoTuneOptions for the domain.

Show child fields
domain_config.auto_tune_options.options

Specifies Auto-Tune options for the specified Elasticsearch domain.

Show child fields
domain_config.auto_tune_options.options.desired_state

Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

domain_config.auto_tune_options.options.maintenance_schedules[]
Show child fields
domain_config.auto_tune_options.options.maintenance_schedules[].cron_expression_for_recurrence

Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

domain_config.auto_tune_options.options.maintenance_schedules[].duration

Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

Show child fields
domain_config.auto_tune_options.options.maintenance_schedules[].duration.unit

Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

domain_config.auto_tune_options.options.maintenance_schedules[].duration.value

Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

domain_config.auto_tune_options.options.maintenance_schedules[].start_at

Specifies timestamp at which Auto-Tune maintenance schedule start.

domain_config.auto_tune_options.options.rollback_on_disable

Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.

domain_config.auto_tune_options.status

Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.

Show child fields
domain_config.auto_tune_options.status.creation_date

Timestamp which tells Auto-Tune options creation date .

domain_config.auto_tune_options.status.error_message

Specifies the error message while enabling or disabling the Auto-Tune options.

domain_config.auto_tune_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.auto_tune_options.status.state

Specifies the AutoTuneState for the Elasticsearch domain.

domain_config.auto_tune_options.status.update_date

Timestamp which tells Auto-Tune options last updated time.

domain_config.auto_tune_options.status.update_version

Specifies the Auto-Tune options latest version.

domain_config.change_progress_details

Specifies change details of the domain configuration change.

Show child fields
domain_config.change_progress_details.change_id

The unique change identifier associated with a specific domain 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

Contains an optional message associated with the domain configuration change.

domain_config.change_progress_details.start_time

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

domain_config.cognito_options

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

Show child fields
domain_config.cognito_options.options

Specifies the Cognito options for the specified Elasticsearch domain.

Show child fields
domain_config.cognito_options.options.enabled

Specifies the option to enable Cognito for Kibana authentication.

domain_config.cognito_options.options.identity_pool_id

Specifies the Cognito identity pool ID for Kibana authentication.

domain_config.cognito_options.options.role_arn

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

domain_config.cognito_options.options.user_pool_id

Specifies the Cognito user pool ID for Kibana authentication.

domain_config.cognito_options.status

Specifies the status of the Cognito options for the specified Elasticsearch domain.

Show child fields
domain_config.cognito_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.cognito_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.cognito_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.cognito_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.cognito_options.status.update_version

Specifies the latest version for the entity.

domain_config.domain_endpoint_options

Specifies the DomainEndpointOptions for the Elasticsearch domain.

Show child fields
domain_config.domain_endpoint_options.options

Options to configure endpoint for the Elasticsearch domain.

Show child fields
domain_config.domain_endpoint_options.options.custom_endpoint

Specify the fully qualified domain for your custom endpoint.

domain_config.domain_endpoint_options.options.custom_endpoint_certificate_arn

Specify ACM certificate ARN for your custom endpoint.

domain_config.domain_endpoint_options.options.custom_endpoint_enabled

Specify if custom endpoint should be enabled for the Elasticsearch domain.

domain_config.domain_endpoint_options.options.enforce_https

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

domain_config.domain_endpoint_options.options.tls_security_policy

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It 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 the Elasticsearch domain. See OptionStatus for the status information that's included.

Show child fields
domain_config.domain_endpoint_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.domain_endpoint_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.domain_endpoint_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.domain_endpoint_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.domain_endpoint_options.status.update_version

Specifies the latest version for the entity.

domain_config.ebs_options

Specifies the EBSOptions for the Elasticsearch domain.

Show child fields
domain_config.ebs_options.options

Specifies the EBS options for the specified Elasticsearch domain.

Show child fields
domain_config.ebs_options.options.ebs_enabled

Specifies whether EBS-based storage is enabled.

domain_config.ebs_options.options.iops

Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

domain_config.ebs_options.options.throughput

Specifies the Throughput for GP3 EBS volume (SSD).

domain_config.ebs_options.options.volume_size

Integer to specify the size of an EBS volume.

domain_config.ebs_options.options.volume_type

Specifies the volume type for EBS-based storage.

domain_config.ebs_options.status

Specifies the status of the EBS options for the specified Elasticsearch domain.

Show child fields
domain_config.ebs_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.ebs_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.ebs_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.ebs_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.ebs_options.status.update_version

Specifies the latest version for the entity.

domain_config.elasticsearch_cluster_config

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

Show child fields
domain_config.elasticsearch_cluster_config.options

Specifies the cluster configuration for the specified Elasticsearch domain.

Show child fields
domain_config.elasticsearch_cluster_config.options.cold_storage_options

Specifies the ColdStorageOptions config for Elasticsearch Domain

Show child fields
domain_config.elasticsearch_cluster_config.options.cold_storage_options.enabled

Enable cold storage option. Accepted values true or false

domain_config.elasticsearch_cluster_config.options.dedicated_master_count

Total number of dedicated master nodes, active and on standby, for the cluster.

domain_config.elasticsearch_cluster_config.options.dedicated_master_enabled

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

domain_config.elasticsearch_cluster_config.options.dedicated_master_type

The instance type for a dedicated master node.

domain_config.elasticsearch_cluster_config.options.instance_count

The number of instances in the specified domain cluster.

domain_config.elasticsearch_cluster_config.options.instance_type

The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.

domain_config.elasticsearch_cluster_config.options.warm_count

The number of warm nodes in the cluster.

domain_config.elasticsearch_cluster_config.options.warm_enabled

True to enable warm storage.

domain_config.elasticsearch_cluster_config.options.warm_type

The instance type for the Elasticsearch cluster's warm nodes.

domain_config.elasticsearch_cluster_config.options.zone_awareness_config

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

Show child fields
domain_config.elasticsearch_cluster_config.options.zone_awareness_config.availability_zone_count

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled

domain_config.elasticsearch_cluster_config.options.zone_awareness_enabled

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

domain_config.elasticsearch_cluster_config.status

Specifies the status of the configuration for the specified Elasticsearch domain.

Show child fields
domain_config.elasticsearch_cluster_config.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.elasticsearch_cluster_config.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.elasticsearch_cluster_config.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.elasticsearch_cluster_config.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.elasticsearch_cluster_config.status.update_version

Specifies the latest version for the entity.

domain_config.elasticsearch_version

String of format X.Y to specify version for the Elasticsearch domain.

Show child fields
domain_config.elasticsearch_version.options

Specifies the Elasticsearch version for the specified Elasticsearch domain.

domain_config.elasticsearch_version.status

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

Show child fields
domain_config.elasticsearch_version.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.elasticsearch_version.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.elasticsearch_version.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.elasticsearch_version.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.elasticsearch_version.status.update_version

Specifies the latest version for the entity.

domain_config.encryption_at_rest_options

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

Show child fields
domain_config.encryption_at_rest_options.options

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

Show child fields
domain_config.encryption_at_rest_options.options.enabled

Specifies the option to enable Encryption At Rest.

domain_config.encryption_at_rest_options.options.kms_key_id

Specifies the KMS Key ID for Encryption At Rest options.

domain_config.encryption_at_rest_options.status

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

Show child fields
domain_config.encryption_at_rest_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.encryption_at_rest_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.encryption_at_rest_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.encryption_at_rest_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.encryption_at_rest_options.status.update_version

Specifies the latest version for the entity.

domain_config.log_publishing_options

Log publishing options for the given domain.

Show child fields
domain_config.log_publishing_options.options

The log publishing options configured for the Elasticsearch domain.

domain_config.log_publishing_options.status

The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included.

Show child fields
domain_config.log_publishing_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.log_publishing_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.log_publishing_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.log_publishing_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.log_publishing_options.status.update_version

Specifies the latest version for 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

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

Show child fields
domain_config.node_to_node_encryption_options.options

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

Show child fields
domain_config.node_to_node_encryption_options.options.enabled

Specify true to enable node-to-node encryption.

domain_config.node_to_node_encryption_options.status

Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.

Show child fields
domain_config.node_to_node_encryption_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.node_to_node_encryption_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.node_to_node_encryption_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.node_to_node_encryption_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.node_to_node_encryption_options.status.update_version

Specifies the latest version for the entity.

domain_config.snapshot_options

Specifies the SnapshotOptions for the Elasticsearch domain.

Show child fields
domain_config.snapshot_options.options

Specifies the daily snapshot options specified for the Elasticsearch domain.

Show child fields
domain_config.snapshot_options.options.automated_snapshot_start_hour

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

domain_config.snapshot_options.status

Specifies the status of a daily automated snapshot.

Show child fields
domain_config.snapshot_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.snapshot_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.snapshot_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.snapshot_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.snapshot_options.status.update_version

Specifies the latest version for the entity.

domain_config.vpc_options

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

Show child fields
domain_config.vpc_options.options

Specifies the VPC options for the specified Elasticsearch 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 VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

domain_config.vpc_options.status

Specifies the status of the VPC options for the specified Elasticsearch domain.

Show child fields
domain_config.vpc_options.status.creation_date

Timestamp which tells the creation date for the entity.

domain_config.vpc_options.status.pending_deletion

Indicates whether the Elasticsearch domain is being deleted.

domain_config.vpc_options.status.state

Provides the OptionState for the Elasticsearch domain.

domain_config.vpc_options.status.update_date

Timestamp which tells the last updated time for the entity.

domain_config.vpc_options.status.update_version

Specifies the latest version for the entity.