Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateElasticsearchDomain
- RemoveTags
- DescribeElasticsearchDomains
- ListElasticsearchInstanceTypes
- DeleteElasticsearchServiceRole
- DescribeElasticsearchDomain
- ListDomainNames
- DescribeElasticsearchInstanceTypeLimits
- DescribeElasticsearchDomainConfig
- DeleteElasticsearchDomain
- UpdateElasticsearchDomainConfig
- ListElasticsearchVersions
- AddTags
- ListTags
- Types
- ESPartitionInstanceType
- LogType
- OptionState
- VolumeType
- AccessPoliciesStatus
- AdditionalLimit
- AdvancedOptionsStatus
- DomainInfo
- EBSOptions
- EBSOptionsStatus
- ElasticsearchClusterConfig
- ElasticsearchClusterConfigStatus
- ElasticsearchDomainConfig
- ElasticsearchDomainStatus
- ElasticsearchVersionStatus
- InstanceCountLimits
- InstanceLimits
- Limits
- LogPublishingOption
- LogPublishingOptionsStatus
- OptionStatus
- SnapshotOptions
- SnapshotOptionsStatus
- StorageType
- StorageTypeLimit
- Tag
- VPCDerivedInfo
- VPCDerivedInfoStatus
- VPCOptions
Amazon Elasticsearch Configuration Service
Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.
The endpoint for configuration service requests is region-specific: es.region .amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints .
- elasticSearch :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _BaseException :: AsError a => Getting (First ServiceError) a ServiceError
- _DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.ElasticSearch.CreateElasticsearchDomain
- module Network.AWS.ElasticSearch.RemoveTags
- module Network.AWS.ElasticSearch.DescribeElasticsearchDomains
- module Network.AWS.ElasticSearch.ListElasticsearchInstanceTypes
- module Network.AWS.ElasticSearch.DeleteElasticsearchServiceRole
- module Network.AWS.ElasticSearch.DescribeElasticsearchDomain
- module Network.AWS.ElasticSearch.ListDomainNames
- module Network.AWS.ElasticSearch.DescribeElasticsearchInstanceTypeLimits
- module Network.AWS.ElasticSearch.DescribeElasticsearchDomainConfig
- module Network.AWS.ElasticSearch.DeleteElasticsearchDomain
- module Network.AWS.ElasticSearch.UpdateElasticsearchDomainConfig
- module Network.AWS.ElasticSearch.ListElasticsearchVersions
- module Network.AWS.ElasticSearch.AddTags
- module Network.AWS.ElasticSearch.ListTags
- data ESPartitionInstanceType
- = C4_2XLarge_Elasticsearch
- | C4_4XLarge_Elasticsearch
- | C4_8XLarge_Elasticsearch
- | C4_Large_Elasticsearch
- | C4_XLarge_Elasticsearch
- | D2_2XLarge_Elasticsearch
- | D2_4XLarge_Elasticsearch
- | D2_8XLarge_Elasticsearch
- | D2_XLarge_Elasticsearch
- | I2_2XLarge_Elasticsearch
- | I2_XLarge_Elasticsearch
- | I3_16XLarge_Elasticsearch
- | I3_2XLarge_Elasticsearch
- | I3_4XLarge_Elasticsearch
- | I3_8XLarge_Elasticsearch
- | I3_Large_Elasticsearch
- | I3_XLarge_Elasticsearch
- | M3_2XLarge_Elasticsearch
- | M3_Large_Elasticsearch
- | M3_Medium_Elasticsearch
- | M3_XLarge_Elasticsearch
- | M4_10XLarge_Elasticsearch
- | M4_2XLarge_Elasticsearch
- | M4_4XLarge_Elasticsearch
- | M4_Large_Elasticsearch
- | M4_XLarge_Elasticsearch
- | R3_2XLarge_Elasticsearch
- | R3_4XLarge_Elasticsearch
- | R3_8XLarge_Elasticsearch
- | R3_Large_Elasticsearch
- | R3_XLarge_Elasticsearch
- | R4_16XLarge_Elasticsearch
- | R4_2XLarge_Elasticsearch
- | R4_4XLarge_Elasticsearch
- | R4_8XLarge_Elasticsearch
- | R4_Large_Elasticsearch
- | R4_XLarge_Elasticsearch
- | T2_Medium_Elasticsearch
- | T2_Micro_Elasticsearch
- | T2_Small_Elasticsearch
- data LogType
- data OptionState
- data VolumeType
- data AccessPoliciesStatus
- accessPoliciesStatus :: Text -> OptionStatus -> AccessPoliciesStatus
- apsOptions :: Lens' AccessPoliciesStatus Text
- apsStatus :: Lens' AccessPoliciesStatus OptionStatus
- data AdditionalLimit
- additionalLimit :: AdditionalLimit
- alLimitName :: Lens' AdditionalLimit (Maybe Text)
- alLimitValues :: Lens' AdditionalLimit [Text]
- data AdvancedOptionsStatus
- advancedOptionsStatus :: OptionStatus -> AdvancedOptionsStatus
- aosOptions :: Lens' AdvancedOptionsStatus (HashMap Text Text)
- aosStatus :: Lens' AdvancedOptionsStatus OptionStatus
- data DomainInfo
- domainInfo :: DomainInfo
- diDomainName :: Lens' DomainInfo (Maybe Text)
- data EBSOptions
- ebsOptions :: EBSOptions
- eoVolumeSize :: Lens' EBSOptions (Maybe Int)
- eoIOPS :: Lens' EBSOptions (Maybe Int)
- eoVolumeType :: Lens' EBSOptions (Maybe VolumeType)
- eoEBSEnabled :: Lens' EBSOptions (Maybe Bool)
- data EBSOptionsStatus
- ebsOptionsStatus :: EBSOptions -> OptionStatus -> EBSOptionsStatus
- eosOptions :: Lens' EBSOptionsStatus EBSOptions
- eosStatus :: Lens' EBSOptionsStatus OptionStatus
- data ElasticsearchClusterConfig
- elasticsearchClusterConfig :: ElasticsearchClusterConfig
- eccDedicatedMasterCount :: Lens' ElasticsearchClusterConfig (Maybe Int)
- eccDedicatedMasterType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType)
- eccDedicatedMasterEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool)
- eccInstanceCount :: Lens' ElasticsearchClusterConfig (Maybe Int)
- eccZoneAwarenessEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool)
- eccInstanceType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType)
- data ElasticsearchClusterConfigStatus
- elasticsearchClusterConfigStatus :: ElasticsearchClusterConfig -> OptionStatus -> ElasticsearchClusterConfigStatus
- eccsOptions :: Lens' ElasticsearchClusterConfigStatus ElasticsearchClusterConfig
- eccsStatus :: Lens' ElasticsearchClusterConfigStatus OptionStatus
- data ElasticsearchDomainConfig
- elasticsearchDomainConfig :: ElasticsearchDomainConfig
- edcEBSOptions :: Lens' ElasticsearchDomainConfig (Maybe EBSOptionsStatus)
- edcAccessPolicies :: Lens' ElasticsearchDomainConfig (Maybe AccessPoliciesStatus)
- edcLogPublishingOptions :: Lens' ElasticsearchDomainConfig (Maybe LogPublishingOptionsStatus)
- edcElasticsearchClusterConfig :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchClusterConfigStatus)
- edcSnapshotOptions :: Lens' ElasticsearchDomainConfig (Maybe SnapshotOptionsStatus)
- edcVPCOptions :: Lens' ElasticsearchDomainConfig (Maybe VPCDerivedInfoStatus)
- edcAdvancedOptions :: Lens' ElasticsearchDomainConfig (Maybe AdvancedOptionsStatus)
- edcElasticsearchVersion :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchVersionStatus)
- data ElasticsearchDomainStatus
- elasticsearchDomainStatus :: Text -> Text -> Text -> ElasticsearchClusterConfig -> ElasticsearchDomainStatus
- edsEBSOptions :: Lens' ElasticsearchDomainStatus (Maybe EBSOptions)
- edsAccessPolicies :: Lens' ElasticsearchDomainStatus (Maybe Text)
- edsLogPublishingOptions :: Lens' ElasticsearchDomainStatus (HashMap LogType LogPublishingOption)
- edsCreated :: Lens' ElasticsearchDomainStatus (Maybe Bool)
- edsSnapshotOptions :: Lens' ElasticsearchDomainStatus (Maybe SnapshotOptions)
- edsDeleted :: Lens' ElasticsearchDomainStatus (Maybe Bool)
- edsVPCOptions :: Lens' ElasticsearchDomainStatus (Maybe VPCDerivedInfo)
- edsEndpoints :: Lens' ElasticsearchDomainStatus (HashMap Text Text)
- edsProcessing :: Lens' ElasticsearchDomainStatus (Maybe Bool)
- edsEndpoint :: Lens' ElasticsearchDomainStatus (Maybe Text)
- edsAdvancedOptions :: Lens' ElasticsearchDomainStatus (HashMap Text Text)
- edsElasticsearchVersion :: Lens' ElasticsearchDomainStatus (Maybe Text)
- edsDomainId :: Lens' ElasticsearchDomainStatus Text
- edsDomainName :: Lens' ElasticsearchDomainStatus Text
- edsARN :: Lens' ElasticsearchDomainStatus Text
- edsElasticsearchClusterConfig :: Lens' ElasticsearchDomainStatus ElasticsearchClusterConfig
- data ElasticsearchVersionStatus
- elasticsearchVersionStatus :: Text -> OptionStatus -> ElasticsearchVersionStatus
- evsOptions :: Lens' ElasticsearchVersionStatus Text
- evsStatus :: Lens' ElasticsearchVersionStatus OptionStatus
- data InstanceCountLimits
- instanceCountLimits :: InstanceCountLimits
- iclMaximumInstanceCount :: Lens' InstanceCountLimits (Maybe Int)
- iclMinimumInstanceCount :: Lens' InstanceCountLimits (Maybe Int)
- data InstanceLimits
- instanceLimits :: InstanceLimits
- ilInstanceCountLimits :: Lens' InstanceLimits (Maybe InstanceCountLimits)
- data Limits
- limits :: Limits
- lInstanceLimits :: Lens' Limits (Maybe InstanceLimits)
- lAdditionalLimits :: Lens' Limits [AdditionalLimit]
- lStorageTypes :: Lens' Limits [StorageType]
- data LogPublishingOption
- logPublishingOption :: LogPublishingOption
- lpoEnabled :: Lens' LogPublishingOption (Maybe Bool)
- lpoCloudWatchLogsLogGroupARN :: Lens' LogPublishingOption (Maybe Text)
- data LogPublishingOptionsStatus
- logPublishingOptionsStatus :: LogPublishingOptionsStatus
- lposStatus :: Lens' LogPublishingOptionsStatus (Maybe OptionStatus)
- lposOptions :: Lens' LogPublishingOptionsStatus (HashMap LogType LogPublishingOption)
- data OptionStatus
- optionStatus :: UTCTime -> UTCTime -> OptionState -> OptionStatus
- osPendingDeletion :: Lens' OptionStatus (Maybe Bool)
- osUpdateVersion :: Lens' OptionStatus (Maybe Natural)
- osCreationDate :: Lens' OptionStatus UTCTime
- osUpdateDate :: Lens' OptionStatus UTCTime
- osState :: Lens' OptionStatus OptionState
- data SnapshotOptions
- snapshotOptions :: SnapshotOptions
- soAutomatedSnapshotStartHour :: Lens' SnapshotOptions (Maybe Int)
- data SnapshotOptionsStatus
- snapshotOptionsStatus :: SnapshotOptions -> OptionStatus -> SnapshotOptionsStatus
- sosOptions :: Lens' SnapshotOptionsStatus SnapshotOptions
- sosStatus :: Lens' SnapshotOptionsStatus OptionStatus
- data StorageType
- storageType :: StorageType
- stStorageTypeLimits :: Lens' StorageType [StorageTypeLimit]
- stStorageSubTypeName :: Lens' StorageType (Maybe Text)
- stStorageTypeName :: Lens' StorageType (Maybe Text)
- data StorageTypeLimit
- storageTypeLimit :: StorageTypeLimit
- stlLimitName :: Lens' StorageTypeLimit (Maybe Text)
- stlLimitValues :: Lens' StorageTypeLimit [Text]
- data Tag
- tag :: Text -> Text -> Tag
- tagKey :: Lens' Tag Text
- tagValue :: Lens' Tag Text
- data VPCDerivedInfo
- vpcDerivedInfo :: VPCDerivedInfo
- vdiSecurityGroupIds :: Lens' VPCDerivedInfo [Text]
- vdiSubnetIds :: Lens' VPCDerivedInfo [Text]
- vdiVPCId :: Lens' VPCDerivedInfo (Maybe Text)
- vdiAvailabilityZones :: Lens' VPCDerivedInfo [Text]
- data VPCDerivedInfoStatus
- vpcDerivedInfoStatus :: VPCDerivedInfo -> OptionStatus -> VPCDerivedInfoStatus
- vdisOptions :: Lens' VPCDerivedInfoStatus VPCDerivedInfo
- vdisStatus :: Lens' VPCDerivedInfoStatus OptionStatus
- data VPCOptions
- vpcOptions :: VPCOptions
- voSecurityGroupIds :: Lens' VPCOptions [Text]
- voSubnetIds :: Lens' VPCOptions [Text]
Service Configuration
elasticSearch :: Service Source #
API version 2015-01-01
of the Amazon Elasticsearch Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ElasticSearch
.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for missing / invalid input fields. Gives http status code of 400.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for creating a resource that already exists. Gives http status code of 400.
BaseException
_BaseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occurred while processing the request.
DisabledOperationException
_DisabledOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
InternalException
_InternalException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
InvalidTypeException
_InvalidTypeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateElasticsearchDomain
RemoveTags
DescribeElasticsearchDomains
ListElasticsearchInstanceTypes
DeleteElasticsearchServiceRole
DescribeElasticsearchDomain
ListDomainNames
DescribeElasticsearchInstanceTypeLimits
DescribeElasticsearchDomainConfig
DeleteElasticsearchDomain
UpdateElasticsearchDomainConfig
ListElasticsearchVersions
AddTags
ListTags
Types
ESPartitionInstanceType
data ESPartitionInstanceType Source #
LogType
Type of Log File, it can be one of the following: * INDEX_SLOW_LOGS: Index slow logs contains insert requests that took more time than configured index query log threshold to execute. * SEARCH_SLOW_LOGS: Search slow logs contains search queries that took more time than configured search query log threshold to execute.
OptionState
data OptionState Source #
The state of a requested change. One of the following:
- Processing: The request change is still in-process. * Active: The request change is processed and deployed to the Elasticsearch domain.
VolumeType
data VolumeType Source #
The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storage for more information.
AccessPoliciesStatus
data AccessPoliciesStatus Source #
The configured access rules for the domain's document and search endpoints, and the current status of those rules.
See: accessPoliciesStatus
smart constructor.
Creates a value of AccessPoliciesStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apsOptions
- The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policies for more information.apsStatus
- The status of the access policy for the Elasticsearch domain. SeeOptionStatus
for the status information that's included.
apsOptions :: Lens' AccessPoliciesStatus Text Source #
The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policies for more information.
apsStatus :: Lens' AccessPoliciesStatus OptionStatus Source #
The status of the access policy for the Elasticsearch domain. See OptionStatus
for the status information that's included.
AdditionalLimit
data AdditionalLimit Source #
List of limits that are specific to a given InstanceType and for each of it's
.InstanceRole
See: additionalLimit
smart constructor.
additionalLimit :: AdditionalLimit Source #
Creates a value of AdditionalLimit
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alLimitName
- Name of Additional Limit is specific to a given InstanceType and for each of it's
etc. Attributes and their details: * MaximumNumberOfDataNodesSupportedThis attribute will be present in Master node only to specify how much data nodes upto which givenInstanceRole
can support as master node. * MaximumNumberOfDataNodesWithoutMasterNodeThis attribute will be present in Data node only to specify how much data nodes of givenESPartitionInstanceType
upto which you don't need any master nodes to govern them.ESPartitionInstanceType
alLimitValues
- Value for given'AdditionalLimit$LimitName'
.
alLimitName :: Lens' AdditionalLimit (Maybe Text) Source #
Name of Additional Limit is specific to a given InstanceType and for each of it's
etc. Attributes and their details: * MaximumNumberOfDataNodesSupportedThis attribute will be present in Master node only to specify how much data nodes upto which given InstanceRole
can support as master node. * MaximumNumberOfDataNodesWithoutMasterNodeThis attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType
upto which you don't need any master nodes to govern them.ESPartitionInstanceType
alLimitValues :: Lens' AdditionalLimit [Text] Source #
Value for given 'AdditionalLimit$LimitName'
.
AdvancedOptionsStatus
data AdvancedOptionsStatus Source #
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 istrue
. 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 .
See: advancedOptionsStatus
smart constructor.
advancedOptionsStatus Source #
Creates a value of AdvancedOptionsStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aosOptions
- Specifies the status of advanced options for the specified Elasticsearch domain.aosStatus
- Specifies the status ofOptionStatus
for advanced options for the specified Elasticsearch domain.
aosOptions :: Lens' AdvancedOptionsStatus (HashMap Text Text) Source #
Specifies the status of advanced options for the specified Elasticsearch domain.
aosStatus :: Lens' AdvancedOptionsStatus OptionStatus Source #
Specifies the status of OptionStatus
for advanced options for the specified Elasticsearch domain.
DomainInfo
data DomainInfo Source #
See: domainInfo
smart constructor.
domainInfo :: DomainInfo Source #
Creates a value of DomainInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
diDomainName
- Specifies theDomainName
.
diDomainName :: Lens' DomainInfo (Maybe Text) Source #
Specifies the DomainName
.
EBSOptions
data EBSOptions Source #
Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage .
See: ebsOptions
smart constructor.
ebsOptions :: EBSOptions Source #
Creates a value of EBSOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eoVolumeSize
- Integer to specify the size of an EBS volume.eoIOPS
- Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).eoVolumeType
- Specifies the volume type for EBS-based storage.eoEBSEnabled
- Specifies whether EBS-based storage is enabled.
eoVolumeSize :: Lens' EBSOptions (Maybe Int) Source #
Integer to specify the size of an EBS volume.
eoIOPS :: Lens' EBSOptions (Maybe Int) Source #
Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
eoVolumeType :: Lens' EBSOptions (Maybe VolumeType) Source #
Specifies the volume type for EBS-based storage.
eoEBSEnabled :: Lens' EBSOptions (Maybe Bool) Source #
Specifies whether EBS-based storage is enabled.
EBSOptionsStatus
data EBSOptionsStatus Source #
Status of the EBS options for the specified Elasticsearch domain.
See: ebsOptionsStatus
smart constructor.
Creates a value of EBSOptionsStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eosOptions
- Specifies the EBS options for the specified Elasticsearch domain.eosStatus
- Specifies the status of the EBS options for the specified Elasticsearch domain.
eosOptions :: Lens' EBSOptionsStatus EBSOptions Source #
Specifies the EBS options for the specified Elasticsearch domain.
eosStatus :: Lens' EBSOptionsStatus OptionStatus Source #
Specifies the status of the EBS options for the specified Elasticsearch domain.
ElasticsearchClusterConfig
data ElasticsearchClusterConfig Source #
Specifies the configuration for the domain cluster, such as the type and number of instances.
See: elasticsearchClusterConfig
smart constructor.
elasticsearchClusterConfig :: ElasticsearchClusterConfig Source #
Creates a value of ElasticsearchClusterConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eccDedicatedMasterCount
- Total number of dedicated master nodes, active and on standby, for the cluster.eccDedicatedMasterType
- The instance type for a dedicated master node.eccDedicatedMasterEnabled
- A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.eccInstanceCount
- The number of instances in the specified domain cluster.eccZoneAwarenessEnabled
- A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.eccInstanceType
- The instance type for an Elasticsearch cluster.
eccDedicatedMasterCount :: Lens' ElasticsearchClusterConfig (Maybe Int) Source #
Total number of dedicated master nodes, active and on standby, for the cluster.
eccDedicatedMasterType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType) Source #
The instance type for a dedicated master node.
eccDedicatedMasterEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool) Source #
A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
eccInstanceCount :: Lens' ElasticsearchClusterConfig (Maybe Int) Source #
The number of instances in the specified domain cluster.
eccZoneAwarenessEnabled :: Lens' ElasticsearchClusterConfig (Maybe Bool) Source #
A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
eccInstanceType :: Lens' ElasticsearchClusterConfig (Maybe ESPartitionInstanceType) Source #
The instance type for an Elasticsearch cluster.
ElasticsearchClusterConfigStatus
data ElasticsearchClusterConfigStatus Source #
Specifies the configuration status for the specified Elasticsearch domain.
See: elasticsearchClusterConfigStatus
smart constructor.
elasticsearchClusterConfigStatus Source #
Creates a value of ElasticsearchClusterConfigStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eccsOptions
- Specifies the cluster configuration for the specified Elasticsearch domain.eccsStatus
- Specifies the status of the configuration for the specified Elasticsearch domain.
eccsOptions :: Lens' ElasticsearchClusterConfigStatus ElasticsearchClusterConfig Source #
Specifies the cluster configuration for the specified Elasticsearch domain.
eccsStatus :: Lens' ElasticsearchClusterConfigStatus OptionStatus Source #
Specifies the status of the configuration for the specified Elasticsearch domain.
ElasticsearchDomainConfig
data ElasticsearchDomainConfig Source #
The configuration of an Elasticsearch domain.
See: elasticsearchDomainConfig
smart constructor.
elasticsearchDomainConfig :: ElasticsearchDomainConfig Source #
Creates a value of ElasticsearchDomainConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edcEBSOptions
- Specifies theEBSOptions
for the Elasticsearch domain.edcAccessPolicies
- IAM access policy as a JSON-formatted string.edcLogPublishingOptions
- Log publishing options for the given domain.edcElasticsearchClusterConfig
- Specifies theElasticsearchClusterConfig
for the Elasticsearch domain.edcSnapshotOptions
- Specifies theSnapshotOptions
for the Elasticsearch domain.edcVPCOptions
- TheVPCOptions
for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .edcAdvancedOptions
- Specifies theAdvancedOptions
for the domain. See Configuring Advanced Options for more information.edcElasticsearchVersion
- String of format X.Y to specify version for the Elasticsearch domain.
edcEBSOptions :: Lens' ElasticsearchDomainConfig (Maybe EBSOptionsStatus) Source #
Specifies the EBSOptions
for the Elasticsearch domain.
edcAccessPolicies :: Lens' ElasticsearchDomainConfig (Maybe AccessPoliciesStatus) Source #
IAM access policy as a JSON-formatted string.
edcLogPublishingOptions :: Lens' ElasticsearchDomainConfig (Maybe LogPublishingOptionsStatus) Source #
Log publishing options for the given domain.
edcElasticsearchClusterConfig :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchClusterConfigStatus) Source #
Specifies the ElasticsearchClusterConfig
for the Elasticsearch domain.
edcSnapshotOptions :: Lens' ElasticsearchDomainConfig (Maybe SnapshotOptionsStatus) Source #
Specifies the SnapshotOptions
for the Elasticsearch domain.
edcVPCOptions :: Lens' ElasticsearchDomainConfig (Maybe VPCDerivedInfoStatus) Source #
The VPCOptions
for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
edcAdvancedOptions :: Lens' ElasticsearchDomainConfig (Maybe AdvancedOptionsStatus) Source #
Specifies the AdvancedOptions
for the domain. See Configuring Advanced Options for more information.
edcElasticsearchVersion :: Lens' ElasticsearchDomainConfig (Maybe ElasticsearchVersionStatus) Source #
String of format X.Y to specify version for the Elasticsearch domain.
ElasticsearchDomainStatus
data ElasticsearchDomainStatus Source #
The current status of an Elasticsearch domain.
See: elasticsearchDomainStatus
smart constructor.
elasticsearchDomainStatus Source #
Creates a value of ElasticsearchDomainStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
edsEBSOptions
- TheEBSOptions
for the specified domain. See Configuring EBS-based Storage for more information.edsAccessPolicies
- IAM access policy as a JSON-formatted string.edsLogPublishingOptions
- Log publishing options for the given domain.edsCreated
- The domain creation status.True
if the creation of an Elasticsearch domain is complete.False
if domain creation is still in progress.edsSnapshotOptions
- Specifies the status of theSnapshotOptions
edsDeleted
- 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.edsVPCOptions
- TheVPCOptions
for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .edsEndpoints
- Map containing the Elasticsearch domain endpoints used to submit index and search requests. Examplekey, value
:
.vpc
,'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'edsProcessing
- The status of the Elasticsearch domain configuration.True
if Amazon Elasticsearch Service is processing configuration changes.False
if the configuration is active.edsEndpoint
- The Elasticsearch domain endpoint that you use to submit index and search requests.edsAdvancedOptions
- Specifies the status of theAdvancedOptions
edsElasticsearchVersion
- Undocumented member.edsDomainId
- The unique identifier for the specified Elasticsearch domain.edsDomainName
- The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).edsARN
- The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.edsElasticsearchClusterConfig
- The type and number of instances in the domain cluster.
edsEBSOptions :: Lens' ElasticsearchDomainStatus (Maybe EBSOptions) Source #
The EBSOptions
for the specified domain. See Configuring EBS-based Storage for more information.
edsAccessPolicies :: Lens' ElasticsearchDomainStatus (Maybe Text) Source #
IAM access policy as a JSON-formatted string.
edsLogPublishingOptions :: Lens' ElasticsearchDomainStatus (HashMap LogType LogPublishingOption) Source #
Log publishing options for the given domain.
edsCreated :: Lens' ElasticsearchDomainStatus (Maybe Bool) Source #
The domain creation status. True
if the creation of an Elasticsearch domain is complete. False
if domain creation is still in progress.
edsSnapshotOptions :: Lens' ElasticsearchDomainStatus (Maybe SnapshotOptions) Source #
Specifies the status of the SnapshotOptions
edsDeleted :: Lens' ElasticsearchDomainStatus (Maybe Bool) Source #
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.
edsVPCOptions :: Lens' ElasticsearchDomainStatus (Maybe VPCDerivedInfo) Source #
The VPCOptions
for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
edsEndpoints :: Lens' ElasticsearchDomainStatus (HashMap Text Text) Source #
Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value
:
.vpc
,'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
edsProcessing :: Lens' ElasticsearchDomainStatus (Maybe Bool) Source #
The status of the Elasticsearch domain configuration. True
if Amazon Elasticsearch Service is processing configuration changes. False
if the configuration is active.
edsEndpoint :: Lens' ElasticsearchDomainStatus (Maybe Text) Source #
The Elasticsearch domain endpoint that you use to submit index and search requests.
edsAdvancedOptions :: Lens' ElasticsearchDomainStatus (HashMap Text Text) Source #
Specifies the status of the AdvancedOptions
edsElasticsearchVersion :: Lens' ElasticsearchDomainStatus (Maybe Text) Source #
Undocumented member.
edsDomainId :: Lens' ElasticsearchDomainStatus Text Source #
The unique identifier for the specified Elasticsearch domain.
edsDomainName :: Lens' ElasticsearchDomainStatus Text Source #
The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
edsARN :: Lens' ElasticsearchDomainStatus Text Source #
The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
edsElasticsearchClusterConfig :: Lens' ElasticsearchDomainStatus ElasticsearchClusterConfig Source #
The type and number of instances in the domain cluster.
ElasticsearchVersionStatus
data ElasticsearchVersionStatus Source #
Status of the Elasticsearch version options for the specified Elasticsearch domain.
See: elasticsearchVersionStatus
smart constructor.
elasticsearchVersionStatus Source #
Creates a value of ElasticsearchVersionStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
evsOptions
- Specifies the Elasticsearch version for the specified Elasticsearch domain.evsStatus
- Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
evsOptions :: Lens' ElasticsearchVersionStatus Text Source #
Specifies the Elasticsearch version for the specified Elasticsearch domain.
evsStatus :: Lens' ElasticsearchVersionStatus OptionStatus Source #
Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
InstanceCountLimits
data InstanceCountLimits Source #
InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
See: instanceCountLimits
smart constructor.
instanceCountLimits :: InstanceCountLimits Source #
Creates a value of InstanceCountLimits
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iclMaximumInstanceCount
- Undocumented member.iclMinimumInstanceCount
- Undocumented member.
iclMaximumInstanceCount :: Lens' InstanceCountLimits (Maybe Int) Source #
Undocumented member.
iclMinimumInstanceCount :: Lens' InstanceCountLimits (Maybe Int) Source #
Undocumented member.
InstanceLimits
data InstanceLimits Source #
InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
See: instanceLimits
smart constructor.
instanceLimits :: InstanceLimits Source #
Creates a value of InstanceLimits
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ilInstanceCountLimits
- Undocumented member.
ilInstanceCountLimits :: Lens' InstanceLimits (Maybe InstanceCountLimits) Source #
Undocumented member.
Limits
Limits for given InstanceType and for each of it's role.
Limits contains following 'StorageTypes,'
and InstanceLimits
AdditionalLimits
See: limits
smart constructor.
Creates a value of Limits
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lInstanceLimits
- Undocumented member.lAdditionalLimits
- List of additional limits that are specific to a given InstanceType and for each of it's
.InstanceRole
lStorageTypes
- StorageType represents the list of storage related types and attributes that are available for given InstanceType.
lInstanceLimits :: Lens' Limits (Maybe InstanceLimits) Source #
Undocumented member.
lAdditionalLimits :: Lens' Limits [AdditionalLimit] Source #
List of additional limits that are specific to a given InstanceType and for each of it's
.InstanceRole
lStorageTypes :: Lens' Limits [StorageType] Source #
StorageType represents the list of storage related types and attributes that are available for given InstanceType.
LogPublishingOption
data LogPublishingOption Source #
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
See: logPublishingOption
smart constructor.
logPublishingOption :: LogPublishingOption Source #
Creates a value of LogPublishingOption
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lpoEnabled
- Specifies whether given log publishing option is enabled or not.lpoCloudWatchLogsLogGroupARN
- Undocumented member.
lpoEnabled :: Lens' LogPublishingOption (Maybe Bool) Source #
Specifies whether given log publishing option is enabled or not.
lpoCloudWatchLogsLogGroupARN :: Lens' LogPublishingOption (Maybe Text) Source #
Undocumented member.
LogPublishingOptionsStatus
data LogPublishingOptionsStatus Source #
The configured log publishing options for the domain and their current status.
See: logPublishingOptionsStatus
smart constructor.
logPublishingOptionsStatus :: LogPublishingOptionsStatus Source #
Creates a value of LogPublishingOptionsStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lposStatus
- The status of the log publishing options for the Elasticsearch domain. SeeOptionStatus
for the status information that's included.lposOptions
- The log publishing options configured for the Elasticsearch domain.
lposStatus :: Lens' LogPublishingOptionsStatus (Maybe OptionStatus) Source #
The status of the log publishing options for the Elasticsearch domain. See OptionStatus
for the status information that's included.
lposOptions :: Lens' LogPublishingOptionsStatus (HashMap LogType LogPublishingOption) Source #
The log publishing options configured for the Elasticsearch domain.
OptionStatus
data OptionStatus Source #
Provides the current status of the entity.
See: optionStatus
smart constructor.
Creates a value of OptionStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osPendingDeletion
- Indicates whether the Elasticsearch domain is being deleted.osUpdateVersion
- Specifies the latest version for the entity.osCreationDate
- Timestamp which tells the creation date for the entity.osUpdateDate
- Timestamp which tells the last updated time for the entity.osState
- Provides theOptionState
for the Elasticsearch domain.
osPendingDeletion :: Lens' OptionStatus (Maybe Bool) Source #
Indicates whether the Elasticsearch domain is being deleted.
osUpdateVersion :: Lens' OptionStatus (Maybe Natural) Source #
Specifies the latest version for the entity.
osCreationDate :: Lens' OptionStatus UTCTime Source #
Timestamp which tells the creation date for the entity.
osUpdateDate :: Lens' OptionStatus UTCTime Source #
Timestamp which tells the last updated time for the entity.
osState :: Lens' OptionStatus OptionState Source #
Provides the OptionState
for the Elasticsearch domain.
SnapshotOptions
data SnapshotOptions Source #
Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0
hours.
See: snapshotOptions
smart constructor.
snapshotOptions :: SnapshotOptions Source #
Creates a value of SnapshotOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
soAutomatedSnapshotStartHour
- Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is0
hours.
soAutomatedSnapshotStartHour :: Lens' SnapshotOptions (Maybe Int) Source #
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
data SnapshotOptionsStatus Source #
Status of a daily automated snapshot.
See: snapshotOptionsStatus
smart constructor.
snapshotOptionsStatus Source #
Creates a value of SnapshotOptionsStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sosOptions
- Specifies the daily snapshot options specified for the Elasticsearch domain.sosStatus
- Specifies the status of a daily automated snapshot.
sosOptions :: Lens' SnapshotOptionsStatus SnapshotOptions Source #
Specifies the daily snapshot options specified for the Elasticsearch domain.
sosStatus :: Lens' SnapshotOptionsStatus OptionStatus Source #
Specifies the status of a daily automated snapshot.
StorageType
data StorageType Source #
StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.
See: storageType
smart constructor.
storageType :: StorageType Source #
Creates a value of StorageType
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stStorageTypeLimits
- List of limits that are applicable for given storage type.stStorageSubTypeName
- Undocumented member.stStorageTypeName
- Undocumented member.
stStorageTypeLimits :: Lens' StorageType [StorageTypeLimit] Source #
List of limits that are applicable for given storage type.
stStorageSubTypeName :: Lens' StorageType (Maybe Text) Source #
Undocumented member.
stStorageTypeName :: Lens' StorageType (Maybe Text) Source #
Undocumented member.
StorageTypeLimit
data StorageTypeLimit Source #
Limits that are applicable for given storage type.
See: storageTypeLimit
smart constructor.
storageTypeLimit :: StorageTypeLimit Source #
Creates a value of StorageTypeLimit
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stlLimitName
- Name of storage limits that are applicable for given storage type. If
is ebs, following storage options are applicable * MinimumVolumeSizeMinimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. * MaximumVolumeSizeMaximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. * MaximumIopsMaximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. * MinimumIopsMinimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.StorageType
stlLimitValues
- Values for the'StorageTypeLimit$LimitName'
.
stlLimitName :: Lens' StorageTypeLimit (Maybe Text) Source #
Name of storage limits that are applicable for given storage type. If
is ebs, following storage options are applicable * MinimumVolumeSizeMinimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. * MaximumVolumeSizeMaximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. * MaximumIopsMaximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. * MinimumIopsMinimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.StorageType
stlLimitValues :: Lens' StorageTypeLimit [Text] Source #
Values for the 'StorageTypeLimit$LimitName'
.
Tag
Specifies a key value pair for a resource tag.
See: tag
smart constructor.
Creates a value of Tag
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tagKey
- Specifies theTagKey
, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.tagValue
- Specifies theTagValue
, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set ofproject : Trinity
andcost-center : Trinity
tagKey :: Lens' Tag Text Source #
Specifies the TagKey
, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.
tagValue :: Lens' Tag Text Source #
Specifies the TagValue
, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity
and cost-center : Trinity
VPCDerivedInfo
data VPCDerivedInfo Source #
Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
See: vpcDerivedInfo
smart constructor.
vpcDerivedInfo :: VPCDerivedInfo Source #
Creates a value of VPCDerivedInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vdiSecurityGroupIds
- Specifies the security groups for VPC endpoint.vdiSubnetIds
- Specifies the subnets for VPC endpoint.vdiVPCId
- The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.vdiAvailabilityZones
- The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
vdiSecurityGroupIds :: Lens' VPCDerivedInfo [Text] Source #
Specifies the security groups for VPC endpoint.
vdiSubnetIds :: Lens' VPCDerivedInfo [Text] Source #
Specifies the subnets for VPC endpoint.
vdiVPCId :: Lens' VPCDerivedInfo (Maybe Text) Source #
The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
vdiAvailabilityZones :: Lens' VPCDerivedInfo [Text] Source #
The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
VPCDerivedInfoStatus
data VPCDerivedInfoStatus Source #
Status of the VPC options for the specified Elasticsearch domain.
See: vpcDerivedInfoStatus
smart constructor.
Creates a value of VPCDerivedInfoStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vdisOptions
- Specifies the VPC options for the specified Elasticsearch domain.vdisStatus
- Specifies the status of the VPC options for the specified Elasticsearch domain.
vdisOptions :: Lens' VPCDerivedInfoStatus VPCDerivedInfo Source #
Specifies the VPC options for the specified Elasticsearch domain.
vdisStatus :: Lens' VPCDerivedInfoStatus OptionStatus Source #
Specifies the status of the VPC options for the specified Elasticsearch domain.
VPCOptions
data VPCOptions Source #
Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains .
See: vpcOptions
smart constructor.
vpcOptions :: VPCOptions Source #
Creates a value of VPCOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
voSecurityGroupIds
- Specifies the security groups for VPC endpoint.voSubnetIds
- Specifies the subnets for VPC endpoint.
voSecurityGroupIds :: Lens' VPCOptions [Text] Source #
Specifies the security groups for VPC endpoint.
voSubnetIds :: Lens' VPCOptions [Text] Source #
Specifies the subnets for VPC endpoint.