Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.OpenSearch.Types.ClusterConfig

Description

Synopsis

Documentation

data ClusterConfig Source #

Container for the cluster configuration of an OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

See: newClusterConfig smart constructor.

Constructors

ClusterConfig'

Fields

coldStorageOptions :: Maybe ColdStorageOptions
Container for cold storage configuration options.
dedicatedMasterCount :: Maybe Int
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
dedicatedMasterEnabled :: Maybe Bool
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.
dedicatedMasterType :: Maybe OpenSearchPartitionInstanceType
OpenSearch Service instance type of the dedicated master nodes in the cluster.
instanceCount :: Maybe Int
Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
instanceType :: Maybe OpenSearchPartitionInstanceType
Instance type of data nodes in the cluster.
warmCount :: Maybe Int
The number of warm nodes in the cluster.
warmEnabled :: Maybe Bool
Whether to enable warm storage for the cluster.
warmType :: Maybe OpenSearchWarmPartitionInstanceType
The instance type for the cluster's warm nodes.
zoneAwarenessConfig :: Maybe ZoneAwarenessConfig
Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.
zoneAwarenessEnabled :: Maybe Bool
Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

Instances

Instances details

FromJSON ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig Methods parseJSON :: Value -> Parser ClusterConfig # parseJSONList :: Value -> Parser [ClusterConfig] #
ToJSON ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig Methods toJSON :: ClusterConfig -> Value # toEncoding :: ClusterConfig -> Encoding # toJSONList :: [ClusterConfig] -> Value # toEncodingList :: [ClusterConfig] -> Encoding #
Generic ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig Associated Types type Rep ClusterConfig :: Type -> Type # Methods from :: ClusterConfig -> Rep ClusterConfig x # to :: Rep ClusterConfig x -> ClusterConfig #
Read ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig Methods readsPrec :: Int -> ReadS ClusterConfig # readList :: ReadS [ClusterConfig] # readPrec :: ReadPrec ClusterConfig # readListPrec :: ReadPrec [ClusterConfig] #
Show ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig Methods showsPrec :: Int -> ClusterConfig -> ShowS # show :: ClusterConfig -> String # showList :: [ClusterConfig] -> ShowS #
NFData ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig Methods rnf :: ClusterConfig -> () #
Eq ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig Methods (==) :: ClusterConfig -> ClusterConfig -> Bool # (/=) :: ClusterConfig -> ClusterConfig -> Bool #
Hashable ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig Methods hashWithSalt :: Int -> ClusterConfig -> Int # hash :: ClusterConfig -> Int #
type Rep ClusterConfig Source #
Instance details Defined in Amazonka.OpenSearch.Types.ClusterConfig type Rep ClusterConfig = D1 ('MetaData "ClusterConfig" "Amazonka.OpenSearch.Types.ClusterConfig" "amazonka-opensearch-2.0-GNoaWlqGXH04P8GBIHM78L" 'False) (C1 ('MetaCons "ClusterConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "coldStorageOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ColdStorageOptions)) :: S1 ('MetaSel ('Just "dedicatedMasterCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "dedicatedMasterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "dedicatedMasterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenSearchPartitionInstanceType)) :: S1 ('MetaSel ('Just "instanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))) :: ((S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenSearchPartitionInstanceType)) :: (S1 ('MetaSel ('Just "warmCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "warmEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "warmType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OpenSearchWarmPartitionInstanceType)) :: (S1 ('MetaSel ('Just "zoneAwarenessConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ZoneAwarenessConfig)) :: S1 ('MetaSel ('Just "zoneAwarenessEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))))

newClusterConfig :: ClusterConfig Source #

Create a value of ClusterConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:coldStorageOptions:ClusterConfig', clusterConfig_coldStorageOptions - Container for cold storage configuration options.

$sel:dedicatedMasterCount:ClusterConfig', clusterConfig_dedicatedMasterCount - Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

$sel:dedicatedMasterEnabled:ClusterConfig', clusterConfig_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.

$sel:dedicatedMasterType:ClusterConfig', clusterConfig_dedicatedMasterType - OpenSearch Service instance type of the dedicated master nodes in the cluster.

$sel:instanceCount:ClusterConfig', clusterConfig_instanceCount - Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

$sel:instanceType:ClusterConfig', clusterConfig_instanceType - Instance type of data nodes in the cluster.

$sel:warmCount:ClusterConfig', clusterConfig_warmCount - The number of warm nodes in the cluster.

$sel:warmEnabled:ClusterConfig', clusterConfig_warmEnabled - Whether to enable warm storage for the cluster.

$sel:warmType:ClusterConfig', clusterConfig_warmType - The instance type for the cluster's warm nodes.

$sel:zoneAwarenessConfig:ClusterConfig', clusterConfig_zoneAwarenessConfig - Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

$sel:zoneAwarenessEnabled:ClusterConfig', clusterConfig_zoneAwarenessEnabled - Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

clusterConfig_coldStorageOptions :: Lens' ClusterConfig (Maybe ColdStorageOptions) Source #

Container for cold storage configuration options.

clusterConfig_dedicatedMasterCount :: Lens' ClusterConfig (Maybe Int) Source #

Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

clusterConfig_dedicatedMasterEnabled :: Lens' ClusterConfig (Maybe Bool) Source #

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.

clusterConfig_dedicatedMasterType :: Lens' ClusterConfig (Maybe OpenSearchPartitionInstanceType) Source #

OpenSearch Service instance type of the dedicated master nodes in the cluster.

clusterConfig_instanceCount :: Lens' ClusterConfig (Maybe Int) Source #

Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

clusterConfig_instanceType :: Lens' ClusterConfig (Maybe OpenSearchPartitionInstanceType) Source #

Instance type of data nodes in the cluster.

clusterConfig_warmCount :: Lens' ClusterConfig (Maybe Int) Source #

The number of warm nodes in the cluster.

clusterConfig_warmEnabled :: Lens' ClusterConfig (Maybe Bool) Source #

Whether to enable warm storage for the cluster.

clusterConfig_warmType :: Lens' ClusterConfig (Maybe OpenSearchWarmPartitionInstanceType) Source #

The instance type for the cluster's warm nodes.

clusterConfig_zoneAwarenessConfig :: Lens' ClusterConfig (Maybe ZoneAwarenessConfig) Source #

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

clusterConfig_zoneAwarenessEnabled :: Lens' ClusterConfig (Maybe Bool) Source #

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.