String 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.
OptionStatus status
The status of the access policy for the Elasticsearch domain. See OptionStatus
for the status
information that's included.
String limitName
Name of Additional Limit is specific to a given InstanceType and for each of it's
InstanceRole
etc.
Attributes and their details:
ESPartitionInstanceType
can support as master node.
ESPartitionInstanceType
upto which you don't need any master
nodes to govern them.
List<E> limitValues
Value for given AdditionalLimit$LimitName
.
Map<K,V> options
Specifies the status of advanced options for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of OptionStatus
for advanced options for the specified Elasticsearch domain.
String domainName
The name of the domain that you want to stop the latest service software update on.
ServiceSoftwareOptions serviceSoftwareOptions
The current status of the Elasticsearch service software update.
Boolean enabled
Specifies the option to enable Cognito for Kibana authentication.
String userPoolId
Specifies the Cognito user pool ID for Kibana authentication.
String identityPoolId
Specifies the Cognito identity pool ID for Kibana authentication.
String roleArn
Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
CognitoOptions options
Specifies the Cognito options for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the Cognito options for the specified Elasticsearch domain.
String domainName
The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
String elasticsearchVersion
String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
ElasticsearchClusterConfig elasticsearchClusterConfig
Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.
EBSOptions eBSOptions
Options to enable, disable and specify the type and size of EBS storage volumes.
String accessPolicies
IAM access policy as a JSON-formatted string.
SnapshotOptions snapshotOptions
Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
VPCOptions vPCOptions
Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
CognitoOptions cognitoOptions
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
EncryptionAtRestOptions encryptionAtRestOptions
Specifies the Encryption At Rest Options.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Specifies the NodeToNodeEncryptionOptions.
Map<K,V> advancedOptions
Option to allow references to indices in an HTTP request body. Must be false
when configuring access
to individual sub-resources. By default, the value is true
. See Configuration Advanced Options for more information.
Map<K,V> logPublishingOptions
Map of LogType
and LogPublishingOption
, each containing options to publish a given type
of Elasticsearch log.
ElasticsearchDomainStatus domainStatus
The status of the newly created Elasticsearch domain.
String domainName
The name of the Elasticsearch domain that you want to permanently delete.
ElasticsearchDomainStatus domainStatus
The status of the Elasticsearch domain being deleted.
String domainName
The Elasticsearch domain that you want to get information about.
ElasticsearchDomainConfig domainConfig
The configuration information of the domain requested in the DescribeElasticsearchDomainConfig
request.
String domainName
The name of the Elasticsearch domain for which you want information.
ElasticsearchDomainStatus domainStatus
The current status of the Elasticsearch domain.
String domainName
DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are
querying for Elasticsearch Limits
for existing domain.
String instanceType
The instance type for an Elasticsearch cluster for which Elasticsearch Limits
are needed.
String elasticsearchVersion
Version of Elasticsearch for which Limits
are needed.
String reservedElasticsearchInstanceOfferingId
The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
Integer maxResults
Set this value to limit the number of results returned. If not specified, defaults to 100.
String nextToken
NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
String reservedElasticsearchInstanceId
The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.
Integer maxResults
Set this value to limit the number of results returned. If not specified, defaults to 100.
String nextToken
NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
String domainName
Specifies the DomainName
.
Boolean eBSEnabled
Specifies whether EBS-based storage is enabled.
String volumeType
Specifies the volume type for EBS-based storage.
Integer volumeSize
Integer to specify the size of an EBS volume.
Integer iops
Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
EBSOptions options
Specifies the EBS options for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the EBS options for the specified Elasticsearch domain.
String instanceType
The instance type for an Elasticsearch cluster.
Integer instanceCount
The number of instances in the specified domain cluster.
Boolean dedicatedMasterEnabled
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
Boolean zoneAwarenessEnabled
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
ZoneAwarenessConfig zoneAwarenessConfig
Specifies the zone awareness configuration for a domain when zone awareness is enabled.
String dedicatedMasterType
The instance type for a dedicated master node.
Integer dedicatedMasterCount
Total number of dedicated master nodes, active and on standby, for the cluster.
ElasticsearchClusterConfig options
Specifies the cluster configuration for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the configuration for the specified Elasticsearch domain.
ElasticsearchVersionStatus elasticsearchVersion
String of format X.Y to specify version for the Elasticsearch domain.
ElasticsearchClusterConfigStatus elasticsearchClusterConfig
Specifies the ElasticsearchClusterConfig
for the Elasticsearch domain.
EBSOptionsStatus eBSOptions
Specifies the EBSOptions
for the Elasticsearch domain.
AccessPoliciesStatus accessPolicies
IAM access policy as a JSON-formatted string.
SnapshotOptionsStatus snapshotOptions
Specifies the SnapshotOptions
for the Elasticsearch domain.
VPCDerivedInfoStatus vPCOptions
The VPCOptions
for the specified domain. For more information, see VPC
Endpoints for Amazon Elasticsearch Service Domains.
CognitoOptionsStatus cognitoOptions
The CognitoOptions
for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
EncryptionAtRestOptionsStatus encryptionAtRestOptions
Specifies the EncryptionAtRestOptions
for the Elasticsearch domain.
NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions
Specifies the NodeToNodeEncryptionOptions
for the Elasticsearch domain.
AdvancedOptionsStatus advancedOptions
Specifies the AdvancedOptions
for the domain. See Configuring Advanced Options for more information.
LogPublishingOptionsStatus logPublishingOptions
Log publishing options for the given domain.
String domainId
The unique identifier for the specified Elasticsearch domain.
String domainName
The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
String aRN
The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
Boolean created
The domain creation status. True
if the creation of an Elasticsearch domain is complete.
False
if domain creation is still in progress.
Boolean deleted
The domain deletion status. True
if a delete request has been received for the domain but resource
cleanup is still in progress. False
if the domain has not been deleted. Once domain deletion is
complete, the status of the domain is no longer returned.
String endpoint
The Elasticsearch domain endpoint that you use to submit index and search requests.
Map<K,V> endpoints
Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example
key, value
:
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
.
Boolean processing
The status of the Elasticsearch domain configuration. True
if Amazon Elasticsearch Service is
processing configuration changes. False
if the configuration is active.
Boolean upgradeProcessing
The status of an Elasticsearch domain version upgrade. True
if Amazon Elasticsearch Service is
undergoing a version upgrade. False
if the configuration is active.
String elasticsearchVersion
ElasticsearchClusterConfig elasticsearchClusterConfig
The type and number of instances in the domain cluster.
EBSOptions eBSOptions
The EBSOptions
for the specified domain. See Configuring EBS-based Storage for more information.
String accessPolicies
IAM access policy as a JSON-formatted string.
SnapshotOptions snapshotOptions
Specifies the status of the SnapshotOptions
VPCDerivedInfo vPCOptions
The VPCOptions
for the specified domain. For more information, see VPC
Endpoints for Amazon Elasticsearch Service Domains.
CognitoOptions cognitoOptions
The CognitoOptions
for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
EncryptionAtRestOptions encryptionAtRestOptions
Specifies the status of the EncryptionAtRestOptions
.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Specifies the status of the NodeToNodeEncryptionOptions
.
Map<K,V> advancedOptions
Specifies the status of the AdvancedOptions
Map<K,V> logPublishingOptions
Log publishing options for the given domain.
ServiceSoftwareOptions serviceSoftwareOptions
The current status of the Elasticsearch domain's service software.
String options
Specifies the Elasticsearch version for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
EncryptionAtRestOptions options
Specifies the Encryption At Rest options for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.
String domainName
List<E> compatibleElasticsearchVersions
A map of compatible Elasticsearch versions returned as part of the
GetCompatibleElasticsearchVersions
operation.
List<E> upgradeHistories
A list of UpgradeHistory
objects corresponding to each Upgrade or Upgrade Eligibility Check
performed on a domain returned as part of GetUpgradeHistoryResponse
object.
String nextToken
Pagination token that needs to be supplied to the next call to get the next page of results
String domainName
String upgradeStep
Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
String stepStatus
One of 4 statuses that a step can go through returned as part of the
GetUpgradeStatusResponse
object. The status can take one of the following values:
String upgradeName
A string that describes the update briefly
InstanceCountLimits instanceCountLimits
List<E> storageTypes
StorageType represents the list of storage related types and attributes that are available for given InstanceType.
InstanceLimits instanceLimits
List<E> additionalLimits
List of additional limits that are specific to a given InstanceType and for each of it's
InstanceRole
.
String elasticsearchVersion
Version of Elasticsearch for which list of supported elasticsearch instance types are needed.
String domainName
DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.
Integer maxResults
Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.
String nextToken
NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
List<E> elasticsearchInstanceTypes
List of instance types supported by Amazon Elasticsearch service for given
ElasticsearchVersion
String nextToken
In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.
String aRN
Specify the ARN
for the Elasticsearch domain to which the tags are attached that you want to view.
Map<K,V> options
The log publishing options configured for the Elasticsearch domain.
OptionStatus status
The status of the log publishing options for the Elasticsearch domain. See OptionStatus
for the
status information that's included.
Boolean enabled
Specify true to enable node-to-node encryption.
NodeToNodeEncryptionOptions options
Specifies the node-to-node encryption options for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.
Date creationDate
Timestamp which tells the creation date for the entity.
Date updateDate
Timestamp which tells the last updated time for the entity.
Integer updateVersion
Specifies the latest version for the entity.
String state
Provides the OptionState
for the Elasticsearch domain.
Boolean pendingDeletion
Indicates whether the Elasticsearch domain is being deleted.
String reservedElasticsearchInstanceOfferingId
The ID of the reserved Elasticsearch instance offering to purchase.
String reservationName
A customer-specified identifier to track this reservation.
Integer instanceCount
The number of Elasticsearch instances to reserve.
String reservationName
The customer-specified identifier to track this reservation.
String reservedElasticsearchInstanceId
The unique identifier for the reservation.
String reservedElasticsearchInstanceOfferingId
The offering identifier.
String elasticsearchInstanceType
The Elasticsearch instance type offered by the reserved instance offering.
Date startTime
The time the reservation started.
Integer duration
The duration, in seconds, for which the Elasticsearch instance is reserved.
Double fixedPrice
The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
Double usagePrice
The rate you are charged for each hour for the domain that is using this reserved instance.
String currencyCode
The currency code for the reserved Elasticsearch instance offering.
Integer elasticsearchInstanceCount
The number of Elasticsearch instances that have been reserved.
String state
The state of the reserved Elasticsearch instance.
String paymentOption
The payment option as defined in the reserved Elasticsearch instance offering.
List<E> recurringCharges
The charge to your account regardless of whether you are creating any domains using the instance offering.
String reservedElasticsearchInstanceOfferingId
The Elasticsearch reserved instance offering identifier.
String elasticsearchInstanceType
The Elasticsearch instance type offered by the reserved instance offering.
Integer duration
The duration, in seconds, for which the offering will reserve the Elasticsearch instance.
Double fixedPrice
The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.
Double usagePrice
The rate you are charged for each hour the domain that is using the offering is running.
String currencyCode
The currency code for the reserved Elasticsearch instance offering.
String paymentOption
Payment option for the reserved Elasticsearch instance offering
List<E> recurringCharges
The charge to your account regardless of whether you are creating any domains using the instance offering.
String currentVersion
The current service software version that is present on the domain.
String newVersion
The new service software version if one is available.
Boolean updateAvailable
True
if you are able to update you service software version. False
if you are not able
to update your service software version.
Boolean cancellable
True
if you are able to cancel your service software version update. False
if you are
not able to cancel your service software version.
String updateStatus
The status of your service software update. This field can take the following values: ELIGIBLE
,
PENDING_UPDATE
, IN_PROGRESS
, COMPLETED
, and NOT_ELIGIBLE
.
String description
The description of the UpdateStatus
.
Date automatedUpdateDate
Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
Integer automatedSnapshotStartHour
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified
Elasticsearch domain. Default value is 0
hours.
SnapshotOptions options
Specifies the daily snapshot options specified for the Elasticsearch domain.
OptionStatus status
Specifies the status of a daily automated snapshot.
String domainName
The name of the domain that you want to update to the latest service software.
ServiceSoftwareOptions serviceSoftwareOptions
The current status of the Elasticsearch service software update.
String limitName
Name of storage limits that are applicable for given storage type. If StorageType
is ebs,
following storage options are applicable
List<E> limitValues
Values for the StorageTypeLimit$LimitName
.
String key
Specifies the TagKey
, the name of the tag. Tag keys must be unique for the Elasticsearch domain to
which they are attached.
String value
Specifies the TagValue
, the value assigned to the corresponding tag key. Tag values can be null and
do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of
project : Trinity
and cost-center : Trinity
String domainName
The name of the Elasticsearch domain that you are updating.
ElasticsearchClusterConfig elasticsearchClusterConfig
The type and number of instances to instantiate for the domain cluster.
EBSOptions eBSOptions
Specify the type and size of the EBS volume that you want to use.
SnapshotOptions snapshotOptions
Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0
hours.
VPCOptions vPCOptions
Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
CognitoOptions cognitoOptions
Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
Map<K,V> advancedOptions
Modifies the advanced option to allow references to indices in an HTTP request body. Must be false
when configuring access to individual sub-resources. By default, the value is true
. See Configuration Advanced Options for more information.
String accessPolicies
IAM access policy as a JSON-formatted string.
Map<K,V> logPublishingOptions
Map of LogType
and LogPublishingOption
, each containing options to publish a given type
of Elasticsearch log.
ElasticsearchDomainConfig domainConfig
The status of the updated Elasticsearch domain.
String domainName
String targetVersion
The version of Elasticsearch that you intend to upgrade the domain to.
Boolean performCheckOnly
This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
String domainName
String targetVersion
The version of Elasticsearch that you intend to upgrade the domain to.
Boolean performCheckOnly
This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
String upgradeName
A string that describes the update briefly
Date startTimestamp
UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
String upgradeStatus
The overall status of the update. The status can take one of the following values:
List<E> stepsList
A list of UpgradeStepItem
s representing information about each step performed as pard of a
specific Upgrade or Upgrade Eligibility Check.
String upgradeStep
Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
String upgradeStepStatus
The status of a particular step during an upgrade. The status can take one of the following values:
List<E> issues
A list of strings containing detailed information about the errors encountered in a particular step.
Double progressPercent
The Floating point value representing progress percentage of a particular step.
String vPCId
The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
List<E> subnetIds
Specifies the subnets for VPC endpoint.
List<E> availabilityZones
The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
List<E> securityGroupIds
Specifies the security groups for VPC endpoint.
VPCDerivedInfo options
Specifies the VPC options for the specified Elasticsearch domain.
OptionStatus status
Specifies the status of the VPC options for the specified Elasticsearch domain.
Integer availabilityZoneCount
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
Copyright © 2019. All rights reserved.