Module aws_sdk_elasticsearch::types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that Amazon Elasticsearch Service can respond with.

Structs

• AccessPoliciesStatus

  The configured access rules for the domain's document and search endpoints, and the current status of those rules.

• AdditionalLimit

  List of limits that are specific to a given InstanceType and for each of it's InstanceRole .

• AdvancedOptionsStatus

  Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

  • 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.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

  For more information, see Configuring Advanced Options.

• AdvancedSecurityOptions

  Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

• AdvancedSecurityOptionsInput

  Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

• AdvancedSecurityOptionsStatus

  Specifies the status of advanced security options for the specified Elasticsearch domain.

• AuthorizedPrincipal

  Information about an account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

• AutoTune

  Specifies Auto-Tune type and Auto-Tune action details.

• AutoTuneDetails

  Specifies details of the Auto-Tune action. See the Developer Guide for more information.

• AutoTuneMaintenanceSchedule

  Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.

• AutoTuneOptions

  Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

• AutoTuneOptionsInput

  Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

• AutoTuneOptionsOutput

  Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

• AutoTuneOptionsStatus

  Specifies the status of Auto-Tune options for the specified Elasticsearch domain.

• AutoTuneStatus

  Provides the current status of the Auto-Tune options.

• CancelledChangeProperty

  A property change that was cancelled for an Amazon OpenSearch Service domain.

• ChangeProgressDetails

  Specifies change details of the domain configuration change.

• ChangeProgressStage

  A progress stage details of a specific domain configuration change.

• ChangeProgressStatusDetails

  The progress details of a specific domain configuration change.

• CognitoOptions

  Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

• CognitoOptionsStatus

  Status of the Cognito options for the specified Elasticsearch domain.

• ColdStorageOptions

  Specifies the configuration for cold storage options such as enabled

• CompatibleVersionsMap

  A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.

• DescribePackagesFilter

  Filter to apply in DescribePackage response.

• DomainEndpointOptions

  Options to configure endpoint for the Elasticsearch domain.

• DomainEndpointOptionsStatus

  The configured endpoint options for the domain and their current status.

• DomainInfo
• DomainInformation
• DomainPackageDetails

  Information on a package that is associated with a domain.

• DryRunResults
• Duration

  Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

• EbsOptions

  Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

• EbsOptionsStatus

  Status of the EBS options for the specified Elasticsearch domain.

• ElasticsearchClusterConfig

  Specifies the configuration for the domain cluster, such as the type and number of instances.

• ElasticsearchClusterConfigStatus

  Specifies the configuration status for the specified Elasticsearch domain.

• ElasticsearchDomainConfig

  The configuration of an Elasticsearch domain.

• ElasticsearchDomainStatus

  The current status of an Elasticsearch domain.

• ElasticsearchVersionStatus

  Status of the Elasticsearch version options for the specified Elasticsearch domain.

• EncryptionAtRestOptions

  Specifies the Encryption At Rest Options.

• EncryptionAtRestOptionsStatus

  Status of the Encryption At Rest options for the specified Elasticsearch domain.

• ErrorDetails
• Filter

  A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.

• InboundCrossClusterSearchConnection

  Specifies details of an inbound connection.

• InboundCrossClusterSearchConnectionStatus

  Specifies the coonection status of an inbound cross-cluster search connection.

• InstanceCountLimits

  InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

• InstanceLimits

  InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

• Limits

  Limits for given InstanceType and for each of it's role.
  
  Limits contains following StorageTypes, InstanceLimits and AdditionalLimits

• LogPublishingOption

  Log Publishing option that is set for given domain.
  
  Attributes and their details:

  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
  • Enabled: Whether the log publishing for given log type is enabled or not

• LogPublishingOptionsStatus

  The configured log publishing options for the domain and their current status.

• MasterUserOptions

  Credentials for the master user: username and password, ARN, or both.

• ModifyingProperties

  Information about the domain properties that are currently being modified.

• NodeToNodeEncryptionOptions

  Specifies the node-to-node encryption options.

• NodeToNodeEncryptionOptionsStatus

  Status of the node-to-node encryption options for the specified Elasticsearch domain.

• OptionStatus

  Provides the current status of the entity.

