String crossClusterSearchConnectionId
The id of the inbound connection that you want to accept.
InboundCrossClusterSearchConnection crossClusterSearchConnection
Specifies the InboundCrossClusterSearchConnection
of accepted inbound connection.
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.
Boolean enabled
True if advanced security is enabled.
Boolean internalUserDatabaseEnabled
True if the internal user database is enabled.
SAMLOptionsOutput sAMLOptions
Describes the SAML application configured for a domain.
Date anonymousAuthDisableDate
Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
Boolean anonymousAuthEnabled
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
Boolean enabled
True if advanced security is enabled.
Boolean internalUserDatabaseEnabled
True if the internal user database is enabled.
MasterUserOptions masterUserOptions
Credentials for the master user: username and password, ARN, or both.
SAMLOptionsInput sAMLOptions
Specifies the SAML application configuration for the domain.
Boolean anonymousAuthEnabled
True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
AdvancedSecurityOptions options
Specifies advanced security options for the specified Elasticsearch domain.
OptionStatus status
Status of the advanced security options for the specified Elasticsearch domain.
DomainPackageDetails domainPackageDetails
DomainPackageDetails
String autoTuneType
Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.
AutoTuneDetails autoTuneDetails
Specifies details of the Auto-Tune action. See the Developer Guide for more information.
ScheduledAutoTuneDetails scheduledAutoTuneDetails
Date startAt
Specifies timestamp at which Auto-Tune maintenance schedule start.
Duration duration
Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
String cronExpressionForRecurrence
Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.
String desiredState
Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
String rollbackOnDisable
Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
List<E> maintenanceSchedules
Specifies list of maitenance schedules. See the Developer Guide for more information.
String desiredState
Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
List<E> maintenanceSchedules
Specifies list of maitenance schedules. See the Developer Guide for more information.
AutoTuneOptions options
Specifies Auto-Tune options for the specified Elasticsearch domain.
AutoTuneStatus status
Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.
Date creationDate
Timestamp which tells Auto-Tune options creation date .
Date updateDate
Timestamp which tells Auto-Tune options last updated time.
Integer updateVersion
Specifies the Auto-Tune options latest version.
String state
Specifies the AutoTuneState
for the Elasticsearch domain.
String errorMessage
Specifies the error message while enabling or disabling the Auto-Tune options.
Boolean pendingDeletion
Indicates whether the Elasticsearch domain is being deleted.
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.
String changeId
The unique change identifier associated with a specific domain configuration change.
Date startTime
The time at which the configuration change is made on the domain.
String status
The overall status of the domain configuration change. This field can take the following values:
PENDING
, PROCESSING
, COMPLETED
and FAILED
List<E> pendingProperties
The list of properties involved in the domain configuration change that are still in pending.
List<E> completedProperties
The list of properties involved in the domain configuration change that are completed.
Integer totalNumberOfStages
The total number of stages required for the configuration change.
List<E> changeProgressStages
The specific stages that the domain is going through to perform the configuration change.
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.
Boolean enabled
Enable cold storage option. Accepted values true or false
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 lowercase letter 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.
DomainEndpointOptions domainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
AdvancedSecurityOptionsInput advancedSecurityOptions
Specifies advanced security options.
AutoTuneOptionsInput autoTuneOptions
Specifies Auto-Tune options.
List<E> tagList
A list of Tag
added during domain creation.
ElasticsearchDomainStatus domainStatus
The status of the newly created Elasticsearch domain.
DomainInformation sourceDomainInfo
Specifies the DomainInformation
for the source Elasticsearch domain.
DomainInformation destinationDomainInfo
Specifies the DomainInformation
for the destination Elasticsearch domain.
String connectionAlias
Specifies the connection alias that will be used by the customer for this connection.
DomainInformation sourceDomainInfo
Specifies the DomainInformation
for the source Elasticsearch domain.
DomainInformation destinationDomainInfo
Specifies the DomainInformation
for the destination Elasticsearch domain.
String connectionAlias
Specifies the connection alias provided during the create connection request.
OutboundCrossClusterSearchConnectionStatus connectionStatus
Specifies the OutboundCrossClusterSearchConnectionStatus
for the newly created connection.
String crossClusterSearchConnectionId
Unique id for the created outbound connection, which is used for subsequent operations on connection.
String packageName
Unique identifier for the package.
String packageType
Type of package. Currently supports only TXT-DICTIONARY.
String packageDescription
Description of the package.
PackageSource packageSource
The customer S3 location PackageSource
for importing the package.
PackageDetails packageDetails
Information about the package PackageDetails
.
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 crossClusterSearchConnectionId
The id of the inbound connection that you want to permanently delete.
InboundCrossClusterSearchConnection crossClusterSearchConnection
Specifies the InboundCrossClusterSearchConnection
of deleted inbound connection.
String crossClusterSearchConnectionId
The id of the outbound connection that you want to permanently delete.
OutboundCrossClusterSearchConnection crossClusterSearchConnection
Specifies the OutboundCrossClusterSearchConnection
of deleted outbound connection.
String packageID
Internal ID of the package that you want to delete. Use DescribePackages
to find this value.
PackageDetails packageDetails
PackageDetails
String domainName
Specifies the domain name for which you want Auto-Tune action details.
Integer maxResults
Set this value to limit the number of results returned. If not specified, defaults to 100.
String nextToken
NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.
List<E> autoTunes
Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.
String nextToken
Specifies an identifier to allow retrieval of paginated results.
String domainName
The domain you want to get the progress information about.
String changeId
The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.
ChangeProgressStatusDetails changeProgressStatus
Progress information for the configuration change that is requested in the
DescribeDomainChangeProgress
request.
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.
List<E> filters
A list of filters used to match properties for inbound cross-cluster search connection. Available
Filter
names for this operation are:
Integer maxResults
Set this value to limit the number of results returned. If not specified, defaults to 100.
String nextToken
NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.
List<E> crossClusterSearchConnections
Consists of list of InboundCrossClusterSearchConnection
matching the specified filter
criteria.
String nextToken
If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
List<E> filters
A list of filters used to match properties for outbound cross-cluster search connection. Available
Filter
names for this operation are:
Integer maxResults
Set this value to limit the number of results returned. If not specified, defaults to 100.
String nextToken
NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.
List<E> crossClusterSearchConnections
Consists of list of OutboundCrossClusterSearchConnection
matching the specified filter
criteria.
String nextToken
If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
List<E> filters
Only returns packages that match the DescribePackagesFilterList
values.
Integer maxResults
Limits results to a maximum number of packages.
String nextToken
Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
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.
DomainPackageDetails domainPackageDetails
DomainPackageDetails
Boolean enforceHTTPS
Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
String tLSSecurityPolicy
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:
Boolean customEndpointEnabled
Specify if custom endpoint should be enabled for the Elasticsearch domain.
String customEndpoint
Specify the fully qualified domain for your custom endpoint.
String customEndpointCertificateArn
Specify ACM certificate ARN for your custom endpoint.
DomainEndpointOptions options
Options to configure endpoint for the Elasticsearch domain.
OptionStatus status
The status of the endpoint options for the Elasticsearch domain. See OptionStatus
for the status
information that's included.
String packageID
Internal ID of the package.
String packageName
User specified name of the package.
String packageType
Currently supports only TXT-DICTIONARY.
Date lastUpdated
Timestamp of the most-recent update to the association status.
String domainName
Name of the domain you've associated a package with.
String domainPackageStatus
State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
String packageVersion
String referencePath
The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
ErrorDetails errorDetails
Additional information if the package is in an error state. Null otherwise.
String deploymentType
Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses
are Blue/Green
(The update will require a blue/green deployment.) DynamicUpdate
(The
update can be applied in-place without a Blue/Green deployment required.) Undetermined
(The domain
is undergoing an update which needs to complete before the deployment type can be predicted.) None
(The configuration change matches the current configuration and will not result in any update.)
String message
Contains an optional message associated with the DryRunResults.
Long value
Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.
String unit
Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.
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. UltraWarm instance types are not supported for data instances.
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.
Boolean warmEnabled
True to enable warm storage.
String warmType
The instance type for the Elasticsearch cluster's warm nodes.
Integer warmCount
The number of warm nodes in the cluster.
ColdStorageOptions coldStorageOptions
Specifies the ColdStorageOptions
config for Elasticsearch Domain
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.
DomainEndpointOptionsStatus domainEndpointOptions
Specifies the DomainEndpointOptions
for the Elasticsearch domain.
AdvancedSecurityOptionsStatus advancedSecurityOptions
Specifies AdvancedSecurityOptions
for the domain.
AutoTuneOptionsStatus autoTuneOptions
Specifies AutoTuneOptions
for the domain.
ChangeProgressDetails changeProgressDetails
Specifies change details of the domain configuration change.
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.
DomainEndpointOptions domainEndpointOptions
The current status of the Elasticsearch domain's endpoint options.
AdvancedSecurityOptions advancedSecurityOptions
The current status of the Elasticsearch domain's advanced security options.
AutoTuneOptionsOutput autoTuneOptions
The current status of the Elasticsearch domain's Auto-Tune options.
ChangeProgressDetails changeProgressDetails
Specifies change details of the domain configuration change.
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.
String packageID
Returns an audit history of versions of the package.
Integer maxResults
Limits results to a maximum number of versions.
String nextToken
Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
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
DomainInformation sourceDomainInfo
Specifies the DomainInformation
for the source Elasticsearch domain.
DomainInformation destinationDomainInfo
Specifies the DomainInformation
for the destination Elasticsearch domain.
String crossClusterSearchConnectionId
Specifies the connection id for the inbound cross-cluster search connection.
InboundCrossClusterSearchConnectionStatus connectionStatus
Specifies the InboundCrossClusterSearchConnectionStatus
for the outbound connection.
String statusCode
The state code for inbound connection. This can be one of the following:
String message
Specifies verbose information for the inbound connection status.
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 engineType
Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.
String packageID
The package for which to list domains.
Integer maxResults
Limits results to a maximum number of domains.
String nextToken
Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
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 domainName
The name of the domain for which you want to list associated packages.
Integer maxResults
Limits results to a maximum number of packages.
String nextToken
Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
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.
String masterUserARN
ARN for the master user (if IAM is enabled).
String masterUserName
The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.
String masterUserPassword
The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.
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.
DomainInformation sourceDomainInfo
Specifies the DomainInformation
for the source Elasticsearch domain.
DomainInformation destinationDomainInfo
Specifies the DomainInformation
for the destination Elasticsearch domain.
String crossClusterSearchConnectionId
Specifies the connection id for the outbound cross-cluster search connection.
String connectionAlias
Specifies the connection alias for the outbound cross-cluster search connection.
OutboundCrossClusterSearchConnectionStatus connectionStatus
Specifies the OutboundCrossClusterSearchConnectionStatus
for the outbound connection.
String statusCode
The state code for outbound connection. This can be one of the following:
String message
Specifies verbose information for the outbound connection status.
String packageID
Internal ID of the package.
String packageName
User specified name of the package.
String packageType
Currently supports only TXT-DICTIONARY.
String packageDescription
User-specified description of the package.
String packageStatus
Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
Date createdAt
Timestamp which tells creation date of the package.
Date lastUpdatedAt
String availablePackageVersion
ErrorDetails errorDetails
Additional information if the package is in an error state. Null otherwise.
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 crossClusterSearchConnectionId
The id of the inbound connection that you want to reject.
InboundCrossClusterSearchConnection crossClusterSearchConnection
Specifies the InboundCrossClusterSearchConnection
of rejected inbound connection.
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.
Boolean enabled
True if SAML is enabled.
SAMLIdp idp
Specifies the SAML Identity Provider's information.
String masterUserName
The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.
String masterBackendRole
The backend role to which the SAML master user is mapped to.
String subjectKey
The key to use for matching the SAML Subject attribute.
String rolesKey
The key to use for matching the SAML Roles attribute.
Integer sessionTimeoutMinutes
The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
Boolean enabled
True if SAML is enabled.
SAMLIdp idp
Describes the SAML Identity Provider's information.
String subjectKey
The key used for matching the SAML Subject attribute.
String rolesKey
The key used for matching the SAML Roles attribute.
Integer sessionTimeoutMinutes
The duration, in minutes, after which a user session becomes inactive.
Date date
Specifies timestamp for the Auto-Tune action scheduled for the domain.
String actionType
Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
String action
Specifies Auto-Tune action description.
String severity
Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
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.
Boolean optionalDeployment
True
if a service software is never automatically updated. False
if a service software
is automatically updated after AutomatedUpdateDate
.
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.
DomainEndpointOptions domainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
AdvancedSecurityOptionsInput advancedSecurityOptions
Specifies advanced security options.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Specifies the NodeToNodeEncryptionOptions.
EncryptionAtRestOptions encryptionAtRestOptions
Specifies the Encryption At Rest Options.
AutoTuneOptions autoTuneOptions
Specifies Auto-Tune options.
Boolean dryRun
This flag, when set to True, specifies whether the UpdateElasticsearchDomain
request should return
the results of validation checks without actually applying the change. This flag, when set to True, specifies the
deployment mechanism through which the update shall be applied on the domain. This will not actually perform the
Update.
ElasticsearchDomainConfig domainConfig
The status of the updated Elasticsearch domain.
DryRunResults dryRunResults
Contains result of DryRun.
String packageID
Unique identifier for the package.
PackageSource packageSource
String packageDescription
New description of the package.
String commitMessage
An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse
.
PackageDetails packageDetails
Information about the package PackageDetails
.
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.
ChangeProgressDetails changeProgressDetails
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 © 2022. All rights reserved.