amazonka-elasticache-2.0: gen/Amazonka/ElastiCache/Types/ReservedCacheNodesOffering.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.ElastiCache.Types.ReservedCacheNodesOffering
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.ElastiCache.Types.ReservedCacheNodesOffering where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.ElastiCache.Types.RecurringCharge
import qualified Amazonka.Prelude as Prelude
-- | Describes all of the attributes of a reserved cache node offering.
--
-- /See:/ 'newReservedCacheNodesOffering' smart constructor.
data ReservedCacheNodesOffering = ReservedCacheNodesOffering'
{ -- | The cache node type for the reserved cache node.
--
-- The following node types are supported by ElastiCache. Generally
-- speaking, the current generation types provide more memory and
-- computational power at lower cost when compared to their equivalent
-- previous generation counterparts.
--
-- - General purpose:
--
-- - Current generation:
--
-- __M6g node types__ (available only for Redis engine version
-- 5.0.6 onward and for Memcached engine version 1.5.16 onward):
-- @cache.m6g.large@, @cache.m6g.xlarge@, @cache.m6g.2xlarge@,
-- @cache.m6g.4xlarge@, @cache.m6g.8xlarge@, @cache.m6g.12xlarge@,
-- @cache.m6g.16xlarge@
--
-- For region availability, see
-- <https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion Supported Node Types>
--
-- __M5 node types:__ @cache.m5.large@, @cache.m5.xlarge@,
-- @cache.m5.2xlarge@, @cache.m5.4xlarge@, @cache.m5.12xlarge@,
-- @cache.m5.24xlarge@
--
-- __M4 node types:__ @cache.m4.large@, @cache.m4.xlarge@,
-- @cache.m4.2xlarge@, @cache.m4.4xlarge@, @cache.m4.10xlarge@
--
-- __T4g node types__ (available only for Redis engine version
-- 5.0.6 onward and Memcached engine version 1.5.16 onward):
-- @cache.t4g.micro@, @cache.t4g.small@, @cache.t4g.medium@
--
-- __T3 node types:__ @cache.t3.micro@, @cache.t3.small@,
-- @cache.t3.medium@
--
-- __T2 node types:__ @cache.t2.micro@, @cache.t2.small@,
-- @cache.t2.medium@
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __T1 node types:__ @cache.t1.micro@
--
-- __M1 node types:__ @cache.m1.small@, @cache.m1.medium@,
-- @cache.m1.large@, @cache.m1.xlarge@
--
-- __M3 node types:__ @cache.m3.medium@, @cache.m3.large@,
-- @cache.m3.xlarge@, @cache.m3.2xlarge@
--
-- - Compute optimized:
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __C1 node types:__ @cache.c1.xlarge@
--
-- - Memory optimized:
--
-- - Current generation:
--
-- __R6g node types__ (available only for Redis engine version
-- 5.0.6 onward and for Memcached engine version 1.5.16 onward).
--
-- @cache.r6g.large@, @cache.r6g.xlarge@, @cache.r6g.2xlarge@,
-- @cache.r6g.4xlarge@, @cache.r6g.8xlarge@, @cache.r6g.12xlarge@,
-- @cache.r6g.16xlarge@
--
-- For region availability, see
-- <https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion Supported Node Types>
--
-- __R5 node types:__ @cache.r5.large@, @cache.r5.xlarge@,
-- @cache.r5.2xlarge@, @cache.r5.4xlarge@, @cache.r5.12xlarge@,
-- @cache.r5.24xlarge@
--
-- __R4 node types:__ @cache.r4.large@, @cache.r4.xlarge@,
-- @cache.r4.2xlarge@, @cache.r4.4xlarge@, @cache.r4.8xlarge@,
-- @cache.r4.16xlarge@
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __M2 node types:__ @cache.m2.xlarge@, @cache.m2.2xlarge@,
-- @cache.m2.4xlarge@
--
-- __R3 node types:__ @cache.r3.large@, @cache.r3.xlarge@,
-- @cache.r3.2xlarge@, @cache.r3.4xlarge@, @cache.r3.8xlarge@
--
-- __Additional node type info__
--
-- - All current generation instance types are created in Amazon VPC by
-- default.
--
-- - Redis append-only files (AOF) are not supported for T1 or T2
-- instances.
--
-- - Redis Multi-AZ with automatic failover is not supported on T1
-- instances.
--
-- - Redis configuration variables @appendonly@ and @appendfsync@ are not
-- supported on Redis version 2.8.22 and later.
cacheNodeType :: Prelude.Maybe Prelude.Text,
-- | The duration of the offering. in seconds.
duration :: Prelude.Maybe Prelude.Int,
-- | The fixed price charged for this offering.
fixedPrice :: Prelude.Maybe Prelude.Double,
-- | The offering type.
offeringType :: Prelude.Maybe Prelude.Text,
-- | The cache engine used by the offering.
productDescription :: Prelude.Maybe Prelude.Text,
-- | The recurring price charged to run this reserved cache node.
recurringCharges :: Prelude.Maybe [RecurringCharge],
-- | A unique identifier for the reserved cache node offering.
reservedCacheNodesOfferingId :: Prelude.Maybe Prelude.Text,
-- | The hourly price charged for this offering.
usagePrice :: Prelude.Maybe Prelude.Double
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'ReservedCacheNodesOffering' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'cacheNodeType', 'reservedCacheNodesOffering_cacheNodeType' - The cache node type for the reserved cache node.
--
-- The following node types are supported by ElastiCache. Generally
-- speaking, the current generation types provide more memory and
-- computational power at lower cost when compared to their equivalent
-- previous generation counterparts.
--
-- - General purpose:
--
-- - Current generation:
--
-- __M6g node types__ (available only for Redis engine version
-- 5.0.6 onward and for Memcached engine version 1.5.16 onward):
-- @cache.m6g.large@, @cache.m6g.xlarge@, @cache.m6g.2xlarge@,
-- @cache.m6g.4xlarge@, @cache.m6g.8xlarge@, @cache.m6g.12xlarge@,
-- @cache.m6g.16xlarge@
--
-- For region availability, see
-- <https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion Supported Node Types>
--
-- __M5 node types:__ @cache.m5.large@, @cache.m5.xlarge@,
-- @cache.m5.2xlarge@, @cache.m5.4xlarge@, @cache.m5.12xlarge@,
-- @cache.m5.24xlarge@
--
-- __M4 node types:__ @cache.m4.large@, @cache.m4.xlarge@,
-- @cache.m4.2xlarge@, @cache.m4.4xlarge@, @cache.m4.10xlarge@
--
-- __T4g node types__ (available only for Redis engine version
-- 5.0.6 onward and Memcached engine version 1.5.16 onward):
-- @cache.t4g.micro@, @cache.t4g.small@, @cache.t4g.medium@
--
-- __T3 node types:__ @cache.t3.micro@, @cache.t3.small@,
-- @cache.t3.medium@
--
-- __T2 node types:__ @cache.t2.micro@, @cache.t2.small@,
-- @cache.t2.medium@
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __T1 node types:__ @cache.t1.micro@
--
-- __M1 node types:__ @cache.m1.small@, @cache.m1.medium@,
-- @cache.m1.large@, @cache.m1.xlarge@
--
-- __M3 node types:__ @cache.m3.medium@, @cache.m3.large@,
-- @cache.m3.xlarge@, @cache.m3.2xlarge@
--
-- - Compute optimized:
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __C1 node types:__ @cache.c1.xlarge@
--
-- - Memory optimized:
--
-- - Current generation:
--
-- __R6g node types__ (available only for Redis engine version
-- 5.0.6 onward and for Memcached engine version 1.5.16 onward).
--
-- @cache.r6g.large@, @cache.r6g.xlarge@, @cache.r6g.2xlarge@,
-- @cache.r6g.4xlarge@, @cache.r6g.8xlarge@, @cache.r6g.12xlarge@,
-- @cache.r6g.16xlarge@
--
-- For region availability, see
-- <https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion Supported Node Types>
--
-- __R5 node types:__ @cache.r5.large@, @cache.r5.xlarge@,
-- @cache.r5.2xlarge@, @cache.r5.4xlarge@, @cache.r5.12xlarge@,
-- @cache.r5.24xlarge@
--
-- __R4 node types:__ @cache.r4.large@, @cache.r4.xlarge@,
-- @cache.r4.2xlarge@, @cache.r4.4xlarge@, @cache.r4.8xlarge@,
-- @cache.r4.16xlarge@
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __M2 node types:__ @cache.m2.xlarge@, @cache.m2.2xlarge@,
-- @cache.m2.4xlarge@
--
-- __R3 node types:__ @cache.r3.large@, @cache.r3.xlarge@,
-- @cache.r3.2xlarge@, @cache.r3.4xlarge@, @cache.r3.8xlarge@
--
-- __Additional node type info__
--
-- - All current generation instance types are created in Amazon VPC by
-- default.
--
-- - Redis append-only files (AOF) are not supported for T1 or T2
-- instances.
--
-- - Redis Multi-AZ with automatic failover is not supported on T1
-- instances.
--
-- - Redis configuration variables @appendonly@ and @appendfsync@ are not
-- supported on Redis version 2.8.22 and later.
--
-- 'duration', 'reservedCacheNodesOffering_duration' - The duration of the offering. in seconds.
--
-- 'fixedPrice', 'reservedCacheNodesOffering_fixedPrice' - The fixed price charged for this offering.
--
-- 'offeringType', 'reservedCacheNodesOffering_offeringType' - The offering type.
--
-- 'productDescription', 'reservedCacheNodesOffering_productDescription' - The cache engine used by the offering.
--
-- 'recurringCharges', 'reservedCacheNodesOffering_recurringCharges' - The recurring price charged to run this reserved cache node.
--
-- 'reservedCacheNodesOfferingId', 'reservedCacheNodesOffering_reservedCacheNodesOfferingId' - A unique identifier for the reserved cache node offering.
--
-- 'usagePrice', 'reservedCacheNodesOffering_usagePrice' - The hourly price charged for this offering.
newReservedCacheNodesOffering ::
ReservedCacheNodesOffering
newReservedCacheNodesOffering =
ReservedCacheNodesOffering'
{ cacheNodeType =
Prelude.Nothing,
duration = Prelude.Nothing,
fixedPrice = Prelude.Nothing,
offeringType = Prelude.Nothing,
productDescription = Prelude.Nothing,
recurringCharges = Prelude.Nothing,
reservedCacheNodesOfferingId = Prelude.Nothing,
usagePrice = Prelude.Nothing
}
-- | The cache node type for the reserved cache node.
--
-- The following node types are supported by ElastiCache. Generally
-- speaking, the current generation types provide more memory and
-- computational power at lower cost when compared to their equivalent
-- previous generation counterparts.
--
-- - General purpose:
--
-- - Current generation:
--
-- __M6g node types__ (available only for Redis engine version
-- 5.0.6 onward and for Memcached engine version 1.5.16 onward):
-- @cache.m6g.large@, @cache.m6g.xlarge@, @cache.m6g.2xlarge@,
-- @cache.m6g.4xlarge@, @cache.m6g.8xlarge@, @cache.m6g.12xlarge@,
-- @cache.m6g.16xlarge@
--
-- For region availability, see
-- <https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion Supported Node Types>
--
-- __M5 node types:__ @cache.m5.large@, @cache.m5.xlarge@,
-- @cache.m5.2xlarge@, @cache.m5.4xlarge@, @cache.m5.12xlarge@,
-- @cache.m5.24xlarge@
--
-- __M4 node types:__ @cache.m4.large@, @cache.m4.xlarge@,
-- @cache.m4.2xlarge@, @cache.m4.4xlarge@, @cache.m4.10xlarge@
--
-- __T4g node types__ (available only for Redis engine version
-- 5.0.6 onward and Memcached engine version 1.5.16 onward):
-- @cache.t4g.micro@, @cache.t4g.small@, @cache.t4g.medium@
--
-- __T3 node types:__ @cache.t3.micro@, @cache.t3.small@,
-- @cache.t3.medium@
--
-- __T2 node types:__ @cache.t2.micro@, @cache.t2.small@,
-- @cache.t2.medium@
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __T1 node types:__ @cache.t1.micro@
--
-- __M1 node types:__ @cache.m1.small@, @cache.m1.medium@,
-- @cache.m1.large@, @cache.m1.xlarge@
--
-- __M3 node types:__ @cache.m3.medium@, @cache.m3.large@,
-- @cache.m3.xlarge@, @cache.m3.2xlarge@
--
-- - Compute optimized:
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __C1 node types:__ @cache.c1.xlarge@
--
-- - Memory optimized:
--
-- - Current generation:
--
-- __R6g node types__ (available only for Redis engine version
-- 5.0.6 onward and for Memcached engine version 1.5.16 onward).
--
-- @cache.r6g.large@, @cache.r6g.xlarge@, @cache.r6g.2xlarge@,
-- @cache.r6g.4xlarge@, @cache.r6g.8xlarge@, @cache.r6g.12xlarge@,
-- @cache.r6g.16xlarge@
--
-- For region availability, see
-- <https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion Supported Node Types>
--
-- __R5 node types:__ @cache.r5.large@, @cache.r5.xlarge@,
-- @cache.r5.2xlarge@, @cache.r5.4xlarge@, @cache.r5.12xlarge@,
-- @cache.r5.24xlarge@
--
-- __R4 node types:__ @cache.r4.large@, @cache.r4.xlarge@,
-- @cache.r4.2xlarge@, @cache.r4.4xlarge@, @cache.r4.8xlarge@,
-- @cache.r4.16xlarge@
--
-- - Previous generation: (not recommended. Existing clusters are
-- still supported but creation of new clusters is not supported
-- for these types.)
--
-- __M2 node types:__ @cache.m2.xlarge@, @cache.m2.2xlarge@,
-- @cache.m2.4xlarge@
--
-- __R3 node types:__ @cache.r3.large@, @cache.r3.xlarge@,
-- @cache.r3.2xlarge@, @cache.r3.4xlarge@, @cache.r3.8xlarge@
--
-- __Additional node type info__
--
-- - All current generation instance types are created in Amazon VPC by
-- default.
--
-- - Redis append-only files (AOF) are not supported for T1 or T2
-- instances.
--
-- - Redis Multi-AZ with automatic failover is not supported on T1
-- instances.
--
-- - Redis configuration variables @appendonly@ and @appendfsync@ are not
-- supported on Redis version 2.8.22 and later.
reservedCacheNodesOffering_cacheNodeType :: Lens.Lens' ReservedCacheNodesOffering (Prelude.Maybe Prelude.Text)
reservedCacheNodesOffering_cacheNodeType = Lens.lens (\ReservedCacheNodesOffering' {cacheNodeType} -> cacheNodeType) (\s@ReservedCacheNodesOffering' {} a -> s {cacheNodeType = a} :: ReservedCacheNodesOffering)
-- | The duration of the offering. in seconds.
reservedCacheNodesOffering_duration :: Lens.Lens' ReservedCacheNodesOffering (Prelude.Maybe Prelude.Int)
reservedCacheNodesOffering_duration = Lens.lens (\ReservedCacheNodesOffering' {duration} -> duration) (\s@ReservedCacheNodesOffering' {} a -> s {duration = a} :: ReservedCacheNodesOffering)
-- | The fixed price charged for this offering.
reservedCacheNodesOffering_fixedPrice :: Lens.Lens' ReservedCacheNodesOffering (Prelude.Maybe Prelude.Double)
reservedCacheNodesOffering_fixedPrice = Lens.lens (\ReservedCacheNodesOffering' {fixedPrice} -> fixedPrice) (\s@ReservedCacheNodesOffering' {} a -> s {fixedPrice = a} :: ReservedCacheNodesOffering)
-- | The offering type.
reservedCacheNodesOffering_offeringType :: Lens.Lens' ReservedCacheNodesOffering (Prelude.Maybe Prelude.Text)
reservedCacheNodesOffering_offeringType = Lens.lens (\ReservedCacheNodesOffering' {offeringType} -> offeringType) (\s@ReservedCacheNodesOffering' {} a -> s {offeringType = a} :: ReservedCacheNodesOffering)
-- | The cache engine used by the offering.
reservedCacheNodesOffering_productDescription :: Lens.Lens' ReservedCacheNodesOffering (Prelude.Maybe Prelude.Text)
reservedCacheNodesOffering_productDescription = Lens.lens (\ReservedCacheNodesOffering' {productDescription} -> productDescription) (\s@ReservedCacheNodesOffering' {} a -> s {productDescription = a} :: ReservedCacheNodesOffering)
-- | The recurring price charged to run this reserved cache node.
reservedCacheNodesOffering_recurringCharges :: Lens.Lens' ReservedCacheNodesOffering (Prelude.Maybe [RecurringCharge])
reservedCacheNodesOffering_recurringCharges = Lens.lens (\ReservedCacheNodesOffering' {recurringCharges} -> recurringCharges) (\s@ReservedCacheNodesOffering' {} a -> s {recurringCharges = a} :: ReservedCacheNodesOffering) Prelude.. Lens.mapping Lens.coerced
-- | A unique identifier for the reserved cache node offering.
reservedCacheNodesOffering_reservedCacheNodesOfferingId :: Lens.Lens' ReservedCacheNodesOffering (Prelude.Maybe Prelude.Text)
reservedCacheNodesOffering_reservedCacheNodesOfferingId = Lens.lens (\ReservedCacheNodesOffering' {reservedCacheNodesOfferingId} -> reservedCacheNodesOfferingId) (\s@ReservedCacheNodesOffering' {} a -> s {reservedCacheNodesOfferingId = a} :: ReservedCacheNodesOffering)
-- | The hourly price charged for this offering.
reservedCacheNodesOffering_usagePrice :: Lens.Lens' ReservedCacheNodesOffering (Prelude.Maybe Prelude.Double)
reservedCacheNodesOffering_usagePrice = Lens.lens (\ReservedCacheNodesOffering' {usagePrice} -> usagePrice) (\s@ReservedCacheNodesOffering' {} a -> s {usagePrice = a} :: ReservedCacheNodesOffering)
instance Data.FromXML ReservedCacheNodesOffering where
parseXML x =
ReservedCacheNodesOffering'
Prelude.<$> (x Data..@? "CacheNodeType")
Prelude.<*> (x Data..@? "Duration")
Prelude.<*> (x Data..@? "FixedPrice")
Prelude.<*> (x Data..@? "OfferingType")
Prelude.<*> (x Data..@? "ProductDescription")
Prelude.<*> ( x
Data..@? "RecurringCharges"
Core..!@ Prelude.mempty
Prelude.>>= Core.may (Data.parseXMLList "RecurringCharge")
)
Prelude.<*> (x Data..@? "ReservedCacheNodesOfferingId")
Prelude.<*> (x Data..@? "UsagePrice")
instance Prelude.Hashable ReservedCacheNodesOffering where
hashWithSalt _salt ReservedCacheNodesOffering' {..} =
_salt
`Prelude.hashWithSalt` cacheNodeType
`Prelude.hashWithSalt` duration
`Prelude.hashWithSalt` fixedPrice
`Prelude.hashWithSalt` offeringType
`Prelude.hashWithSalt` productDescription
`Prelude.hashWithSalt` recurringCharges
`Prelude.hashWithSalt` reservedCacheNodesOfferingId
`Prelude.hashWithSalt` usagePrice
instance Prelude.NFData ReservedCacheNodesOffering where
rnf ReservedCacheNodesOffering' {..} =
Prelude.rnf cacheNodeType
`Prelude.seq` Prelude.rnf duration
`Prelude.seq` Prelude.rnf fixedPrice
`Prelude.seq` Prelude.rnf offeringType
`Prelude.seq` Prelude.rnf productDescription
`Prelude.seq` Prelude.rnf recurringCharges
`Prelude.seq` Prelude.rnf reservedCacheNodesOfferingId
`Prelude.seq` Prelude.rnf usagePrice