• OutboundCrossClusterSearchConnection

  Specifies details of an outbound connection.

• OutboundCrossClusterSearchConnectionStatus

  Specifies the connection status of an outbound cross-cluster search connection.

• PackageDetails

  Basic information about a package.

• PackageSource

  The S3 location for importing the package specified as S3BucketName and S3Key

• PackageVersionHistory

  Details of a package version.

• RecurringCharge

  Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

• ReservedElasticsearchInstance

  Details of a reserved Elasticsearch instance.

• ReservedElasticsearchInstanceOffering

  Details of a reserved Elasticsearch instance offering.

• SamlIdp

  Specifies the SAML Identity Provider's information.

• SamlOptionsInput

  Specifies the SAML application configuration for the domain.

• SamlOptionsOutput

  Describes the SAML application configured for the domain.

• ScheduledAutoTuneDetails

  Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.

• ServiceSoftwareOptions

  The current options of an Elasticsearch domain service software options.

• SnapshotOptions

  Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

• SnapshotOptionsStatus

  Status of a daily automated snapshot.

• StorageType

  StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.

• StorageTypeLimit

  Limits that are applicable for given storage type.

• Tag

  Specifies a key value pair for a resource tag.

• UpgradeHistory

  History of the last 10 Upgrades and Upgrade Eligibility Checks.

• UpgradeStepItem

  Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

• VpcDerivedInfo

  Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

• VpcDerivedInfoStatus

  Status of the VPC options for the specified Elasticsearch domain.

• VpcEndpoint

  The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.

• VpcEndpointError

  Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.

• VpcEndpointSummary

  Summary information for an Amazon OpenSearch Service-managed VPC endpoint.

• VpcOptions

  Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

• ZoneAwarenessConfig

  Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

Enums

• AutoTuneDesiredState
  When writing a match expression against AutoTuneDesiredState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AutoTuneState
  When writing a match expression against AutoTuneState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AutoTuneType
  When writing a match expression against AutoTuneType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ConfigChangeStatus
  When writing a match expression against ConfigChangeStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeploymentStatus
  When writing a match expression against DeploymentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DescribePackagesFilterName
  When writing a match expression against DescribePackagesFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DomainPackageStatus
  When writing a match expression against DomainPackageStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DomainProcessingStatusType
  When writing a match expression against DomainProcessingStatusType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EngineType
  When writing a match expression against EngineType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EsPartitionInstanceType
  When writing a match expression against EsPartitionInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EsWarmPartitionInstanceType
  When writing a match expression against EsWarmPartitionInstanceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• InboundCrossClusterSearchConnectionStatusCode
  When writing a match expression against InboundCrossClusterSearchConnectionStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• InitiatedBy
  When writing a match expression against InitiatedBy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• LogType
  When writing a match expression against LogType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• OptionState
  When writing a match expression against OptionState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• OutboundCrossClusterSearchConnectionStatusCode
  When writing a match expression against OutboundCrossClusterSearchConnectionStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• OverallChangeStatus
  When writing a match expression against OverallChangeStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PackageStatus
  When writing a match expression against PackageStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PackageType
  When writing a match expression against PackageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PrincipalType
  When writing a match expression against PrincipalType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PropertyValueType
  When writing a match expression against PropertyValueType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ReservedElasticsearchInstancePaymentOption
  When writing a match expression against ReservedElasticsearchInstancePaymentOption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RollbackOnDisable
  When writing a match expression against RollbackOnDisable, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ScheduledAutoTuneActionType
  When writing a match expression against ScheduledAutoTuneActionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ScheduledAutoTuneSeverityType
  When writing a match expression against ScheduledAutoTuneSeverityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• TimeUnit
  When writing a match expression against TimeUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• TlsSecurityPolicy
  When writing a match expression against TlsSecurityPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• UpgradeStatus
  When writing a match expression against UpgradeStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• UpgradeStep
  When writing a match expression against UpgradeStep, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• VolumeType
  When writing a match expression against VolumeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• VpcEndpointErrorCode
  When writing a match expression against VpcEndpointErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• VpcEndpointStatus
  When writing a match expression against VpcEndpointStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.