String connectionId
The ID of the inbound connection you want to accept.
InboundConnection connection
The InboundConnection
of the accepted inbound connection.
String options
The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. See Configuring access policiesfor more information.
OptionStatus status
The status of the access policy for the domain. See OptionStatus
for the status information that's
included.
String limitName
Additional limit is specific to a given InstanceType and for each of its InstanceRole
etc.
Attributes and their details:
ESPartitionInstanceType
can support as master node.
ESPartitionInstanceType
up to which you don't need any master
nodes to govern them.
List<E> limitValues
Value for a given AdditionalLimit$LimitName
.
Map<K,V> options
The status of advanced options for the specified domain.
OptionStatus status
The OptionStatus
for advanced options for the specified 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.
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
The SAML application configuration for the domain.
AdvancedSecurityOptions options
Advanced security options for the specified domain.
OptionStatus status
Status of the advanced security options for the specified domain.
DomainPackageDetails domainPackageDetails
DomainPackageDetails
String autoTuneType
Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.
AutoTuneDetails autoTuneDetails
Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.
ScheduledAutoTuneDetails scheduledAutoTuneDetails
Date startAt
The timestamp at which the Auto-Tune maintenance schedule starts.
Duration duration
Specifies maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.
String cronExpressionForRecurrence
A cron expression for a recurring maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.
String desiredState
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
String rollbackOnDisable
The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.
List<E> maintenanceSchedules
A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
String desiredState
The Auto-Tune desired state. Valid values are ENABLED and DISABLED.
List<E> maintenanceSchedules
A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.
AutoTuneOptions options
Specifies Auto-Tune options for the domain.
AutoTuneStatus status
The status of the Auto-Tune options for the domain.
Date creationDate
The timestamp of the Auto-Tune options creation date.
Date updateDate
The timestamp of when the Auto-Tune options were last updated.
Integer updateVersion
The latest version of the Auto-Tune options.
String state
The AutoTuneState
for the domain.
String errorMessage
The error message while enabling or disabling Auto-Tune.
Boolean pendingDeletion
Indicates whether the 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 OpenSearch service software update.
String instanceType
The instance type for an OpenSearch 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 Dedicated master nodes in Amazon OpenSearch Service for more information.
Boolean zoneAwarenessEnabled
A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.
ZoneAwarenessConfig zoneAwarenessConfig
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 UltraWarm storage.
String warmType
The instance type for the OpenSearch cluster's warm nodes.
Integer warmCount
The number of UltraWarm nodes in the cluster.
ColdStorageOptions coldStorageOptions
Specifies the ColdStorageOptions
config for a Domain
ClusterConfig options
The cluster configuration for the specified domain.
OptionStatus status
The cluster configuration status for the specified domain.
Boolean enabled
The option to enable Cognito for OpenSearch Dashboards authentication.
String userPoolId
The Cognito user pool ID for OpenSearch Dashboards authentication.
String identityPoolId
The Cognito identity pool ID for OpenSearch Dashboards authentication.
String roleArn
The role ARN that provides OpenSearch permissions for accessing Cognito resources.
CognitoOptions options
Cognito options for the specified domain.
OptionStatus status
The status of the Cognito options for the specified domain.
Boolean enabled
Enable cold storage option. Accepted values true or false
String domainName
The name of the Amazon OpenSearch Service domain you're 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 engineVersion
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon OpenSearch Service domain. For example, "OpenSearch_1.0" or "Elasticsearch_7.9". For more information, see Creating and managing Amazon OpenSearch Service domains .
ClusterConfig clusterConfig
Configuration options for a domain. Specifies the instance type and number of instances in the domain.
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 a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
CognitoOptions cognitoOptions
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
EncryptionAtRestOptions encryptionAtRestOptions
Options for encryption of data at rest.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Node-to-node encryption options.
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 Advanced cluster parameters for more information.
Map<K,V> logPublishingOptions
Map of LogType
and LogPublishingOption
, each containing options to publish a given type
of OpenSearch log.
DomainEndpointOptions domainEndpointOptions
Options to specify configurations that will be applied to the domain endpoint.
AdvancedSecurityOptionsInput advancedSecurityOptions
Specifies advanced security options.
List<E> tagList
A list of Tag
added during domain creation.
AutoTuneOptionsInput autoTuneOptions
Specifies Auto-Tune options.
DomainStatus domainStatus
The status of the newly created domain.
DomainInformationContainer localDomainInfo
The AWSDomainInformation
for the local OpenSearch domain.
DomainInformationContainer remoteDomainInfo
The AWSDomainInformation
for the remote OpenSearch domain.
String connectionAlias
The connection alias used used by the customer for this cross-cluster connection.
DomainInformationContainer localDomainInfo
The AWSDomainInformation
for the local OpenSearch domain.
DomainInformationContainer remoteDomainInfo
The AWSDomainInformation
for the remote OpenSearch domain.
String connectionAlias
The connection alias provided during the create connection request.
OutboundConnectionStatus connectionStatus
The OutboundConnectionStatus
for the newly created connection.
String connectionId
The unique ID for the created outbound connection, which is used for subsequent operations on the 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 Amazon S3 location from which to import the package.
PackageDetails packageDetails
Information about the package.
String domainName
The name of the domain you want to permanently delete.
DomainStatus domainStatus
The status of the domain being deleted.
String connectionId
The ID of the inbound connection to permanently delete.
InboundConnection connection
The InboundConnection
of the deleted inbound connection.
String connectionId
The ID of the outbound connection you want to permanently delete.
OutboundConnection connection
The OutboundConnection
of the deleted outbound connection.
String packageID
The internal ID of the package you want to delete. Use DescribePackages
to find this value.
PackageDetails packageDetails
PackageDetails
String domainName
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. Used for pagination.
List<E> autoTunes
The list of setting adjustments that Auto-Tune has made to the domain. See Auto-Tune for Amazon OpenSearch Service for more information.
String nextToken
An identifier to allow retrieval of paginated results.
String domainName
The domain you want to get information about.
DomainConfig domainConfig
The configuration information of the domain requested in the DescribeDomainConfig
request.
String domainName
The name of the domain for which you want information.
DomainStatus domainStatus
The current status of the domain.
List<E> filters
A list of filters used to match properties for inbound cross-cluster connections. Available
Filter
values are:
Integer maxResults
Set this value to limit the number of results returned. If not specified, defaults to 100.
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> connections
A list of InboundConnection
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.
String domainName
The name of the domain you want to modify. Only include this value if you're querying OpenSearch
Limits
for an existing domain.
String instanceType
The instance type for an OpenSearch cluster for which OpenSearch Limits
are needed.
String engineVersion
Version of OpenSearch for which Limits
are needed.
List<E> filters
A list of filters used to match properties for outbound cross-cluster connections. 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 parameter. Used for pagination.
List<E> connections
A list of OutboundConnection
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 reservedInstanceOfferingId
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
Provides an identifier to allow retrieval of paginated results.
String reservedInstanceId
The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
Integer maxResults
Set this value to limit the number of results returned. If not specified, defaults to 100.
String nextToken
Provides an identifier to allow retrieval of paginated results.
DomainPackageDetails domainPackageDetails
DomainPackageDetails
VersionStatus engineVersion
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.
ClusterConfigStatus clusterConfig
The ClusterConfig
for the domain.
EBSOptionsStatus eBSOptions
The EBSOptions
for the domain.
AccessPoliciesStatus accessPolicies
IAM access policy as a JSON-formatted string.
SnapshotOptionsStatus snapshotOptions
The SnapshotOptions
for the domain.
VPCDerivedInfoStatus vPCOptions
The VPCOptions
for the specified domain. For more information, see Launching
your Amazon OpenSearch Service domains using a VPC.
CognitoOptionsStatus cognitoOptions
The CognitoOptions
for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
EncryptionAtRestOptionsStatus encryptionAtRestOptions
The EncryptionAtRestOptions
for the domain.
NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions
The NodeToNodeEncryptionOptions
for the domain.
AdvancedOptionsStatus advancedOptions
The AdvancedOptions
for the domain. See Advanced options for more information.
LogPublishingOptionsStatus logPublishingOptions
Log publishing options for the given domain.
DomainEndpointOptionsStatus domainEndpointOptions
The DomainEndpointOptions
for the domain.
AdvancedSecurityOptionsStatus advancedSecurityOptions
Specifies AdvancedSecurityOptions
for the domain.
AutoTuneOptionsStatus autoTuneOptions
Specifies AutoTuneOptions
for the domain.
Boolean enforceHTTPS
Whether only HTTPS endpoint should be enabled for the domain.
String tLSSecurityPolicy
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Boolean customEndpointEnabled
Whether to enable a custom endpoint for the domain.
String customEndpoint
The fully qualified domain for your custom endpoint.
String customEndpointCertificateArn
The ACM certificate ARN for your custom endpoint.
DomainEndpointOptions options
Options to configure the endpoint for the domain.
OptionStatus status
The status of the endpoint options for the domain. See OptionStatus
for the status information
that's included.
AWSDomainInformation aWSDomainInformation
String packageID
The internal ID of the package.
String packageName
User-specified name of the package.
String packageType
Currently supports only TXT-DICTIONARY.
Date lastUpdated
The timestamp of the most recent update to the package association status.
String domainName
The name of the domain you've associated a package with.
String domainPackageStatus
State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.
String packageVersion
String referencePath
The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.
ErrorDetails errorDetails
Additional information if the package is in an error state. Null otherwise.
String domainId
The unique identifier for the specified domain.
String domainName
The name of a 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 a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.
Boolean created
The domain creation status. True
if the creation of a 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 domain endpoint that you use to submit index and search requests.
Map<K,V> endpoints
Map containing the 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 domain configuration. True
if Amazon OpenSearch Service is processing
configuration changes. False
if the configuration is active.
Boolean upgradeProcessing
The status of a domain version upgrade. True
if Amazon OpenSearch Service is undergoing a version
upgrade. False
if the configuration is active.
String engineVersion
ClusterConfig clusterConfig
The type and number of instances in the domain.
EBSOptions eBSOptions
The EBSOptions
for the specified domain.
String accessPolicies
IAM access policy as a JSON-formatted string.
SnapshotOptions snapshotOptions
The status of the SnapshotOptions
.
VPCDerivedInfo vPCOptions
The VPCOptions
for the specified domain. For more information, see Launching
your Amazon OpenSearch Service domains using a VPC.
CognitoOptions cognitoOptions
The CognitoOptions
for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
EncryptionAtRestOptions encryptionAtRestOptions
The status of the EncryptionAtRestOptions
.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
The status of the NodeToNodeEncryptionOptions
.
Map<K,V> advancedOptions
The status of the AdvancedOptions
.
Map<K,V> logPublishingOptions
Log publishing options for the given domain.
ServiceSoftwareOptions serviceSoftwareOptions
The current status of the domain's service software.
DomainEndpointOptions domainEndpointOptions
The current status of the domain's endpoint options.
AdvancedSecurityOptions advancedSecurityOptions
The current status of the domain's advanced security options.
AutoTuneOptionsOutput autoTuneOptions
The current status of the domain's Auto-Tune options.
Long value
Integer to specify the value of a maintenance schedule duration. See Auto-Tune for Amazon OpenSearch Service for more information.
String unit
The unit of a maintenance schedule duration. Valid value is HOURS. See Auto-Tune for Amazon OpenSearch Service for more information.
EBSOptions options
The EBS options for the specified domain.
OptionStatus status
The status of the EBS options for the specified domain.
EncryptionAtRestOptions options
The Encryption At Rest options for the specified domain.
OptionStatus status
The status of the Encryption At Rest options for the specified domain.
String domainName
List<E> compatibleVersions
A map of compatible OpenSearch versions returned as part of the GetCompatibleVersions
operation.
String packageID
Returns an audit history of package versions.
Integer maxResults
Limits results to a maximum number of package 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 the 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
One of three steps an upgrade or upgrade eligibility check goes through:
String stepStatus
One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse
object. The status can take one of the following values:
String upgradeName
A string that briefly describes the update.
DomainInformationContainer localDomainInfo
The AWSDomainInformation
for the local OpenSearch domain.
DomainInformationContainer remoteDomainInfo
The AWSDomainInformation
for the remote OpenSearch domain.
String connectionId
The connection ID for the inbound cross-cluster connection.
InboundConnectionStatus connectionStatus
The InboundConnectionStatus
for the outbound connection.
String statusCode
The state code for the inbound connection. Can be one of the following:
String message
Verbose information for the inbound connection status.
InstanceCountLimits instanceCountLimits
List<E> storageTypes
Storage-related types and attributes that are available for a given InstanceType.
InstanceLimits instanceLimits
List<E> additionalLimits
List of additional limits that are specific to a given InstanceType and for each of its
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 associated domains.
Integer maxResults
Limits the 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 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
of the domain that the tags you want to view are attached to.
Map<K,V> options
The log publishing options configured for the domain.
OptionStatus status
The status of the log publishing options for the 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 OpenSearch Service domain's internal database.
String masterUserPassword
The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.
Boolean enabled
True to enable node-to-node encryption.
NodeToNodeEncryptionOptions options
The node-to-node encryption options for the specified domain.
OptionStatus status
The status of the node-to-node encryption options for the specified domain.
Date creationDate
The timestamp of when the entity was created.
Date updateDate
The timestamp of the last time the entity was updated.
Integer updateVersion
The latest version of the entity.
String state
Provides the OptionState
for the domain.
Boolean pendingDeletion
Indicates whether the domain is being deleted.
DomainInformationContainer localDomainInfo
The DomainInformation
for the local OpenSearch domain.
DomainInformationContainer remoteDomainInfo
The DomainInformation
for the remote OpenSearch domain.
String connectionId
The connection ID for the outbound cross-cluster connection.
String connectionAlias
The connection alias for the outbound cross-cluster connection.
OutboundConnectionStatus connectionStatus
The OutboundConnectionStatus
for the outbound connection.
String statusCode
The state code for the outbound connection. Can be one of the following:
String message
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, and DELETE_FAILED.
Date createdAt
The timestamp of when the package was created.
Date lastUpdatedAt
String availablePackageVersion
ErrorDetails errorDetails
Additional information if the package is in an error state. Null otherwise.
String reservedInstanceOfferingId
The ID of the reserved OpenSearch instance offering to purchase.
String reservationName
A customer-specified identifier to track this reservation.
Integer instanceCount
The number of OpenSearch instances to reserve.
String connectionId
The ID of the inbound connection to reject.
InboundConnection connection
The InboundConnection
of the rejected inbound connection.
String reservationName
The customer-specified identifier to track this reservation.
String reservedInstanceId
The unique identifier for the reservation.
Long billingSubscriptionId
String reservedInstanceOfferingId
The offering identifier.
String instanceType
The OpenSearch instance type offered by the reserved instance offering.
Date startTime
The time the reservation started.
Integer duration
The duration, in seconds, for which the OpenSearch instance is reserved.
Double fixedPrice
The upfront fixed charge you will paid to purchase the specific reserved OpenSearch 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 OpenSearch instance offering.
Integer instanceCount
The number of OpenSearch instances that have been reserved.
String state
The state of the reserved OpenSearch instance.
String paymentOption
The payment option as defined in the reserved OpenSearch instance offering.
List<E> recurringCharges
The charge to your account regardless of whether you are creating any domains using the instance offering.
String reservedInstanceOfferingId
The OpenSearch reserved instance offering identifier.
String instanceType
The OpenSearch instance type offered by the reserved instance offering.
Integer duration
The duration, in seconds, for which the offering will reserve the OpenSearch instance.
Double fixedPrice
The upfront fixed charge you will pay to purchase the specific reserved OpenSearch 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 OpenSearch instance offering.
String paymentOption
Payment option for the reserved OpenSearch 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
The SAML Identity Provider's information.
String masterUserName
The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.
String masterBackendRole
The backend role that the SAML master user is mapped to.
String subjectKey
Element of the SAML assertion to use for username. Default is NameID.
String rolesKey
Element of the SAML assertion to use for backend roles. Default is roles.
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
The timestamp of the Auto-Tune action scheduled for the domain.
String actionType
The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
String action
The Auto-Tune action description.
String severity
The Auto-Tune action severity. Valid values are LOW, MEDIUM, and HIGH.
String currentVersion
The current service software version present on the domain.
String newVersion
The new service software version if one is available.
Boolean updateAvailable
True
if you're able to update your service software version. False
if you can't update
your service software version.
Boolean cancellable
True
if you're able to cancel your service software version update. False
if you can't
cancel your service software update.
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
The 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
The time, in UTC format, when the service takes a daily automated snapshot of the specified domain. Default is
0
hours.
SnapshotOptions options
The daily snapshot options specified for the domain.
OptionStatus status
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 OpenSearch service software update.
String limitName
Name of storage limits that are applicable for the given storage type. If StorageType
is
"ebs", the following storage options are applicable:
List<E> limitValues
Values for the StorageTypeLimit$LimitName
.
String key
The TagKey
, the name of the tag. Tag keys must be unique for the domain to which they are attached.
String value
The TagValue
, the value assigned to the corresponding tag key. Tag values can be null and don't 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 domain you're updating.
ClusterConfig clusterConfig
The type and number of instances to instantiate for the domain cluster.
EBSOptions eBSOptions
Specify the type and size of the EBS volume 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 the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .
CognitoOptions cognitoOptions
Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
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 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 OpenSearch log.
EncryptionAtRestOptions encryptionAtRestOptions
Specifies encryption of data at rest options.
DomainEndpointOptions domainEndpointOptions
Options to specify configuration that will be applied to the domain endpoint.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Specifies node-to-node encryption options.
AdvancedSecurityOptionsInput advancedSecurityOptions
Specifies advanced security options.
AutoTuneOptions autoTuneOptions
Specifies Auto-Tune options.
DomainConfig domainConfig
The status of the updated domain.
String packageID
The unique identifier for the package.
PackageSource packageSource
String packageDescription
A new description of the package.
String commitMessage
A commit message for the new version which is shown as part of GetPackageVersionHistoryResponse
.
PackageDetails packageDetails
Information about the package.
String domainName
String targetVersion
The version of OpenSearch you intend to upgrade the domain to.
Boolean performCheckOnly
When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
Map<K,V> advancedOptions
String upgradeId
String domainName
String targetVersion
The version of OpenSearch that you intend to upgrade the domain to.
Boolean performCheckOnly
When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
Map<K,V> advancedOptions
String upgradeName
A string that briefly describes the upgrade.
Date startTimestamp
UTC timestamp at which the upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
String upgradeStatus
The current status of the upgrade. The status can take one of the following values:
List<E> stepsList
A list of UpgradeStepItem
s representing information about each step performed as part of a
specific upgrade or upgrade eligibility check.
String upgradeStep
One of three steps an upgrade or upgrade eligibility check goes through:
String upgradeStepStatus
The current status of the 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 the progress percentage of a particular step.
String options
The OpenSearch version for the specified OpenSearch domain.
OptionStatus status
The status of the OpenSearch version options for the specified OpenSearch domain.
String vPCId
The VPC ID for the domain. Exists only if the domain was created with VPCOptions
.
List<E> subnetIds
The subnets for the VPC endpoint.
List<E> availabilityZones
The Availability Zones for the domain. Exists only if the domain was created with VPCOptions
.
List<E> securityGroupIds
The security groups for the VPC endpoint.
VPCDerivedInfo options
The VPC options for the specified domain.
OptionStatus status
The status of the VPC options for the specified 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 © 2021. All rights reserved.