Skip to content

ElasticSearch Domain Data Model Documentation

Table of Contents

Top

protos/clouddb/wire/aws/elasticsearch/domain.proto

AwsElasticsearchDomainStatus

The domain configuration of an AWS Elasticsearch

Object: ElasticsearchDomainStatus Fields from https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-elasticsearchdomainstatus

Field Type Label Description
domain_id string Unique identifier for the domain Field: DomainID
name string Name of the elasticsearch domain Field: DomainName
arn string Field: ARN
created bool True if the domain has been created Field: Created
deleted bool True if the domain has been deleted Field: Deleted
endpoint string public domain endpoint Field: Endpoint
vpc_endpoints EsEndpoints set if the Elasticsearch domain uses VPC endpoints with key 'vpc' Field: Endpoints
processing bool Status of a change in the configuration of an Amazon ES domain Field: Processing
version string version of the elasticsearch software Field: ElasticsearchVersion
elasticsearch_cluster_config EsClusterConfig configuration of the cluster Field: ElasticsearchClusterConfig
ebs_options EsEbsOptions configuration of the attached EBS volumes Field: EBSOptions
access_policies string the IAM access policy Field: AccessPolicies
snapshot_options EsSnapshotOptions options for the automated snapshots (Note: is marked as deprecated in API doc) Field: SnapshotOptions
vpc_options EsVpcOptions options if deployed into a VPC Field: VPCOptions
log_publishing_options EsLogPublishingOptions options for publishing cloudwatch logs Field: LogPublishingOptions
advanced_options EsAdvancedOptions Field: AdvancedOptions
encryption_at_rest_options EsEncryptionAtRestOptions Field: EncryptionAtRestOptions
cognito_options EsCognitoOptions configuration of AWS Cognito for Kibana Field: CognitoOptions
node_to_node_encryption_options EsNodeToNodeEncryptionOptions Field: NodeToNodeEncryptionOptions
upgrade_processing bool True if a version upgrade is processing on the domain Field: UpgradeProcessing
service_software_options EsServiceSoftwareOptions Field: ServiceSoftwareOptions
domain_endpoint_options EsDomainEndpointOptions Field: DomainEndpointOptions
advanced_security_options EsAdvancedSecurityOptions Field: AdvancedSecurityOptions

EsAdvancedOptions

Object: AdvancedOptions From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-advancedoptions

Field Type Label Description
options EsAdvancedOptions.OptionsEntry repeated key/value pairs of Elasticsearch options

EsAdvancedOptions.OptionsEntry

Field Type Label Description
key string
value string

EsAdvancedSecurityOptions

Object: AdvancedSecurityOptions https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-advancedsec

Field Type Label Description
enabled bool Field: Enabled
internal_user_database_enabled bool Field: InternalUserDatabaseEnabled

EsClusterConfig

Object: ElasticsearchClusterConfig From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-elasticsearchclusterconfig

Field Type Label Description
instance_type string the instance type of the data nodes Field: InstanceType
instance_count int64 the number of instances Field: InstanceCount
dedicated_master_enabled bool true if there are dedicated master nodes Field: DedicatedMasterEnabled
dedicated_master_type string Field: DedicatedMasterType
dedicated_master_count int64 Field: DedicatedMasterCount
zone_awareness_enabled bool true if multiple availability zones are enabled Field: ZoneAwarenessEnabled
zone_awareness_config EsZoneAwarenessConfig Field: ZoneAwarenessConfig
warm_enabled bool true if warm storage is enabled Field: WarmEnabled
warm_count int64 number of warm nodes Field: WarmCount
warm_type string instance type of warm nodes Field: WarmType
warm_storage int64 total amount of warm storage in GB Field: WarmStorage

EsCognitoOptions

Object: CognitoOptions From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-cognitooptions

Field Type Label Description
enabled bool true if cognito is enabled Field: Enabled
user_pool_id string the user pool to use for kibana authentication Field: UserPoolId
identity_pool_id string the identity pool to use for kibana authentication Field: IdentityPoolId
role_arn string the role that allows AWS Elasticsearch to configure kibana Field: RoleArn

EsDomainEndpointOptions

Object: DomainEndpointOptions https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-domainendpointoptions

Field Type Label Description
enforce_https bool Field: EnforceHTTPS
tls_security_policy string Field: TLSSecurityPolicy

EsEbsOptions

Object: EBSOptions From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-ebsoptions

Field Type Label Description
enabled bool true if EBS is enabled Field: EBSEnabled
volume_type string the type of volume Field: VolumeType
volume_size int32 the size of the volume Field: VolumeSize
iops int32 the io performance if the type is a provisioned iops EBS volume Field: Iops

EsEncryptionAtRestOptions

Object: EncryptionAtRestOptions From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-encryptionatrest

Field Type Label Description
enabled bool Field: enabled
kms_key_id string KMS key used for encryption Field: KmsKeyId

EsEndpoints

Object: EndpointsMap From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-endpointsmap

Field Type Label Description
endpoints EsEndpoints.EndpointsEntry repeated mapping of name to endpoint, "vpc" key should be available if provisioned to a VPC Field: endpoints

EsEndpoints.EndpointsEntry

Field Type Label Description
key string
value string

EsLogPublishingOptions

Object: LogPublishingOptions From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-logpublishingoptions

Field Type Label Description
index_slow_logs EsLogPublishingOptions.CloudwatchLogs logs for slow index operations Field: INDEX_SLOW_LOGS
search_slow_logs EsLogPublishingOptions.CloudwatchLogs logs for slow query operations Field: SEARCH_SLOW_LOGS
application_logs EsLogPublishingOptions.CloudwatchLogs logs for the elasticsearch application Field: ES_APPLICATION_LOGS

EsLogPublishingOptions.CloudwatchLogs

Field Type Label Description
enabled bool true if this log is enabled
log_group_arn string the ARN of the log group

EsNodeToNodeEncryptionOptions

Object: NodeToNodeEncryptionOptions From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-node-to-node

Field Type Label Description
enabled bool true if node to node encryption is enabled Field: Enabled

EsServiceSoftwareOptions

Object: ServiceSoftwareOptions From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-servicesoftware

Field Type Label Description
update_available bool true if a service update is available Field: UpdateAvailable
cancellable bool true if the update can be canceled Field: Cancellable
automated_update_date google.protobuf.Timestamp Time after which the update will be automatically applied Field: AutomatedUpdateDate
update_status string Field: UpdateStatus
description string Field: Description
current_version string the current version of elasticsearch Field: CurrentVersion
new_version string the latest version of elasticsearch Field: NewVersion
optional_deployment bool true if the update is optional Field: OptionalDeployment

EsSnapshotOptions

Object: SnapshotOptions From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-snapshotoptions

Field Type Label Description
automated_start_hour int64 the hour which the snapshots are taken Field: AutomatedSnapshotStartHour

EsVpcOptions

Object: VPCDerivedInfo From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-vpcderivedinfo

Field Type Label Description
vpc_id string identifier for the VPC Field: VPCId
subnet_ids string repeated subnets for the VPC Field: SubnetIds
availability_zones string repeated the vpc availability zones represented by the subnets Field: AvailabilityZones
security_group_ids string repeated security groups for the VPC endpoints Field: SecurityGroupIds

EsZoneAwarenessConfig

Object: ZoneAwarenessConfig From https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-configuration-api.html#es-configuration-api-datatypes-az

Field Type Label Description
availability_zone_count int64 number of the availability zones to use

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)