String connectionId
The ID of the inbound connection to accept.
InboundConnection connection
Information about the accepted inbound connection.
String options
The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.
OptionStatus status
The status of the access policy for the domain.
String limitName
MaximumNumberOfDataNodesSupported
- This attribute only applies to master nodes and specifies the
maximum number of data nodes of a given instance type a master node can support.
MaximumNumberOfDataNodesWithoutMasterNode
- This attribute only applies to data nodes and specifies
the maximum number of data nodes of a given instance type can exist without a master node governing them.
List<E> limitValues
The values of the additional instance type limits.
Map<K,V> options
The status of advanced options for the specified domain.
OptionStatus status
The status of advanced options for the specified domain.
Boolean enabled
True if fine-grained access control is enabled.
Boolean internalUserDatabaseEnabled
True if the internal user database is enabled.
SAMLOptionsOutput sAMLOptions
Container for information about the SAML configuration for OpenSearch Dashboards.
Date anonymousAuthDisableDate
Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
Boolean anonymousAuthEnabled
True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
Boolean enabled
True to enable fine-grained access control.
Boolean internalUserDatabaseEnabled
True to enable the internal user database.
MasterUserOptions masterUserOptions
Container for information about the master user.
SAMLOptionsInput sAMLOptions
Container for information about the SAML configuration for OpenSearch Dashboards.
Boolean anonymousAuthEnabled
True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
AdvancedSecurityOptions options
Container for fine-grained access control settings.
OptionStatus status
Status of the fine-grained access control settings for a domain.
DomainPackageDetails domainPackageDetails
Information about a package that is associated with a domain.
String principalType
The type of principal.
String principal
The IAM principal that is allowed access to the domain.
AuthorizedPrincipal authorizedPrincipal
Information about the Amazon Web Services account or service that was provided access to the domain.
String autoTuneType
The type of Auto-Tune action.
AutoTuneDetails autoTuneDetails
Details about an Auto-Tune action.
ScheduledAutoTuneDetails scheduledAutoTuneDetails
Container for details about a scheduled Auto-Tune action.
Date startAt
The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
Duration duration
The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}
.
String cronExpressionForRecurrence
A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
String desiredState
Whether Auto-Tune is enabled or disabled.
String rollbackOnDisable
When disabling Auto-Tune, specify NO_ROLLBACK
to retain all prior Auto-Tune settings or
DEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults. If you specify
DEFAULT_ROLLBACK
, you must include a MaintenanceSchedule
in the request. Otherwise,
OpenSearch Service is unable to perform the rollback.
List<E> maintenanceSchedules
A list of maintenance schedules during which Auto-Tune can deploy changes.
String desiredState
Whether Auto-Tune is enabled or disabled.
List<E> maintenanceSchedules
A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance schedules are overwrite,
not append. If your request includes no schedules, the request deletes all existing schedules. To preserve
existing schedules, make a call to DescribeDomainConfig
first and use the
MaintenanceSchedules
portion of the response as the basis for this section.
AutoTuneOptions options
Auto-Tune settings for updating a domain.
AutoTuneStatus status
The current status of Auto-Tune for a domain.
Date creationDate
Date and time when Auto-Tune was enabled for the domain.
Date updateDate
Date and time when the Auto-Tune options were last updated for the domain.
Integer updateVersion
The latest version of the Auto-Tune options.
String state
The current state of Auto-Tune on the domain.
String errorMessage
Any errors that occurred while enabling or disabling Auto-Tune.
Boolean pendingDeletion
Indicates whether the domain is being deleted.
String domainName
Name of the OpenSearch Service domain that you want to cancel the service software update on.
ServiceSoftwareOptions serviceSoftwareOptions
Container for the state of your domain relative to the latest service software.
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.
List<E> pendingProperties
The list of properties in the domain configuration change that are still pending.
List<E> completedProperties
The list of properties in the domain configuration change that have 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.
String instanceType
Instance type of data nodes in the cluster.
Integer instanceCount
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
Boolean dedicatedMasterEnabled
Indicates whether dedicated master nodes are enabled for the cluster.True
if the cluster will use a
dedicated master node.False
if the cluster will not.
Boolean zoneAwarenessEnabled
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig zoneAwarenessConfig
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled
is
true
.
String dedicatedMasterType
OpenSearch Service instance type of the dedicated master nodes in the cluster.
Integer dedicatedMasterCount
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
Boolean warmEnabled
Whether to enable warm storage for the cluster.
String warmType
The instance type for the cluster's warm nodes.
Integer warmCount
The number of warm nodes in the cluster.
ColdStorageOptions coldStorageOptions
Container for cold storage configuration options.
ClusterConfig options
Cluster configuration options for the specified domain.
OptionStatus status
The status of cluster configuration options for the specified domain.
Boolean enabled
Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
String userPoolId
The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
String identityPoolId
The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
String roleArn
The AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user
pool and identity pool.
CognitoOptions options
Cognito options for the specified domain.
OptionStatus status
The status of the Cognito options for the specified domain.
Boolean enabled
Whether to enable or disable cold storage on the domain.
String domainName
Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
String engineVersion
String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the 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
Container for the cluster configuration of a domain.
EBSOptions eBSOptions
Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
String accessPolicies
Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
SnapshotOptions snapshotOptions
DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
VPCOptions vPCOptions
Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
CognitoOptions cognitoOptions
Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
EncryptionAtRestOptions encryptionAtRestOptions
Key-value pairs to enable encryption at rest.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Enables node-to-node encryption.
Map<K,V> advancedOptions
Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a
boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you
want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must
disable this property. Default is true.
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies
the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean.
Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more
than the permitted number of clauses result in a TooManyClauses
error.
"override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean.
Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to
continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
Map<K,V> logPublishingOptions
Key-value pairs to configure slow log publishing.
DomainEndpointOptions domainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
AdvancedSecurityOptionsInput advancedSecurityOptions
Options for fine-grained access control.
List<E> tagList
List of tags to add to the domain upon creation.
AutoTuneOptionsInput autoTuneOptions
Options for Auto-Tune.
DomainStatus domainStatus
The status of the newly created domain.
DomainInformationContainer localDomainInfo
Name and Region of the source (local) domain.
DomainInformationContainer remoteDomainInfo
Name and Region of the destination (remote) domain.
String connectionAlias
Name of the connection.
DomainInformationContainer localDomainInfo
Information about the source (local) domain.
DomainInformationContainer remoteDomainInfo
Information about the destination (remote) domain.
String connectionAlias
Name of the connection.
OutboundConnectionStatus connectionStatus
The status of the connection.
String connectionId
The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
String packageName
Unique name for the package.
String packageType
Type of package.
String packageDescription
Description of the package.
PackageSource packageSource
The Amazon S3 location from which to import the package.
PackageDetails packageDetails
Basic information about an OpenSearch Service package.
String domainArn
The Amazon Resource Name (ARN) of the domain to grant access to.
VPCOptions vpcOptions
Options to specify the subnets and security groups for the endpoint.
String clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
VpcEndpoint vpcEndpoint
Information about the newly created VPC endpoint.
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 deleted inbound connection.
String connectionId
The ID of the outbound connection you want to permanently delete.
OutboundConnection connection
The deleted inbound connection.
String packageID
The internal ID of the package you want to delete. Use DescribePackages
to find this value.
PackageDetails packageDetails
Information about the deleted package.
String vpcEndpointId
The unique identifier of the endpoint.
VpcEndpointSummary vpcEndpointSummary
Information about the deleted endpoint, including its current status (DELETING
or
DELETE_FAILED
).
String domainName
Name of the domain that you want Auto-Tune details about.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial DescribeDomainAutoTunes
operation returns a nextToken
, you can include
the returned nextToken
in subsequent DescribeDomainAutoTunes
operations, which returns
results in the next page.
List<E> autoTunes
The list of setting adjustments that Auto-Tune has made to the domain.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
ChangeProgressStatusDetails changeProgressStatus
Container for information about the stages of a configuration change happening on a domain.
String domainName
Name of the OpenSearch Service domain configuration that you want to describe.
DomainConfig domainConfig
Container for the configuration of the OpenSearch Service domain.
String domainName
The name of the domain that you want information about.
DomainStatus domainStatus
List that contains the status of each specified OpenSearch Service domain.
List<E> filters
A list of filters used to match properties for inbound cross-cluster connections.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial DescribeInboundConnections
operation returns a nextToken
, you can
include the returned nextToken
in subsequent DescribeInboundConnections
operations,
which returns results in the next page.
String domainName
The name of the domain. Only specify if you need the limits for an existing domain.
String instanceType
The OpenSearch Service instance type for which you need limit information.
String engineVersion
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
List<E> filters
List of filter names and values that you can use for requests.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial DescribeOutboundConnections
operation returns a nextToken
, you can
include the returned nextToken
in subsequent DescribeOutboundConnections
operations,
which returns results in the next page.
List<E> connections
List of outbound connections that match the filter criteria.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
List<E> filters
Only returns packages that match the DescribePackagesFilterList
values.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial DescribePackageFilters
operation returns a nextToken
, you can include
the returned nextToken
in subsequent DescribePackageFilters
operations, which returns
results in the next page.
List<E> packageDetailsList
Basic information about a package.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String reservedInstanceOfferingId
The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial DescribeReservedInstanceOfferings
operation returns a nextToken
, you
can include the returned nextToken
in subsequent DescribeReservedInstanceOfferings
operations, which returns results in the next page.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
List<E> reservedInstanceOfferings
List of Reserved Instance offerings.
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
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial DescribeReservedInstances
operation returns a nextToken
, you can
include the returned nextToken
in subsequent DescribeReservedInstances
operations,
which returns results in the next page.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
List<E> reservedInstances
List of Reserved Instances in the current Region.
DomainPackageDetails domainPackageDetails
Information about a package that has been dissociated from the domain.
VersionStatus engineVersion
The OpenSearch or Elasticsearch version that the domain is running.
ClusterConfigStatus clusterConfig
Container for the cluster configuration of a the domain.
EBSOptionsStatus eBSOptions
Container for EBS options configured for an OpenSearch Service domain.
AccessPoliciesStatus accessPolicies
Specifies the access policies for the domain.
SnapshotOptionsStatus snapshotOptions
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
VPCDerivedInfoStatus vPCOptions
The current VPC options for the domain and the status of any updates to their configuration.
CognitoOptionsStatus cognitoOptions
Container for Amazon Cognito options for the domain.
EncryptionAtRestOptionsStatus encryptionAtRestOptions
Key-value pairs to enable encryption at rest.
NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions
Whether node-to-node encryption is enabled or disabled.
AdvancedOptionsStatus advancedOptions
Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
LogPublishingOptionsStatus logPublishingOptions
Key-value pairs to configure slow log publishing.
DomainEndpointOptionsStatus domainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
AdvancedSecurityOptionsStatus advancedSecurityOptions
Container for fine-grained access control settings for the domain.
AutoTuneOptionsStatus autoTuneOptions
Container for Auto-Tune settings for the domain.
ChangeProgressDetails changeProgressDetails
Container for information about the progress of an existing configuration change.
Boolean enforceHTTPS
True to require that all traffic to the domain arrive over HTTPS.
String tLSSecurityPolicy
Specify the TLS security policy to apply to the HTTPS endpoint of the domain.
Can be one of the following values:
Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.
Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2
Boolean customEndpointEnabled
Whether to enable a custom endpoint for the domain.
String customEndpoint
The fully qualified URL for the custom endpoint.
String customEndpointCertificateArn
The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
DomainEndpointOptions options
Options to configure the endpoint for a domain.
OptionStatus status
The status of the endpoint options for a domain.
AWSDomainInformation aWSDomainInformation
Information about an Amazon OpenSearch Service domain.
String packageID
Internal ID of the package.
String packageName
User-specified name of the package.
String packageType
The type of package.
Date lastUpdated
Timestamp of the most recent update to the package association status.
String domainName
Name of the domain that the package is associated with.
String domainPackageStatus
State of the association.
String packageVersion
The current version of the package.
String referencePath
Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as
synonym_path
for dictionary files.
ErrorDetails errorDetails
Additional information if the package is in an error state. Null otherwise.
String domainId
Unique identifier for the domain.
String domainName
Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
String aRN
The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
Boolean created
Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
Boolean deleted
Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
String endpoint
Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
Map<K,V> endpoints
The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example
key, value
:
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
.
Boolean processing
The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
Boolean upgradeProcessing
The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
String engineVersion
Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y
or OpenSearch_X.Y
.
ClusterConfig clusterConfig
Container for the cluster configuration of the domain.
EBSOptions eBSOptions
Container for EBS-based storage settings for the domain.
String accessPolicies
Identity and Access Management (IAM) policy document specifying the access policies for the domain.
SnapshotOptions snapshotOptions
DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
VPCDerivedInfo vPCOptions
The VPC configuration for the domain.
CognitoOptions cognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
EncryptionAtRestOptions encryptionAtRestOptions
Encryption at rest settings for the domain.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Whether node-to-node encryption is enabled or disabled.
Map<K,V> advancedOptions
Key-value pairs that specify advanced configuration options.
Map<K,V> logPublishingOptions
Log publishing options for the domain.
ServiceSoftwareOptions serviceSoftwareOptions
The current status of the domain's service software.
DomainEndpointOptions domainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
AdvancedSecurityOptions advancedSecurityOptions
Settings for fine-grained access control.
AutoTuneOptionsOutput autoTuneOptions
Auto-Tune settings for the domain.
ChangeProgressDetails changeProgressDetails
Information about a configuration change happening on the domain.
String deploymentType
Specifies the way in which OpenSearch Service will apply an update. Possible values are:
Blue/Green - The update requires a blue/green deployment.
DynamicUpdate - No blue/green deployment required
Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.
None - The request doesn't include any configuration changes.
String message
A message corresponding to the deployment type.
Boolean eBSEnabled
Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
String volumeType
Specifies the type of EBS volumes attached to data nodes.
Integer volumeSize
Specifies the size (in GiB) of EBS volumes attached to data nodes.
Integer iops
Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for
the gp3
and provisioned IOPS EBS volume types.
Integer throughput
Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
EBSOptions options
The configured EBS options for the specified domain.
OptionStatus status
The status of the EBS options for the specified domain.
EncryptionAtRestOptions options
Encryption at rest options for the specified domain.
OptionStatus status
The status of the encryption at rest options for the specified domain.
String domainName
The name of an existing domain. Provide this parameter to limit the results to a single domain.
String packageID
The unique identifier of the package.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial GetPackageVersionHistory
operation returns a nextToken
, you can include
the returned nextToken
in subsequent GetPackageVersionHistory
operations, which returns
results in the next page.
String packageID
The unique identifier of the package.
List<E> packageVersionHistoryList
A list of package versions, along with their creation time and commit message.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String domainName
The name of an existing domain.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial GetUpgradeHistory
operation returns a nextToken
, you can include the
returned nextToken
in subsequent GetUpgradeHistory
operations, which returns results in
the next page.
List<E> upgradeHistories
A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String domainName
The domain of the domain to get upgrade status information for.
DomainInformationContainer localDomainInfo
Information about the source (local) domain.
DomainInformationContainer remoteDomainInfo
Information about the destination (remote) domain.
String connectionId
The unique identifier of the connection.
InboundConnectionStatus connectionStatus
The current status of the connection.
String statusCode
The status code for the connection. Can be one of the following:
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
PROVISIONING: Inbound connection is being provisioned.
ACTIVE: Inbound connection is active and ready to use.
REJECTING: Inbound connection rejection is in process.
REJECTED: Inbound connection is rejected.
DELETING: Inbound connection deletion is in progress.
DELETED: Inbound connection is deleted and can no longer be used.
String message
Information about the connection.
InstanceCountLimits instanceCountLimits
Limits on the number of instances that can be created for a given instance type.
String instanceType
The instance type.
Boolean encryptionEnabled
Whether encryption at rest and node-to-node encryption are supported for the instance type.
Boolean cognitoEnabled
Whether Amazon Cognito access is supported for the instance type.
Boolean appLogsEnabled
Whether logging is supported for the instance type.
Boolean advancedSecurityEnabled
Whether fine-grained access control is supported for the instance type.
Boolean warmEnabled
Whether UltraWarm is supported for the instance type.
List<E> instanceRole
Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.
List<E> storageTypes
Storage-related attributes that are available for a given instance type.
InstanceLimits instanceLimits
The limits for a given instance type.
List<E> additionalLimits
List of additional limits that are specific to a given instance type for each of its instance roles.
String engineType
Filters the output by domain engine type.
String packageID
The unique identifier of the package for which to list associated domains.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial ListDomainsForPackage
operation returns a nextToken
, you can include
the returned nextToken
in subsequent ListDomainsForPackage
operations, which returns
results in the next page.
List<E> domainPackageDetailsList
Information about all domains associated with a package.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String engineVersion
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
String domainName
Name of the domain to list instance type details for.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial ListInstanceTypeDetails
operation returns a nextToken
, you can include
the returned nextToken
in subsequent ListInstanceTypeDetails
operations, which returns
results in the next page.
List<E> instanceTypeDetails
Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String domainName
The name of the domain for which you want to list associated packages.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial ListPackagesForDomain
operation returns a nextToken
, you can include
the returned nextToken
in subsequent ListPackagesForDomain
operations, which returns
results in the next page.
List<E> domainPackageDetailsList
List of all packages associated with a domain.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String aRN
Amazon Resource Name (ARN) for the domain to view tags for.
Integer maxResults
An optional parameter that specifies the maximum number of results to return. You can use nextToken
to get the next page of results.
String nextToken
If your initial ListVersions
operation returns a nextToken
, you can include the
returned nextToken
in subsequent ListVersions
operations, which returns results in the
next page.
List<E> versions
A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String domainName
The name of the OpenSearch Service domain to retrieve access information for.
String nextToken
If your initial ListVpcEndpointAccess
operation returns a nextToken
, you can include
the returned nextToken
in subsequent ListVpcEndpointAccess
operations, which returns
results in the next page.
List<E> authorizedPrincipalList
A list of IAM principals that can currently access the domain.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String domainName
The name of the domain to list associated VPC endpoints for.
String nextToken
If your initial ListEndpointsForDomain
operation returns a nextToken
, you can include
the returned nextToken
in subsequent ListEndpointsForDomain
operations, which returns
results in the next page.
List<E> vpcEndpointSummaryList
Information about each endpoint associated with the domain.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
String nextToken
If your initial ListVpcEndpoints
operation returns a nextToken
, you can include the
returned nextToken
in subsequent ListVpcEndpoints
operations, which returns results in
the next page.
List<E> vpcEndpointSummaryList
Information about each endpoint.
String nextToken
When nextToken
is returned, there are more results available. The value of nextToken
is
a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
Map<K,V> options
The log publishing options configured for the domain.
OptionStatus status
The status of the log publishing options for the domain.
String masterUserARN
Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled
is
false
.
String masterUserName
User name for the master user. Only specify if InternalUserDatabaseEnabled
is true
.
String masterUserPassword
Password for the master user. Only specify if InternalUserDatabaseEnabled
is true
.
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 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
The state of the entity.
Boolean pendingDeletion
Indicates whether the entity is being deleted.
DomainInformationContainer localDomainInfo
Information about the source (local) domain.
DomainInformationContainer remoteDomainInfo
Information about the destination (remote) domain.
String connectionId
Unique identifier of the connection.
String connectionAlias
Name of the connection.
OutboundConnectionStatus connectionStatus
Status of the connection.
String statusCode
The status code for the outbound connection. Can be one of the following:
VALIDATING - The outbound connection request is being validated.
VALIDATION_FAILED - Validation failed for the connection request.
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
PROVISIONING - Outbound connection request is in process.
ACTIVE - Outbound connection is active and ready to use.
REJECTING - Outbound connection rejection by remote domain owner is in progress.
REJECTED - Outbound connection request is rejected by remote domain owner.
DELETING - Outbound connection deletion is in progress.
DELETED - Outbound connection is deleted and can no longer be used.
String message
Verbose information for the outbound connection.
String packageID
The unique identifier of the package.
String packageName
User-specified name of the package.
String packageType
The type of package.
String packageDescription
User-specified description of the package.
String packageStatus
Current status of the package.
Date createdAt
The timestamp when the package was created.
Date lastUpdatedAt
Date and time when the package was last updated.
String availablePackageVersion
The package version.
ErrorDetails errorDetails
Additional information if the package is in an error state. Null otherwise.
String connectionId
The unique identifier of the inbound connection to reject.
InboundConnection connection
Contains details about the rejected inbound connection.
String reservationName
The customer-specified identifier to track this reservation.
String reservedInstanceId
The unique identifier for the reservation.
Long billingSubscriptionId
The unique identifier of the billing subscription.
String reservedInstanceOfferingId
The unique identifier of the Reserved Instance offering.
String instanceType
The OpenSearch instance type offered by theReserved Instance offering.
Date startTime
The date and time when the reservation was purchased.
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 Instance offering.
Double usagePrice
The hourly rate at which you're charged for the domain using this Reserved Instance.
String currencyCode
The currency code for the offering.
Integer instanceCount
The number of OpenSearch instances that have been reserved.
String state
The state of the Reserved Instance.
String paymentOption
The payment option as defined in the Reserved Instance offering.
List<E> recurringCharges
The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
String reservedInstanceOfferingId
The unique identifier of the Reserved Instance offering.
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 Instance offering.
Double usagePrice
The hourly rate at which you're charged for the domain using this Reserved Instance.
String currencyCode
The currency code for the Reserved Instance offering.
String paymentOption
Payment option for the Reserved Instance offering
List<E> recurringCharges
The recurring charge to your account, regardless of whether you creates any domains using the offering.
Boolean enabled
True to enable SAML authentication for a domain.
SAMLIdp idp
The SAML Identity Provider's information.
String masterUserName
The SAML master user name, which is stored in the domain's internal user database.
String masterBackendRole
The backend role that the SAML master user is mapped to.
String subjectKey
Element of the SAML assertion to use for the user name. 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 date and time when the Auto-Tune action is scheduled for the domain.
String actionType
The type of Auto-Tune action.
String action
A description of the Auto-Tune action.
String severity
The severity of the Auto-Tune action. 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.
String description
A description of the service software update status.
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 the automated update date.
Integer automatedSnapshotStartHour
The time, in UTC format, when OpenSearch 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 options are available:
MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
List<E> limitValues
The limit values.
String key
The tag key. Tag keys must be unique for the domain to which they are attached.
String value
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 that you're updating.
ClusterConfig clusterConfig
Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
EBSOptions eBSOptions
The type and size of the EBS volume to attach to instances in the domain.
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 a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
CognitoOptions cognitoOptions
Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Map<K,V> advancedOptions
Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a
boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you
want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must
disable this property. Default is true.
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies
the percentage of heap space allocated to field data. Default is unbounded.
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean.
Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more
than the permitted number of clauses result in a TooManyClauses
error.
"override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean.
Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to
continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
String accessPolicies
Identity and Access Management (IAM) access policy as a JSON-formatted string.
Map<K,V> logPublishingOptions
Options to publish OpenSearch lots to Amazon CloudWatch Logs.
EncryptionAtRestOptions encryptionAtRestOptions
Encryption at rest options for the domain.
DomainEndpointOptions domainEndpointOptions
Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions
Node-To-Node Encryption options for the domain.
AdvancedSecurityOptionsInput advancedSecurityOptions
Options for fine-grained access control.
AutoTuneOptions autoTuneOptions
Options for Auto-Tune.
Boolean dryRun
This flag, when set to True, specifies whether the UpdateDomain
request should return the results of
validation check without actually applying the change.
DomainConfig domainConfig
The status of the updated domain.
DryRunResults dryRunResults
Results of a dry run performed in an update domain request.
String packageID
The unique identifier for the package.
PackageSource packageSource
Amazon S3 bucket and key for the package.
String packageDescription
A new description of the package.
String commitMessage
Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse
.
PackageDetails packageDetails
Information about a package.
String vpcEndpointId
The unique identifier of the endpoint.
VPCOptions vpcOptions
The security groups and/or subnets to add, remove, or modify.
VpcEndpoint vpcEndpoint
The endpoint to be updated.
String domainName
Name of the OpenSearch Service domain that you want to upgrade.
String targetVersion
OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.
Boolean performCheckOnly
When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
Map<K,V> advancedOptions
Only supports the override_main_response_version
parameter and not other advanced options. You can
only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its
version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.
String upgradeId
The unique identifier of the domain upgrade.
String domainName
The name of the domain that was upgraded.
String targetVersion
OpenSearch or Elasticsearch version that the domain was upgraded to.
Boolean performCheckOnly
When true, indicates that an upgrade eligibility check was performed.
Map<K,V> advancedOptions
The advanced options configuration for the domain.
ChangeProgressDetails changeProgressDetails
Container for information about a configuration change happening on a domain.
String upgradeName
A string that describes the upgrade.
Date startTimestamp
UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ
.
String upgradeStatus
The current status of the upgrade. The status can take one of the following values:
In Progress
Succeeded
Succeeded with Issues
Failed
List<E> stepsList
A list of each step performed as part of a specific upgrade or upgrade eligibility check.
String upgradeStep
One of three steps that an upgrade or upgrade eligibility check goes through:
PreUpgradeCheck
Snapshot
Upgrade
String upgradeStepStatus
The current status of the upgrade. The status can take one of the following values:
In Progress
Succeeded
Succeeded with Issues
Failed
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 or Elasticsearch version for the specified domain.
OptionStatus status
The status of the version options for the specified domain.
String vPCId
The ID for your VPC. Amazon VPC generates this value when you create a VPC.
List<E> subnetIds
A list of subnet IDs associated with the VPC endpoints for the domain.
List<E> availabilityZones
The list of Availability Zones associated with the VPC subnets.
List<E> securityGroupIds
The list of security group IDs associated with the VPC endpoints for the domain.
VPCDerivedInfo options
The VPC options for the specified domain.
OptionStatus status
The status of the VPC options for the specified domain.
String vpcEndpointId
The unique identifier of the endpoint.
String vpcEndpointOwner
The creator of the endpoint.
String domainArn
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
VPCDerivedInfo vpcOptions
Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
String status
The current status of the endpoint.
String endpoint
The connection endpoint ID for connecting to the domain.
String vpcEndpointId
The unique identifier of the endpoint.
String vpcEndpointOwner
The creator of the endpoint.
String domainArn
The Amazon Resource Name (ARN) of the domain associated with the endpoint.
String status
The current status of the endpoint.
List<E> subnetIds
A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.
List<E> securityGroupIds
The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.
Integer availabilityZoneCount
If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use.
Valid values are 2
and 3
. If your domain is provisioned within a VPC, this value be
equal to number of subnets.
Copyright © 2023. All rights reserved.