| Copyright | (c) 2013-2021 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 |
Amazonka.ElastiCache
Contents
- Service Configuration
- Errors
- CacheSubnetGroupInUse
- ReservedCacheNodeAlreadyExistsFault
- CacheSecurityGroupNotFoundFault
- InvalidGlobalReplicationGroupStateFault
- CacheSubnetGroupAlreadyExistsFault
- GlobalReplicationGroupAlreadyExistsFault
- NodeGroupsPerReplicationGroupQuotaExceededFault
- CacheSubnetGroupQuotaExceededFault
- AuthorizationAlreadyExistsFault
- ReservedCacheNodeQuotaExceededFault
- ReservedCacheNodesOfferingNotFoundFault
- ReplicationGroupNotFoundFault
- InvalidSubnet
- InvalidUserGroupStateFault
- TagQuotaPerResourceExceeded
- UserAlreadyExistsFault
- InvalidUserStateFault
- SnapshotNotFoundFault
- InsufficientCacheClusterCapacityFault
- InvalidSnapshotStateFault
- SnapshotAlreadyExistsFault
- DefaultUserRequired
- TagNotFoundFault
- SnapshotQuotaExceededFault
- NodeQuotaForClusterExceededFault
- APICallRateForCustomerExceededFault
- NodeGroupNotFoundFault
- CacheParameterGroupAlreadyExistsFault
- ServiceLinkedRoleNotFoundFault
- InvalidKMSKeyFault
- GlobalReplicationGroupNotFoundFault
- ReservedCacheNodeNotFoundFault
- CacheSubnetGroupNotFoundFault
- SnapshotFeatureNotSupportedFault
- InvalidParameterValueException
- TestFailoverNotAvailableFault
- SubnetNotAllowedFault
- InvalidReplicationGroupStateFault
- ReplicationGroupAlreadyExistsFault
- InvalidVPCNetworkStateFault
- SubnetInUse
- UserGroupNotFoundFault
- CacheClusterNotFoundFault
- ClusterQuotaForCustomerExceededFault
- AuthorizationNotFoundFault
- UserGroupAlreadyExistsFault
- InvalidCacheClusterStateFault
- CacheSecurityGroupQuotaExceededFault
- CacheClusterAlreadyExistsFault
- CacheParameterGroupQuotaExceededFault
- ServiceUpdateNotFoundFault
- DefaultUserAssociatedToUserGroupFault
- UserNotFoundFault
- NodeQuotaForCustomerExceededFault
- CacheSubnetQuotaExceededFault
- ReplicationGroupNotUnderMigrationFault
- ReplicationGroupAlreadyUnderMigrationFault
- CacheParameterGroupNotFoundFault
- DuplicateUserNameFault
- UserQuotaExceededFault
- InvalidARNFault
- NoOperationFault
- InvalidCacheParameterGroupStateFault
- InvalidParameterCombinationException
- UserGroupQuotaExceededFault
- InvalidCacheSecurityGroupStateFault
- CacheSecurityGroupAlreadyExistsFault
- Waiters
- Operations
- StartMigration
- DeleteCacheSecurityGroup
- CreateReplicationGroup
- DeleteCacheCluster
- IncreaseNodeGroupsInGlobalReplicationGroup
- DescribeUsers (Paginated)
- RebootCacheCluster
- CreateUserGroup
- RevokeCacheSecurityGroupIngress
- CreateCacheCluster
- DescribeEvents (Paginated)
- DescribeEngineDefaultParameters (Paginated)
- DisassociateGlobalReplicationGroup
- ModifyCacheParameterGroup
- TestFailover
- DeleteReplicationGroup
- ListTagsForResource
- CompleteMigration
- DescribeCacheClusters (Paginated)
- PurchaseReservedCacheNodesOffering
- RemoveTagsFromResource
- ModifyReplicationGroup
- DescribeCacheParameters (Paginated)
- DescribeGlobalReplicationGroups (Paginated)
- DescribeCacheSubnetGroups (Paginated)
- DescribeUpdateActions (Paginated)
- RebalanceSlotsInGlobalReplicationGroup
- CreateCacheSecurityGroup
- DecreaseReplicaCount
- AddTagsToResource
- AuthorizeCacheSecurityGroupIngress
- CopySnapshot
- FailoverGlobalReplicationGroup
- CreateCacheSubnetGroup
- CreateGlobalReplicationGroup
- DescribeCacheParameterGroups (Paginated)
- ResetCacheParameterGroup
- ListAllowedNodeTypeModifications
- IncreaseReplicaCount
- ModifyReplicationGroupShardConfiguration
- BatchApplyUpdateAction
- DeleteUserGroup
- DescribeServiceUpdates (Paginated)
- DescribeSnapshots (Paginated)
- DescribeReplicationGroups (Paginated)
- CreateUser
- DeleteSnapshot
- DescribeReservedCacheNodesOfferings (Paginated)
- ModifyCacheSubnetGroup
- DeleteUser
- CreateSnapshot
- ModifyGlobalReplicationGroup
- DescribeUserGroups (Paginated)
- DeleteCacheParameterGroup
- DescribeCacheSecurityGroups (Paginated)
- BatchStopUpdateAction
- ModifyCacheCluster
- DescribeCacheEngineVersions (Paginated)
- ModifyUserGroup
- CreateCacheParameterGroup
- DescribeReservedCacheNodes (Paginated)
- DeleteGlobalReplicationGroup
- DecreaseNodeGroupsInGlobalReplicationGroup
- ModifyUser
- DeleteCacheSubnetGroup
- Types
- AZMode
- AuthTokenUpdateStatus
- AuthTokenUpdateStrategyType
- AuthenticationType
- AutomaticFailoverStatus
- ChangeType
- DestinationType
- LogDeliveryConfigurationStatus
- LogFormat
- LogType
- MultiAZStatus
- NodeUpdateInitiatedBy
- NodeUpdateStatus
- OutpostMode
- PendingAutomaticFailoverStatus
- ServiceUpdateSeverity
- ServiceUpdateStatus
- ServiceUpdateType
- SlaMet
- SourceType
- UpdateActionStatus
- Authentication
- AvailabilityZone
- CacheCluster
- CacheEngineVersion
- CacheNode
- CacheNodeTypeSpecificParameter
- CacheNodeTypeSpecificValue
- CacheNodeUpdateStatus
- CacheParameterGroup
- CacheParameterGroupNameMessage
- CacheParameterGroupStatus
- CacheSecurityGroup
- CacheSecurityGroupMembership
- CacheSubnetGroup
- CloudWatchLogsDestinationDetails
- ConfigureShard
- CustomerNodeEndpoint
- DestinationDetails
- EC2SecurityGroup
- Endpoint
- EngineDefaults
- Event
- Filter
- GlobalNodeGroup
- GlobalReplicationGroup
- GlobalReplicationGroupInfo
- GlobalReplicationGroupMember
- KinesisFirehoseDestinationDetails
- LogDeliveryConfiguration
- LogDeliveryConfigurationRequest
- NodeGroup
- NodeGroupConfiguration
- NodeGroupMember
- NodeGroupMemberUpdateStatus
- NodeGroupUpdateStatus
- NodeSnapshot
- NotificationConfiguration
- Parameter
- ParameterNameValue
- PendingLogDeliveryConfiguration
- PendingModifiedValues
- ProcessedUpdateAction
- RecurringCharge
- RegionalConfiguration
- ReplicationGroup
- ReplicationGroupPendingModifiedValues
- ReservedCacheNode
- ReservedCacheNodesOffering
- ReshardingConfiguration
- ReshardingStatus
- SecurityGroupMembership
- ServiceUpdate
- SlotMigration
- Snapshot
- Subnet
- SubnetOutpost
- Tag
- TagListMessage
- TimeRangeFilter
- UnprocessedUpdateAction
- UpdateAction
- UpdateActionResultsMessage
- User
- UserGroup
- UserGroupPendingChanges
- UserGroupsUpdateStatus
Description
Derived from API version 2015-02-02 of the AWS service descriptions, licensed under Apache 2.0.
Amazon ElastiCache
Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.
With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.
In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.
Synopsis
- defaultService :: Service
- _CacheSubnetGroupInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedCacheNodeAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidGlobalReplicationGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _GlobalReplicationGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeGroupsPerReplicationGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedCacheNodeQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedCacheNodesOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicationGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidUserGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _TagQuotaPerResourceExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _UserAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidUserStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientCacheClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DefaultUserRequired :: AsError a => Getting (First ServiceError) a ServiceError
- _TagNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeQuotaForClusterExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _APICallRateForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceLinkedRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidKMSKeyFault :: AsError a => Getting (First ServiceError) a ServiceError
- _GlobalReplicationGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReservedCacheNodeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SnapshotFeatureNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
- _TestFailoverNotAvailableFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetNotAllowedFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidReplicationGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicationGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _SubnetInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _UserGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ClusterQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _UserGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCacheClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSecurityGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUpdateNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DefaultUserAssociatedToUserGroupFault :: AsError a => Getting (First ServiceError) a ServiceError
- _UserNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NodeQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicationGroupNotUnderMigrationFault :: AsError a => Getting (First ServiceError) a ServiceError
- _ReplicationGroupAlreadyUnderMigrationFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateUserNameFault :: AsError a => Getting (First ServiceError) a ServiceError
- _UserQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidARNFault :: AsError a => Getting (First ServiceError) a ServiceError
- _NoOperationFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCacheParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _UserGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCacheSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError
- _CacheSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError
- newCacheClusterAvailable :: Wait DescribeCacheClusters
- newCacheClusterDeleted :: Wait DescribeCacheClusters
- newReplicationGroupDeleted :: Wait DescribeReplicationGroups
- newReplicationGroupAvailable :: Wait DescribeReplicationGroups
- data StartMigration = StartMigration' Text [CustomerNodeEndpoint]
- newStartMigration :: Text -> StartMigration
- data StartMigrationResponse = StartMigrationResponse' (Maybe ReplicationGroup) Int
- newStartMigrationResponse :: Int -> StartMigrationResponse
- data DeleteCacheSecurityGroup = DeleteCacheSecurityGroup' Text
- newDeleteCacheSecurityGroup :: Text -> DeleteCacheSecurityGroup
- data DeleteCacheSecurityGroupResponse = DeleteCacheSecurityGroupResponse' {
- newDeleteCacheSecurityGroupResponse :: DeleteCacheSecurityGroupResponse
- data CreateReplicationGroup = CreateReplicationGroup' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [NodeGroupConfiguration]) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe [LogDeliveryConfigurationRequest]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe [Text]) Text Text
- newCreateReplicationGroup :: Text -> Text -> CreateReplicationGroup
- data CreateReplicationGroupResponse = CreateReplicationGroupResponse' (Maybe ReplicationGroup) Int
- newCreateReplicationGroupResponse :: Int -> CreateReplicationGroupResponse
- data DeleteCacheCluster = DeleteCacheCluster' (Maybe Text) Text
- newDeleteCacheCluster :: Text -> DeleteCacheCluster
- data DeleteCacheClusterResponse = DeleteCacheClusterResponse' (Maybe CacheCluster) Int
- newDeleteCacheClusterResponse :: Int -> DeleteCacheClusterResponse
- data IncreaseNodeGroupsInGlobalReplicationGroup = IncreaseNodeGroupsInGlobalReplicationGroup' (Maybe [RegionalConfiguration]) Text Int Bool
- newIncreaseNodeGroupsInGlobalReplicationGroup :: Text -> Int -> Bool -> IncreaseNodeGroupsInGlobalReplicationGroup
- data IncreaseNodeGroupsInGlobalReplicationGroupResponse = IncreaseNodeGroupsInGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int
- newIncreaseNodeGroupsInGlobalReplicationGroupResponse :: Int -> IncreaseNodeGroupsInGlobalReplicationGroupResponse
- data DescribeUsers = DescribeUsers' (Maybe [Filter]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeUsers :: DescribeUsers
- data DescribeUsersResponse = DescribeUsersResponse' (Maybe [User]) (Maybe Text) Int
- newDescribeUsersResponse :: Int -> DescribeUsersResponse
- data RebootCacheCluster = RebootCacheCluster' Text [Text]
- newRebootCacheCluster :: Text -> RebootCacheCluster
- data RebootCacheClusterResponse = RebootCacheClusterResponse' (Maybe CacheCluster) Int
- newRebootCacheClusterResponse :: Int -> RebootCacheClusterResponse
- data CreateUserGroup = CreateUserGroup' (Maybe (NonEmpty Text)) (Maybe [Tag]) Text Text
- newCreateUserGroup :: Text -> Text -> CreateUserGroup
- data UserGroup = UserGroup' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserGroupPendingChanges) (Maybe [Text])
- newUserGroup :: UserGroup
- data RevokeCacheSecurityGroupIngress = RevokeCacheSecurityGroupIngress' Text Text Text
- newRevokeCacheSecurityGroupIngress :: Text -> Text -> Text -> RevokeCacheSecurityGroupIngress
- data RevokeCacheSecurityGroupIngressResponse = RevokeCacheSecurityGroupIngressResponse' (Maybe CacheSecurityGroup) Int
- newRevokeCacheSecurityGroupIngressResponse :: Int -> RevokeCacheSecurityGroupIngressResponse
- data CreateCacheCluster = CreateCacheCluster' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe OutpostMode) (Maybe Text) (Maybe Text) (Maybe [LogDeliveryConfigurationRequest]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe AZMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Tag]) (Maybe Int) (Maybe [Text]) Text
- newCreateCacheCluster :: Text -> CreateCacheCluster
- data CreateCacheClusterResponse = CreateCacheClusterResponse' (Maybe CacheCluster) Int
- newCreateCacheClusterResponse :: Int -> CreateCacheClusterResponse
- data DescribeEvents = DescribeEvents' (Maybe ISO8601) (Maybe SourceType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Int)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeEngineDefaultParameters = DescribeEngineDefaultParameters' (Maybe Text) (Maybe Int) Text
- newDescribeEngineDefaultParameters :: Text -> DescribeEngineDefaultParameters
- data DescribeEngineDefaultParametersResponse = DescribeEngineDefaultParametersResponse' Int EngineDefaults
- newDescribeEngineDefaultParametersResponse :: Int -> EngineDefaults -> DescribeEngineDefaultParametersResponse
- data DisassociateGlobalReplicationGroup = DisassociateGlobalReplicationGroup' Text Text Text
- newDisassociateGlobalReplicationGroup :: Text -> Text -> Text -> DisassociateGlobalReplicationGroup
- data DisassociateGlobalReplicationGroupResponse = DisassociateGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int
- newDisassociateGlobalReplicationGroupResponse :: Int -> DisassociateGlobalReplicationGroupResponse
- data ModifyCacheParameterGroup = ModifyCacheParameterGroup' Text [ParameterNameValue]
- newModifyCacheParameterGroup :: Text -> ModifyCacheParameterGroup
- data CacheParameterGroupNameMessage = CacheParameterGroupNameMessage' (Maybe Text)
- newCacheParameterGroupNameMessage :: CacheParameterGroupNameMessage
- data TestFailover = TestFailover' Text Text
- newTestFailover :: Text -> Text -> TestFailover
- data TestFailoverResponse = TestFailoverResponse' (Maybe ReplicationGroup) Int
- newTestFailoverResponse :: Int -> TestFailoverResponse
- data DeleteReplicationGroup = DeleteReplicationGroup' (Maybe Text) (Maybe Bool) Text
- newDeleteReplicationGroup :: Text -> DeleteReplicationGroup
- data DeleteReplicationGroupResponse = DeleteReplicationGroupResponse' (Maybe ReplicationGroup) Int
- newDeleteReplicationGroupResponse :: Int -> DeleteReplicationGroupResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data TagListMessage = TagListMessage' (Maybe [Tag])
- newTagListMessage :: TagListMessage
- data CompleteMigration = CompleteMigration' (Maybe Bool) Text
- newCompleteMigration :: Text -> CompleteMigration
- data CompleteMigrationResponse = CompleteMigrationResponse' (Maybe ReplicationGroup) Int
- newCompleteMigrationResponse :: Int -> CompleteMigrationResponse
- data DescribeCacheClusters = DescribeCacheClusters' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Bool)
- newDescribeCacheClusters :: DescribeCacheClusters
- data DescribeCacheClustersResponse = DescribeCacheClustersResponse' (Maybe [CacheCluster]) (Maybe Text) Int
- newDescribeCacheClustersResponse :: Int -> DescribeCacheClustersResponse
- data PurchaseReservedCacheNodesOffering = PurchaseReservedCacheNodesOffering' (Maybe Int) (Maybe Text) (Maybe [Tag]) Text
- newPurchaseReservedCacheNodesOffering :: Text -> PurchaseReservedCacheNodesOffering
- data PurchaseReservedCacheNodesOfferingResponse = PurchaseReservedCacheNodesOfferingResponse' (Maybe ReservedCacheNode) Int
- newPurchaseReservedCacheNodesOfferingResponse :: Int -> PurchaseReservedCacheNodesOfferingResponse
- data RemoveTagsFromResource = RemoveTagsFromResource' Text [Text]
- newRemoveTagsFromResource :: Text -> RemoveTagsFromResource
- data TagListMessage = TagListMessage' (Maybe [Tag])
- newTagListMessage :: TagListMessage
- data ModifyReplicationGroup = ModifyReplicationGroup' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [LogDeliveryConfigurationRequest]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe AuthTokenUpdateStrategyType) (Maybe Text) (Maybe [Text]) Text
- newModifyReplicationGroup :: Text -> ModifyReplicationGroup
- data ModifyReplicationGroupResponse = ModifyReplicationGroupResponse' (Maybe ReplicationGroup) Int
- newModifyReplicationGroupResponse :: Int -> ModifyReplicationGroupResponse
- data DescribeCacheParameters = DescribeCacheParameters' (Maybe Text) (Maybe Int) (Maybe Text) Text
- newDescribeCacheParameters :: Text -> DescribeCacheParameters
- data DescribeCacheParametersResponse = DescribeCacheParametersResponse' (Maybe [CacheNodeTypeSpecificParameter]) (Maybe Text) (Maybe [Parameter]) Int
- newDescribeCacheParametersResponse :: Int -> DescribeCacheParametersResponse
- data DescribeGlobalReplicationGroups = DescribeGlobalReplicationGroups' (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeGlobalReplicationGroups :: DescribeGlobalReplicationGroups
- data DescribeGlobalReplicationGroupsResponse = DescribeGlobalReplicationGroupsResponse' (Maybe Text) (Maybe [GlobalReplicationGroup]) Int
- newDescribeGlobalReplicationGroupsResponse :: Int -> DescribeGlobalReplicationGroupsResponse
- data DescribeCacheSubnetGroups = DescribeCacheSubnetGroups' (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeCacheSubnetGroups :: DescribeCacheSubnetGroups
- data DescribeCacheSubnetGroupsResponse = DescribeCacheSubnetGroupsResponse' (Maybe Text) (Maybe [CacheSubnetGroup]) Int
- newDescribeCacheSubnetGroupsResponse :: Int -> DescribeCacheSubnetGroupsResponse
- data DescribeUpdateActions = DescribeUpdateActions' (Maybe [Text]) (Maybe Text) (Maybe [UpdateActionStatus]) (Maybe Text) (Maybe TimeRangeFilter) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Bool) (Maybe [ServiceUpdateStatus])
- newDescribeUpdateActions :: DescribeUpdateActions
- data DescribeUpdateActionsResponse = DescribeUpdateActionsResponse' (Maybe [UpdateAction]) (Maybe Text) Int
- newDescribeUpdateActionsResponse :: Int -> DescribeUpdateActionsResponse
- data RebalanceSlotsInGlobalReplicationGroup = RebalanceSlotsInGlobalReplicationGroup' Text Bool
- newRebalanceSlotsInGlobalReplicationGroup :: Text -> Bool -> RebalanceSlotsInGlobalReplicationGroup
- data RebalanceSlotsInGlobalReplicationGroupResponse = RebalanceSlotsInGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int
- newRebalanceSlotsInGlobalReplicationGroupResponse :: Int -> RebalanceSlotsInGlobalReplicationGroupResponse
- data CreateCacheSecurityGroup = CreateCacheSecurityGroup' (Maybe [Tag]) Text Text
- newCreateCacheSecurityGroup :: Text -> Text -> CreateCacheSecurityGroup
- data CreateCacheSecurityGroupResponse = CreateCacheSecurityGroupResponse' (Maybe CacheSecurityGroup) Int
- newCreateCacheSecurityGroupResponse :: Int -> CreateCacheSecurityGroupResponse
- data DecreaseReplicaCount = DecreaseReplicaCount' (Maybe Int) (Maybe [ConfigureShard]) (Maybe [Text]) Text Bool
- newDecreaseReplicaCount :: Text -> Bool -> DecreaseReplicaCount
- data DecreaseReplicaCountResponse = DecreaseReplicaCountResponse' (Maybe ReplicationGroup) Int
- newDecreaseReplicaCountResponse :: Int -> DecreaseReplicaCountResponse
- data AddTagsToResource = AddTagsToResource' Text [Tag]
- newAddTagsToResource :: Text -> AddTagsToResource
- data TagListMessage = TagListMessage' (Maybe [Tag])
- newTagListMessage :: TagListMessage
- data AuthorizeCacheSecurityGroupIngress = AuthorizeCacheSecurityGroupIngress' Text Text Text
- newAuthorizeCacheSecurityGroupIngress :: Text -> Text -> Text -> AuthorizeCacheSecurityGroupIngress
- data AuthorizeCacheSecurityGroupIngressResponse = AuthorizeCacheSecurityGroupIngressResponse' (Maybe CacheSecurityGroup) Int
- newAuthorizeCacheSecurityGroupIngressResponse :: Int -> AuthorizeCacheSecurityGroupIngressResponse
- data CopySnapshot = CopySnapshot' (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text
- newCopySnapshot :: Text -> Text -> CopySnapshot
- data CopySnapshotResponse = CopySnapshotResponse' (Maybe Snapshot) Int
- newCopySnapshotResponse :: Int -> CopySnapshotResponse
- data FailoverGlobalReplicationGroup = FailoverGlobalReplicationGroup' Text Text Text
- newFailoverGlobalReplicationGroup :: Text -> Text -> Text -> FailoverGlobalReplicationGroup
- data FailoverGlobalReplicationGroupResponse = FailoverGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int
- newFailoverGlobalReplicationGroupResponse :: Int -> FailoverGlobalReplicationGroupResponse
- data CreateCacheSubnetGroup = CreateCacheSubnetGroup' (Maybe [Tag]) Text Text [Text]
- newCreateCacheSubnetGroup :: Text -> Text -> CreateCacheSubnetGroup
- data CreateCacheSubnetGroupResponse = CreateCacheSubnetGroupResponse' (Maybe CacheSubnetGroup) Int
- newCreateCacheSubnetGroupResponse :: Int -> CreateCacheSubnetGroupResponse
- data CreateGlobalReplicationGroup = CreateGlobalReplicationGroup' (Maybe Text) Text Text
- newCreateGlobalReplicationGroup :: Text -> Text -> CreateGlobalReplicationGroup
- data CreateGlobalReplicationGroupResponse = CreateGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int
- newCreateGlobalReplicationGroupResponse :: Int -> CreateGlobalReplicationGroupResponse
- data DescribeCacheParameterGroups = DescribeCacheParameterGroups' (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeCacheParameterGroups :: DescribeCacheParameterGroups
- data DescribeCacheParameterGroupsResponse = DescribeCacheParameterGroupsResponse' (Maybe [CacheParameterGroup]) (Maybe Text) Int
- newDescribeCacheParameterGroupsResponse :: Int -> DescribeCacheParameterGroupsResponse
- data ResetCacheParameterGroup = ResetCacheParameterGroup' (Maybe Bool) (Maybe [ParameterNameValue]) Text
- newResetCacheParameterGroup :: Text -> ResetCacheParameterGroup
- data CacheParameterGroupNameMessage = CacheParameterGroupNameMessage' (Maybe Text)
- newCacheParameterGroupNameMessage :: CacheParameterGroupNameMessage
- data ListAllowedNodeTypeModifications = ListAllowedNodeTypeModifications' (Maybe Text) (Maybe Text)
- newListAllowedNodeTypeModifications :: ListAllowedNodeTypeModifications
- data ListAllowedNodeTypeModificationsResponse = ListAllowedNodeTypeModificationsResponse' (Maybe [Text]) (Maybe [Text]) Int
- newListAllowedNodeTypeModificationsResponse :: Int -> ListAllowedNodeTypeModificationsResponse
- data IncreaseReplicaCount = IncreaseReplicaCount' (Maybe Int) (Maybe [ConfigureShard]) Text Bool
- newIncreaseReplicaCount :: Text -> Bool -> IncreaseReplicaCount
- data IncreaseReplicaCountResponse = IncreaseReplicaCountResponse' (Maybe ReplicationGroup) Int
- newIncreaseReplicaCountResponse :: Int -> IncreaseReplicaCountResponse
- data ModifyReplicationGroupShardConfiguration = ModifyReplicationGroupShardConfiguration' (Maybe [Text]) (Maybe [ReshardingConfiguration]) (Maybe [Text]) Text Int Bool
- newModifyReplicationGroupShardConfiguration :: Text -> Int -> Bool -> ModifyReplicationGroupShardConfiguration
- data ModifyReplicationGroupShardConfigurationResponse = ModifyReplicationGroupShardConfigurationResponse' (Maybe ReplicationGroup) Int
- newModifyReplicationGroupShardConfigurationResponse :: Int -> ModifyReplicationGroupShardConfigurationResponse
- data BatchApplyUpdateAction = BatchApplyUpdateAction' (Maybe [Text]) (Maybe [Text]) Text
- newBatchApplyUpdateAction :: Text -> BatchApplyUpdateAction
- data UpdateActionResultsMessage = UpdateActionResultsMessage' (Maybe [UnprocessedUpdateAction]) (Maybe [ProcessedUpdateAction])
- newUpdateActionResultsMessage :: UpdateActionResultsMessage
- data DeleteUserGroup = DeleteUserGroup' Text
- newDeleteUserGroup :: Text -> DeleteUserGroup
- data UserGroup = UserGroup' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserGroupPendingChanges) (Maybe [Text])
- newUserGroup :: UserGroup
- data DescribeServiceUpdates = DescribeServiceUpdates' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [ServiceUpdateStatus])
- newDescribeServiceUpdates :: DescribeServiceUpdates
- data DescribeServiceUpdatesResponse = DescribeServiceUpdatesResponse' (Maybe [ServiceUpdate]) (Maybe Text) Int
- newDescribeServiceUpdatesResponse :: Int -> DescribeServiceUpdatesResponse
- data DescribeSnapshots = DescribeSnapshots' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text)
- newDescribeSnapshots :: DescribeSnapshots
- data DescribeSnapshotsResponse = DescribeSnapshotsResponse' (Maybe [Snapshot]) (Maybe Text) Int
- newDescribeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
- data DescribeReplicationGroups = DescribeReplicationGroups' (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeReplicationGroups :: DescribeReplicationGroups
- data DescribeReplicationGroupsResponse = DescribeReplicationGroupsResponse' (Maybe Text) (Maybe [ReplicationGroup]) Int
- newDescribeReplicationGroupsResponse :: Int -> DescribeReplicationGroupsResponse
- data CreateUser = CreateUser' (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe [Tag]) Text Text Text Text
- newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
- data User = User' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUser :: User
- data DeleteSnapshot = DeleteSnapshot' Text
- newDeleteSnapshot :: Text -> DeleteSnapshot
- data DeleteSnapshotResponse = DeleteSnapshotResponse' (Maybe Snapshot) Int
- newDeleteSnapshotResponse :: Int -> DeleteSnapshotResponse
- data DescribeReservedCacheNodesOfferings = DescribeReservedCacheNodesOfferings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeReservedCacheNodesOfferings :: DescribeReservedCacheNodesOfferings
- data DescribeReservedCacheNodesOfferingsResponse = DescribeReservedCacheNodesOfferingsResponse' (Maybe Text) (Maybe [ReservedCacheNodesOffering]) Int
- newDescribeReservedCacheNodesOfferingsResponse :: Int -> DescribeReservedCacheNodesOfferingsResponse
- data ModifyCacheSubnetGroup = ModifyCacheSubnetGroup' (Maybe [Text]) (Maybe Text) Text
- newModifyCacheSubnetGroup :: Text -> ModifyCacheSubnetGroup
- data ModifyCacheSubnetGroupResponse = ModifyCacheSubnetGroupResponse' (Maybe CacheSubnetGroup) Int
- newModifyCacheSubnetGroupResponse :: Int -> ModifyCacheSubnetGroupResponse
- data DeleteUser = DeleteUser' Text
- newDeleteUser :: Text -> DeleteUser
- data User = User' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUser :: User
- data CreateSnapshot = CreateSnapshot' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text
- newCreateSnapshot :: Text -> CreateSnapshot
- data CreateSnapshotResponse = CreateSnapshotResponse' (Maybe Snapshot) Int
- newCreateSnapshotResponse :: Int -> CreateSnapshotResponse
- data ModifyGlobalReplicationGroup = ModifyGlobalReplicationGroup' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Bool
- newModifyGlobalReplicationGroup :: Text -> Bool -> ModifyGlobalReplicationGroup
- data ModifyGlobalReplicationGroupResponse = ModifyGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int
- newModifyGlobalReplicationGroupResponse :: Int -> ModifyGlobalReplicationGroupResponse
- data DescribeUserGroups = DescribeUserGroups' (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeUserGroups :: DescribeUserGroups
- data DescribeUserGroupsResponse = DescribeUserGroupsResponse' (Maybe [UserGroup]) (Maybe Text) Int
- newDescribeUserGroupsResponse :: Int -> DescribeUserGroupsResponse
- data DeleteCacheParameterGroup = DeleteCacheParameterGroup' Text
- newDeleteCacheParameterGroup :: Text -> DeleteCacheParameterGroup
- data DeleteCacheParameterGroupResponse = DeleteCacheParameterGroupResponse' {
- newDeleteCacheParameterGroupResponse :: DeleteCacheParameterGroupResponse
- data DescribeCacheSecurityGroups = DescribeCacheSecurityGroups' (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeCacheSecurityGroups :: DescribeCacheSecurityGroups
- data DescribeCacheSecurityGroupsResponse = DescribeCacheSecurityGroupsResponse' (Maybe [CacheSecurityGroup]) (Maybe Text) Int
- newDescribeCacheSecurityGroupsResponse :: Int -> DescribeCacheSecurityGroupsResponse
- data BatchStopUpdateAction = BatchStopUpdateAction' (Maybe [Text]) (Maybe [Text]) Text
- newBatchStopUpdateAction :: Text -> BatchStopUpdateAction
- data UpdateActionResultsMessage = UpdateActionResultsMessage' (Maybe [UnprocessedUpdateAction]) (Maybe [ProcessedUpdateAction])
- newUpdateActionResultsMessage :: UpdateActionResultsMessage
- data ModifyCacheCluster = ModifyCacheCluster' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [LogDeliveryConfigurationRequest]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe AZMode) (Maybe Bool) (Maybe AuthTokenUpdateStrategyType) (Maybe Text) (Maybe Int) (Maybe [Text]) Text
- newModifyCacheCluster :: Text -> ModifyCacheCluster
- data ModifyCacheClusterResponse = ModifyCacheClusterResponse' (Maybe CacheCluster) Int
- newModifyCacheClusterResponse :: Int -> ModifyCacheClusterResponse
- data DescribeCacheEngineVersions = DescribeCacheEngineVersions' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int)
- newDescribeCacheEngineVersions :: DescribeCacheEngineVersions
- data DescribeCacheEngineVersionsResponse = DescribeCacheEngineVersionsResponse' (Maybe [CacheEngineVersion]) (Maybe Text) Int
- newDescribeCacheEngineVersionsResponse :: Int -> DescribeCacheEngineVersionsResponse
- data ModifyUserGroup = ModifyUserGroup' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text
- newModifyUserGroup :: Text -> ModifyUserGroup
- data UserGroup = UserGroup' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserGroupPendingChanges) (Maybe [Text])
- newUserGroup :: UserGroup
- data CreateCacheParameterGroup = CreateCacheParameterGroup' (Maybe [Tag]) Text Text Text
- newCreateCacheParameterGroup :: Text -> Text -> Text -> CreateCacheParameterGroup
- data CreateCacheParameterGroupResponse = CreateCacheParameterGroupResponse' (Maybe CacheParameterGroup) Int
- newCreateCacheParameterGroupResponse :: Int -> CreateCacheParameterGroupResponse
- data DescribeReservedCacheNodes = DescribeReservedCacheNodes' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeReservedCacheNodes :: DescribeReservedCacheNodes
- data DescribeReservedCacheNodesResponse = DescribeReservedCacheNodesResponse' (Maybe Text) (Maybe [ReservedCacheNode]) Int
- newDescribeReservedCacheNodesResponse :: Int -> DescribeReservedCacheNodesResponse
- data DeleteGlobalReplicationGroup = DeleteGlobalReplicationGroup' Text Bool
- newDeleteGlobalReplicationGroup :: Text -> Bool -> DeleteGlobalReplicationGroup
- data DeleteGlobalReplicationGroupResponse = DeleteGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int
- newDeleteGlobalReplicationGroupResponse :: Int -> DeleteGlobalReplicationGroupResponse
- data DecreaseNodeGroupsInGlobalReplicationGroup = DecreaseNodeGroupsInGlobalReplicationGroup' (Maybe [Text]) (Maybe [Text]) Text Int Bool
- newDecreaseNodeGroupsInGlobalReplicationGroup :: Text -> Int -> Bool -> DecreaseNodeGroupsInGlobalReplicationGroup
- data DecreaseNodeGroupsInGlobalReplicationGroupResponse = DecreaseNodeGroupsInGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int
- newDecreaseNodeGroupsInGlobalReplicationGroupResponse :: Int -> DecreaseNodeGroupsInGlobalReplicationGroupResponse
- data ModifyUser = ModifyUser' (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Bool) Text
- newModifyUser :: Text -> ModifyUser
- data User = User' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUser :: User
- data DeleteCacheSubnetGroup = DeleteCacheSubnetGroup' Text
- newDeleteCacheSubnetGroup :: Text -> DeleteCacheSubnetGroup
- data DeleteCacheSubnetGroupResponse = DeleteCacheSubnetGroupResponse' {
- newDeleteCacheSubnetGroupResponse :: DeleteCacheSubnetGroupResponse
- newtype AZMode where
- AZMode' {
- fromAZMode :: Text
- pattern AZMode_Cross_az :: AZMode
- pattern AZMode_Single_az :: AZMode
- AZMode' {
- newtype AuthTokenUpdateStatus where
- newtype AuthTokenUpdateStrategyType where
- newtype AuthenticationType where
- newtype AutomaticFailoverStatus where
- newtype ChangeType where
- ChangeType' { }
- pattern ChangeType_Immediate :: ChangeType
- pattern ChangeType_Requires_reboot :: ChangeType
- newtype DestinationType where
- DestinationType' { }
- pattern DestinationType_Cloudwatch_logs :: DestinationType
- pattern DestinationType_Kinesis_firehose :: DestinationType
- newtype LogDeliveryConfigurationStatus where
- LogDeliveryConfigurationStatus' { }
- pattern LogDeliveryConfigurationStatus_Active :: LogDeliveryConfigurationStatus
- pattern LogDeliveryConfigurationStatus_Disabling :: LogDeliveryConfigurationStatus
- pattern LogDeliveryConfigurationStatus_Enabling :: LogDeliveryConfigurationStatus
- pattern LogDeliveryConfigurationStatus_Error :: LogDeliveryConfigurationStatus
- pattern LogDeliveryConfigurationStatus_Modifying :: LogDeliveryConfigurationStatus
- newtype LogFormat where
- LogFormat' { }
- pattern LogFormat_Json :: LogFormat
- pattern LogFormat_Text :: LogFormat
- newtype LogType where
- LogType' {
- fromLogType :: Text
- pattern LogType_Slow_log :: LogType
- LogType' {
- newtype MultiAZStatus where
- MultiAZStatus' { }
- pattern MultiAZStatus_Disabled :: MultiAZStatus
- pattern MultiAZStatus_Enabled :: MultiAZStatus
- newtype NodeUpdateInitiatedBy where
- newtype NodeUpdateStatus where
- NodeUpdateStatus' { }
- pattern NodeUpdateStatus_Complete :: NodeUpdateStatus
- pattern NodeUpdateStatus_In_progress :: NodeUpdateStatus
- pattern NodeUpdateStatus_Not_applied :: NodeUpdateStatus
- pattern NodeUpdateStatus_Stopped :: NodeUpdateStatus
- pattern NodeUpdateStatus_Stopping :: NodeUpdateStatus
- pattern NodeUpdateStatus_Waiting_to_start :: NodeUpdateStatus
- newtype OutpostMode where
- OutpostMode' { }
- pattern OutpostMode_Cross_outpost :: OutpostMode
- pattern OutpostMode_Single_outpost :: OutpostMode
- newtype PendingAutomaticFailoverStatus where
- newtype ServiceUpdateSeverity where
- newtype ServiceUpdateStatus where
- newtype ServiceUpdateType where
- newtype SlaMet where
- SlaMet' {
- fromSlaMet :: Text
- pattern SlaMet_N_a :: SlaMet
- pattern SlaMet_No :: SlaMet
- pattern SlaMet_Yes :: SlaMet
- SlaMet' {
- newtype SourceType where
- SourceType' { }
- pattern SourceType_Cache_cluster :: SourceType
- pattern SourceType_Cache_parameter_group :: SourceType
- pattern SourceType_Cache_security_group :: SourceType
- pattern SourceType_Cache_subnet_group :: SourceType
- pattern SourceType_Replication_group :: SourceType
- pattern SourceType_User :: SourceType
- pattern SourceType_User_group :: SourceType
- newtype UpdateActionStatus where
- UpdateActionStatus' { }
- pattern UpdateActionStatus_Complete :: UpdateActionStatus
- pattern UpdateActionStatus_In_progress :: UpdateActionStatus
- pattern UpdateActionStatus_Not_applicable :: UpdateActionStatus
- pattern UpdateActionStatus_Not_applied :: UpdateActionStatus
- pattern UpdateActionStatus_Scheduled :: UpdateActionStatus
- pattern UpdateActionStatus_Scheduling :: UpdateActionStatus
- pattern UpdateActionStatus_Stopped :: UpdateActionStatus
- pattern UpdateActionStatus_Stopping :: UpdateActionStatus
- pattern UpdateActionStatus_Waiting_to_start :: UpdateActionStatus
- data Authentication = Authentication' (Maybe Int) (Maybe AuthenticationType)
- newAuthentication :: Authentication
- data AvailabilityZone = AvailabilityZone' (Maybe Text)
- newAvailabilityZone :: AvailabilityZone
- data CacheCluster = CacheCluster' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [CacheNode]) (Maybe ISO8601) (Maybe Bool) (Maybe Bool) (Maybe [SecurityGroupMembership]) (Maybe NotificationConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [LogDeliveryConfiguration]) (Maybe Endpoint) (Maybe Text) (Maybe [CacheSecurityGroupMembership]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CacheParameterGroupStatus) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe PendingModifiedValues) (Maybe Int)
- newCacheCluster :: CacheCluster
- data CacheEngineVersion = CacheEngineVersion' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newCacheEngineVersion :: CacheEngineVersion
- data CacheNode = CacheNode' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Endpoint)
- newCacheNode :: CacheNode
- data CacheNodeTypeSpecificParameter = CacheNodeTypeSpecificParameter' (Maybe [CacheNodeTypeSpecificValue]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeType)
- newCacheNodeTypeSpecificParameter :: CacheNodeTypeSpecificParameter
- data CacheNodeTypeSpecificValue = CacheNodeTypeSpecificValue' (Maybe Text) (Maybe Text)
- newCacheNodeTypeSpecificValue :: CacheNodeTypeSpecificValue
- data CacheNodeUpdateStatus = CacheNodeUpdateStatus' (Maybe ISO8601) (Maybe NodeUpdateInitiatedBy) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe NodeUpdateStatus) (Maybe ISO8601)
- newCacheNodeUpdateStatus :: CacheNodeUpdateStatus
- data CacheParameterGroup = CacheParameterGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text)
- newCacheParameterGroup :: CacheParameterGroup
- data CacheParameterGroupNameMessage = CacheParameterGroupNameMessage' (Maybe Text)
- newCacheParameterGroupNameMessage :: CacheParameterGroupNameMessage
- data CacheParameterGroupStatus = CacheParameterGroupStatus' (Maybe Text) (Maybe [Text]) (Maybe Text)
- newCacheParameterGroupStatus :: CacheParameterGroupStatus
- data CacheSecurityGroup = CacheSecurityGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [EC2SecurityGroup]) (Maybe Text)
- newCacheSecurityGroup :: CacheSecurityGroup
- data CacheSecurityGroupMembership = CacheSecurityGroupMembership' (Maybe Text) (Maybe Text)
- newCacheSecurityGroupMembership :: CacheSecurityGroupMembership
- data CacheSubnetGroup = CacheSubnetGroup' (Maybe Text) (Maybe Text) (Maybe [Subnet]) (Maybe Text) (Maybe Text)
- newCacheSubnetGroup :: CacheSubnetGroup
- data CloudWatchLogsDestinationDetails = CloudWatchLogsDestinationDetails' (Maybe Text)
- newCloudWatchLogsDestinationDetails :: CloudWatchLogsDestinationDetails
- data ConfigureShard = ConfigureShard' (Maybe [Text]) (Maybe [Text]) Text Int
- newConfigureShard :: Text -> Int -> ConfigureShard
- data CustomerNodeEndpoint = CustomerNodeEndpoint' (Maybe Text) (Maybe Int)
- newCustomerNodeEndpoint :: CustomerNodeEndpoint
- data DestinationDetails = DestinationDetails' (Maybe CloudWatchLogsDestinationDetails) (Maybe KinesisFirehoseDestinationDetails)
- newDestinationDetails :: DestinationDetails
- data EC2SecurityGroup = EC2SecurityGroup' (Maybe Text) (Maybe Text) (Maybe Text)
- newEC2SecurityGroup :: EC2SecurityGroup
- data Endpoint = Endpoint' (Maybe Text) (Maybe Int)
- newEndpoint :: Endpoint
- data EngineDefaults = EngineDefaults' (Maybe Text) (Maybe [CacheNodeTypeSpecificParameter]) (Maybe Text) (Maybe [Parameter])
- newEngineDefaults :: EngineDefaults
- data Event = Event' (Maybe SourceType) (Maybe Text) (Maybe ISO8601) (Maybe Text)
- newEvent :: Event
- data Filter = Filter' Text (NonEmpty Text)
- newFilter :: Text -> NonEmpty Text -> Filter
- data GlobalNodeGroup = GlobalNodeGroup' (Maybe Text) (Maybe Text)
- newGlobalNodeGroup :: GlobalNodeGroup
- data GlobalReplicationGroup = GlobalReplicationGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe [GlobalReplicationGroupMember]) (Maybe Text) (Maybe Bool) (Maybe [GlobalNodeGroup]) (Maybe Text) (Maybe Text)
- newGlobalReplicationGroup :: GlobalReplicationGroup
- data GlobalReplicationGroupInfo = GlobalReplicationGroupInfo' (Maybe Text) (Maybe Text)
- newGlobalReplicationGroupInfo :: GlobalReplicationGroupInfo
- data GlobalReplicationGroupMember = GlobalReplicationGroupMember' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AutomaticFailoverStatus)
- newGlobalReplicationGroupMember :: GlobalReplicationGroupMember
- data KinesisFirehoseDestinationDetails = KinesisFirehoseDestinationDetails' (Maybe Text)
- newKinesisFirehoseDestinationDetails :: KinesisFirehoseDestinationDetails
- data LogDeliveryConfiguration = LogDeliveryConfiguration' (Maybe LogDeliveryConfigurationStatus) (Maybe LogFormat) (Maybe DestinationDetails) (Maybe LogType) (Maybe DestinationType) (Maybe Text)
- newLogDeliveryConfiguration :: LogDeliveryConfiguration
- data LogDeliveryConfigurationRequest = LogDeliveryConfigurationRequest' (Maybe LogFormat) (Maybe Bool) (Maybe DestinationDetails) (Maybe LogType) (Maybe DestinationType)
- newLogDeliveryConfigurationRequest :: LogDeliveryConfigurationRequest
- data NodeGroup = NodeGroup' (Maybe Text) (Maybe Endpoint) (Maybe Text) (Maybe [NodeGroupMember]) (Maybe Text) (Maybe Endpoint)
- newNodeGroup :: NodeGroup
- data NodeGroupConfiguration = NodeGroupConfiguration' (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text)
- newNodeGroupConfiguration :: NodeGroupConfiguration
- data NodeGroupMember = NodeGroupMember' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Endpoint)
- newNodeGroupMember :: NodeGroupMember
- data NodeGroupMemberUpdateStatus = NodeGroupMemberUpdateStatus' (Maybe ISO8601) (Maybe NodeUpdateInitiatedBy) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe NodeUpdateStatus) (Maybe ISO8601)
- newNodeGroupMemberUpdateStatus :: NodeGroupMemberUpdateStatus
- data NodeGroupUpdateStatus = NodeGroupUpdateStatus' (Maybe [NodeGroupMemberUpdateStatus]) (Maybe Text)
- newNodeGroupUpdateStatus :: NodeGroupUpdateStatus
- data NodeSnapshot = NodeSnapshot' (Maybe NodeGroupConfiguration) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text)
- newNodeSnapshot :: NodeSnapshot
- data NotificationConfiguration = NotificationConfiguration' (Maybe Text) (Maybe Text)
- newNotificationConfiguration :: NotificationConfiguration
- data Parameter = Parameter' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeType)
- newParameter :: Parameter
- data ParameterNameValue = ParameterNameValue' (Maybe Text) (Maybe Text)
- newParameterNameValue :: ParameterNameValue
- data PendingLogDeliveryConfiguration = PendingLogDeliveryConfiguration' (Maybe LogFormat) (Maybe DestinationDetails) (Maybe LogType) (Maybe DestinationType)
- newPendingLogDeliveryConfiguration :: PendingLogDeliveryConfiguration
- data PendingModifiedValues = PendingModifiedValues' (Maybe Text) (Maybe Text) (Maybe AuthTokenUpdateStatus) (Maybe [PendingLogDeliveryConfiguration]) (Maybe [Text]) (Maybe Int)
- newPendingModifiedValues :: PendingModifiedValues
- data ProcessedUpdateAction = ProcessedUpdateAction' (Maybe Text) (Maybe Text) (Maybe UpdateActionStatus) (Maybe Text)
- newProcessedUpdateAction :: ProcessedUpdateAction
- data RecurringCharge = RecurringCharge' (Maybe Text) (Maybe Double)
- newRecurringCharge :: RecurringCharge
- data RegionalConfiguration = RegionalConfiguration' Text Text [ReshardingConfiguration]
- newRegionalConfiguration :: Text -> Text -> RegionalConfiguration
- data ReplicationGroup = ReplicationGroup' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [NodeGroup]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe [LogDeliveryConfiguration]) (Maybe Endpoint) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe MultiAZStatus) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe ReplicationGroupPendingModifiedValues) (Maybe GlobalReplicationGroupInfo) (Maybe [Text]) (Maybe AutomaticFailoverStatus)
- newReplicationGroup :: ReplicationGroup
- data ReplicationGroupPendingModifiedValues = ReplicationGroupPendingModifiedValues' (Maybe AuthTokenUpdateStatus) (Maybe UserGroupsUpdateStatus) (Maybe [PendingLogDeliveryConfiguration]) (Maybe ReshardingStatus) (Maybe Text) (Maybe PendingAutomaticFailoverStatus)
- newReplicationGroupPendingModifiedValues :: ReplicationGroupPendingModifiedValues
- data ReservedCacheNode = ReservedCacheNode' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Int) (Maybe Text)
- newReservedCacheNode :: ReservedCacheNode
- data ReservedCacheNodesOffering = ReservedCacheNodesOffering' (Maybe Text) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Int) (Maybe Text)
- newReservedCacheNodesOffering :: ReservedCacheNodesOffering
- data ReshardingConfiguration = ReshardingConfiguration' (Maybe [Text]) (Maybe Text)
- newReshardingConfiguration :: ReshardingConfiguration
- data ReshardingStatus = ReshardingStatus' (Maybe SlotMigration)
- newReshardingStatus :: ReshardingStatus
- data SecurityGroupMembership = SecurityGroupMembership' (Maybe Text) (Maybe Text)
- newSecurityGroupMembership :: SecurityGroupMembership
- data ServiceUpdate = ServiceUpdate' (Maybe Text) (Maybe ServiceUpdateType) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Bool) (Maybe ServiceUpdateSeverity) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe ServiceUpdateStatus) (Maybe Text)
- newServiceUpdate :: ServiceUpdate
- data SlotMigration = SlotMigration' (Maybe Double)
- newSlotMigration :: SlotMigration
- data Snapshot = Snapshot' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [NodeSnapshot]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe AutomaticFailoverStatus) (Maybe Text)
- newSnapshot :: Snapshot
- data Subnet = Subnet' (Maybe Text) (Maybe AvailabilityZone) (Maybe SubnetOutpost)
- newSubnet :: Subnet
- data SubnetOutpost = SubnetOutpost' (Maybe Text)
- newSubnetOutpost :: SubnetOutpost
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data TagListMessage = TagListMessage' (Maybe [Tag])
- newTagListMessage :: TagListMessage
- data TimeRangeFilter = TimeRangeFilter' (Maybe ISO8601) (Maybe ISO8601)
- newTimeRangeFilter :: TimeRangeFilter
- data UnprocessedUpdateAction = UnprocessedUpdateAction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUnprocessedUpdateAction :: UnprocessedUpdateAction
- data UpdateAction = UpdateAction' (Maybe ServiceUpdateType) (Maybe SlaMet) (Maybe Text) (Maybe Text) (Maybe UpdateActionStatus) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe [CacheNodeUpdateStatus]) (Maybe ServiceUpdateSeverity) (Maybe [NodeGroupUpdateStatus]) (Maybe ISO8601) (Maybe ISO8601) (Maybe ServiceUpdateStatus) (Maybe Text) (Maybe Text)
- newUpdateAction :: UpdateAction
- data UpdateActionResultsMessage = UpdateActionResultsMessage' (Maybe [UnprocessedUpdateAction]) (Maybe [ProcessedUpdateAction])
- newUpdateActionResultsMessage :: UpdateActionResultsMessage
- data User = User' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUser :: User
- data UserGroup = UserGroup' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserGroupPendingChanges) (Maybe [Text])
- newUserGroup :: UserGroup
- data UserGroupPendingChanges = UserGroupPendingChanges' (Maybe [Text]) (Maybe [Text])
- newUserGroupPendingChanges :: UserGroupPendingChanges
- data UserGroupsUpdateStatus = UserGroupsUpdateStatus' (Maybe [Text]) (Maybe [Text])
- newUserGroupsUpdateStatus :: UserGroupsUpdateStatus
Service Configuration
defaultService :: Service Source #
API version 2015-02-02 of the Amazon ElastiCache 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 ElastiCache.
CacheSubnetGroupInUse
_CacheSubnetGroupInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache subnet group is currently in use.
ReservedCacheNodeAlreadyExistsFault
_ReservedCacheNodeAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have a reservation with the given identifier.
CacheSecurityGroupNotFoundFault
_CacheSecurityGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache security group name does not refer to an existing cache security group.
InvalidGlobalReplicationGroupStateFault
_InvalidGlobalReplicationGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Global datastore is not available or in primary-only state.
CacheSubnetGroupAlreadyExistsFault
_CacheSubnetGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache subnet group name is already in use by an existing cache subnet group.
GlobalReplicationGroupAlreadyExistsFault
_GlobalReplicationGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Global datastore name already exists.
NodeGroupsPerReplicationGroupQuotaExceededFault
_NodeGroupsPerReplicationGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90
CacheSubnetGroupQuotaExceededFault
_CacheSubnetGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of cache subnet groups.
AuthorizationAlreadyExistsFault
_AuthorizationAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified Amazon EC2 security group is already authorized for the specified cache security group.
ReservedCacheNodeQuotaExceededFault
_ReservedCacheNodeQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the user's cache node quota.
ReservedCacheNodesOfferingNotFoundFault
_ReservedCacheNodesOfferingNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache node offering does not exist.
ReplicationGroupNotFoundFault
_ReplicationGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified replication group does not exist.
InvalidSubnet
_InvalidSubnet :: AsError a => Getting (First ServiceError) a ServiceError Source #
An invalid subnet identifier was specified.
InvalidUserGroupStateFault
_InvalidUserGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user group is not in an active state.
TagQuotaPerResourceExceeded
_TagQuotaPerResourceExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.
UserAlreadyExistsFault
_UserAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A user with this ID already exists.
InvalidUserStateFault
_InvalidUserStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user is not in active state.
SnapshotNotFoundFault
_SnapshotNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested snapshot name does not refer to an existing snapshot.
InsufficientCacheClusterCapacityFault
_InsufficientCacheClusterCapacityFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.
InvalidSnapshotStateFault
_InvalidSnapshotStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The current state of the snapshot does not allow the requested operation to occur.
SnapshotAlreadyExistsFault
_SnapshotAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have a snapshot with the given name.
DefaultUserRequired
_DefaultUserRequired :: AsError a => Getting (First ServiceError) a ServiceError Source #
You must add default user to a user group.
TagNotFoundFault
_TagNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested tag was not found on this resource.
SnapshotQuotaExceededFault
_SnapshotQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the maximum number of snapshots.
NodeQuotaForClusterExceededFault
_NodeQuotaForClusterExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.
APICallRateForCustomerExceededFault
_APICallRateForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The customer has exceeded the allowed rate of API calls.
NodeGroupNotFoundFault
_NodeGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The node group specified by the NodeGroupId parameter could not be
found. Please verify that the node group exists and that you spelled the
NodeGroupId value correctly.
CacheParameterGroupAlreadyExistsFault
_CacheParameterGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A cache parameter group with the requested name already exists.
ServiceLinkedRoleNotFoundFault
_ServiceLinkedRoleNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified service linked role (SLR) was not found.
InvalidKMSKeyFault
_InvalidKMSKeyFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The KMS key supplied is not valid.
GlobalReplicationGroupNotFoundFault
_GlobalReplicationGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The Global datastore does not exist
ReservedCacheNodeNotFoundFault
_ReservedCacheNodeNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested reserved cache node was not found.
CacheSubnetGroupNotFoundFault
_CacheSubnetGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache subnet group name does not refer to an existing cache subnet group.
SnapshotFeatureNotSupportedFault
_SnapshotFeatureNotSupportedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You attempted one of the following operations:
- Creating a snapshot of a Redis cluster running on a
cache.t1.microcache node. - Creating a snapshot of a cluster that is running Memcached rather than Redis.
Neither of these are supported by ElastiCache.
InvalidParameterValueException
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value for a parameter is invalid.
TestFailoverNotAvailableFault
_TestFailoverNotAvailableFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The TestFailover action is not available.
SubnetNotAllowedFault
_SubnetNotAllowedFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
At least one subnet ID does not match the other subnet IDs. This mismatch typically occurs when a user sets one subnet ID to a regional Availability Zone and a different one to an outpost. Or when a user sets the subnet ID to an Outpost when not subscribed on this service.
InvalidReplicationGroupStateFault
_InvalidReplicationGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested replication group is not in the available state.
ReplicationGroupAlreadyExistsFault
_ReplicationGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified replication group already exists.
InvalidVPCNetworkStateFault
_InvalidVPCNetworkStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC network is in an invalid state.
SubnetInUse
_SubnetInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested subnet is being used by another cache subnet group.
UserGroupNotFoundFault
_UserGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user group was not found or does not exist
CacheClusterNotFoundFault
_CacheClusterNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cluster ID does not refer to an existing cluster.
ClusterQuotaForCustomerExceededFault
_ClusterQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of clusters per customer.
AuthorizationNotFoundFault
_AuthorizationNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified Amazon EC2 security group is not authorized for the specified cache security group.
UserGroupAlreadyExistsFault
_UserGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user group with this ID already exists.
InvalidCacheClusterStateFault
_InvalidCacheClusterStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cluster is not in the available state.
CacheSecurityGroupQuotaExceededFault
_CacheSecurityGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of cache security groups.
CacheClusterAlreadyExistsFault
_CacheClusterAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
You already have a cluster with the given identifier.
CacheParameterGroupQuotaExceededFault
_CacheParameterGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the maximum number of cache security groups.
ServiceUpdateNotFoundFault
_ServiceUpdateNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service update doesn't exist
DefaultUserAssociatedToUserGroupFault
_DefaultUserAssociatedToUserGroupFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The default user assigned to the user group.
UserNotFoundFault
_UserNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The user does not exist or could not be found.
NodeQuotaForCustomerExceededFault
_NodeQuotaForCustomerExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of cache nodes per customer.
CacheSubnetQuotaExceededFault
_CacheSubnetQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.
ReplicationGroupNotUnderMigrationFault
_ReplicationGroupNotUnderMigrationFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The designated replication group is not available for data migration.
ReplicationGroupAlreadyUnderMigrationFault
_ReplicationGroupAlreadyUnderMigrationFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The targeted replication group is not available.
CacheParameterGroupNotFoundFault
_CacheParameterGroupNotFoundFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested cache parameter group name does not refer to an existing cache parameter group.
DuplicateUserNameFault
_DuplicateUserNameFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A user with this username already exists.
UserQuotaExceededFault
_UserQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The quota of users has been exceeded.
InvalidARNFault
_InvalidARNFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
NoOperationFault
_NoOperationFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation was not performed because no changes were required.
InvalidCacheParameterGroupStateFault
_InvalidCacheParameterGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The current state of the cache parameter group does not allow the requested operation to occur.
InvalidParameterCombinationException
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Two or more incompatible parameters were specified.
UserGroupQuotaExceededFault
_UserGroupQuotaExceededFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of users exceeds the user group limit.
InvalidCacheSecurityGroupStateFault
_InvalidCacheSecurityGroupStateFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
The current state of the cache security group does not allow deletion.
CacheSecurityGroupAlreadyExistsFault
_CacheSecurityGroupAlreadyExistsFault :: AsError a => Getting (First ServiceError) a ServiceError Source #
A cache security group with the specified name already exists.
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.
CacheClusterAvailable
newCacheClusterAvailable :: Wait DescribeCacheClusters Source #
Polls DescribeCacheClusters every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
CacheClusterDeleted
newCacheClusterDeleted :: Wait DescribeCacheClusters Source #
Polls DescribeCacheClusters every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
ReplicationGroupDeleted
newReplicationGroupDeleted :: Wait DescribeReplicationGroups Source #
Polls DescribeReplicationGroups every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
ReplicationGroupAvailable
newReplicationGroupAvailable :: Wait DescribeReplicationGroups Source #
Polls DescribeReplicationGroups every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
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.
StartMigration
data StartMigration Source #
See: newStartMigration smart constructor.
Constructors
| StartMigration' Text [CustomerNodeEndpoint] |
Instances
Arguments
| :: Text | |
| -> StartMigration |
Create a value of StartMigration 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:replicationGroupId:StartMigration', startMigration_replicationGroupId - The ID of the replication group to which data should be migrated.
$sel:customerNodeEndpointList:StartMigration', startMigration_customerNodeEndpointList - List of endpoints from which data should be migrated. For Redis (cluster
mode disabled), list should have only one element.
data StartMigrationResponse Source #
See: newStartMigrationResponse smart constructor.
Constructors
| StartMigrationResponse' (Maybe ReplicationGroup) Int |
Instances
newStartMigrationResponse Source #
Create a value of StartMigrationResponse 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:replicationGroup:StartMigrationResponse', startMigrationResponse_replicationGroup - Undocumented member.
$sel:httpStatus:StartMigrationResponse', startMigrationResponse_httpStatus - The response's http status code.
DeleteCacheSecurityGroup
data DeleteCacheSecurityGroup Source #
Represents the input of a DeleteCacheSecurityGroup operation.
See: newDeleteCacheSecurityGroup smart constructor.
Constructors
| DeleteCacheSecurityGroup' Text |
Instances
newDeleteCacheSecurityGroup Source #
Create a value of DeleteCacheSecurityGroup 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:cacheSecurityGroupName:DeleteCacheSecurityGroup', deleteCacheSecurityGroup_cacheSecurityGroupName - The name of the cache security group to delete.
You cannot delete the default security group.
data DeleteCacheSecurityGroupResponse Source #
See: newDeleteCacheSecurityGroupResponse smart constructor.
Constructors
| DeleteCacheSecurityGroupResponse' | |
Instances
| Eq DeleteCacheSecurityGroupResponse Source # | |
| Read DeleteCacheSecurityGroupResponse Source # | |
| Show DeleteCacheSecurityGroupResponse Source # | |
Defined in Amazonka.ElastiCache.DeleteCacheSecurityGroup Methods showsPrec :: Int -> DeleteCacheSecurityGroupResponse -> ShowS # | |
| Generic DeleteCacheSecurityGroupResponse Source # | |
Defined in Amazonka.ElastiCache.DeleteCacheSecurityGroup Associated Types type Rep DeleteCacheSecurityGroupResponse :: Type -> Type # | |
| NFData DeleteCacheSecurityGroupResponse Source # | |
Defined in Amazonka.ElastiCache.DeleteCacheSecurityGroup Methods rnf :: DeleteCacheSecurityGroupResponse -> () # | |
| type Rep DeleteCacheSecurityGroupResponse Source # | |
newDeleteCacheSecurityGroupResponse :: DeleteCacheSecurityGroupResponse Source #
Create a value of DeleteCacheSecurityGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateReplicationGroup
data CreateReplicationGroup Source #
Represents the input of a CreateReplicationGroup operation.
See: newCreateReplicationGroup smart constructor.
Constructors
| CreateReplicationGroup' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [NodeGroupConfiguration]) (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe [LogDeliveryConfigurationRequest]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Int) (Maybe [Text]) Text Text |
Instances
newCreateReplicationGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateReplicationGroup |
Create a value of CreateReplicationGroup 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:automaticFailoverEnabled:CreateReplicationGroup', createReplicationGroup_automaticFailoverEnabled - Specifies whether a read-only replica is automatically promoted to
read/write primary if the existing primary fails.
AutomaticFailoverEnabled must be enabled for Redis (cluster mode
enabled) replication groups.
Default: false
$sel:engineVersion:CreateReplicationGroup', createReplicationGroup_engineVersion - The version number of the cache engine to be used for the clusters in
this replication group. To view the supported cache engine versions, use
the DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
$sel:cacheNodeType:CreateReplicationGroup', createReplicationGroup_cacheNodeType - The compute and memory capacity of the nodes in the node group (shard).
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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
$sel:nodeGroupConfiguration:CreateReplicationGroup', createReplicationGroup_nodeGroupConfiguration - A list of node group (shard) configuration options. Each node group
(shard) configuration has the following members:
PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount,
and Slots.
If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.
$sel:atRestEncryptionEnabled:CreateReplicationGroup', createReplicationGroup_atRestEncryptionEnabled - A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the
replication group is created. To enable encryption at rest on a
replication group you must set AtRestEncryptionEnabled to true when
you create the replication group.
Required: Only available when creating a replication group in an
Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
$sel:securityGroupIds:CreateReplicationGroup', createReplicationGroup_securityGroupIds - One or more Amazon VPC security groups associated with this replication
group.
Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).
$sel:snapshotArns:CreateReplicationGroup', createReplicationGroup_snapshotArns - A list of Amazon Resource Names (ARN) that uniquely identify the Redis
RDB snapshot files stored in Amazon S3. The snapshot files are used to
populate the new replication group. The Amazon S3 object name in the ARN
cannot contain any commas. The new replication group will have the
number of node groups (console: shards) specified by the parameter
NumNodeGroups or the number of node groups configured by
NodeGroupConfiguration regardless of the number of ARNs specified
here.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
$sel:autoMinorVersionUpgrade:CreateReplicationGroup', createReplicationGroup_autoMinorVersionUpgrade - This parameter is currently disabled.
$sel:cacheParameterGroupName:CreateReplicationGroup', createReplicationGroup_cacheParameterGroupName - The name of the parameter group to associate with this replication
group. If this argument is omitted, the default cache parameter group
for the specified engine is used.
If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.
- To create a Redis (cluster mode disabled) replication group, use
CacheParameterGroupName=default.redis3.2. - To create a Redis (cluster mode enabled) replication group, use
CacheParameterGroupName=default.redis3.2.cluster.on.
$sel:transitEncryptionEnabled:CreateReplicationGroup', createReplicationGroup_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the
cluster is created. To enable in-transit encryption on a cluster you
must set TransitEncryptionEnabled to true when you create a cluster.
This parameter is valid only if the Engine parameter is redis, the
EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is
being created in an Amazon VPC.
If you enable in-transit encryption, you must also specify a value for
CacheSubnetGroup.
Required: Only available when creating a replication group in an
Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
For HIPAA compliance, you must specify TransitEncryptionEnabled as
true, an AuthToken, and a CacheSubnetGroup.
$sel:userGroupIds:CreateReplicationGroup', createReplicationGroup_userGroupIds - The user group to associate with the replication group.
$sel:snapshotWindow:CreateReplicationGroup', createReplicationGroup_snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a
daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
$sel:logDeliveryConfigurations:CreateReplicationGroup', createReplicationGroup_logDeliveryConfigurations - Specifies the destination, format and type of the logs.
$sel:authToken:CreateReplicationGroup', createReplicationGroup_authToken - Reserved parameter. The password used to access a password protected
server.
AuthToken can be specified only on replication groups where
TransitEncryptionEnabled is true.
For HIPAA compliance, you must specify TransitEncryptionEnabled as
true, an AuthToken, and a CacheSubnetGroup.
Password constraints:
- Must be only printable ASCII characters.
- Must be at least 16 characters and no more than 128 characters in length.
- The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
$sel:primaryClusterId:CreateReplicationGroup', createReplicationGroup_primaryClusterId - The identifier of the cluster that serves as the primary for this
replication group. This cluster must already exist and have a status of
available.
This parameter is not required if NumCacheClusters, NumNodeGroups,
or ReplicasPerNodeGroup is specified.
$sel:engine:CreateReplicationGroup', createReplicationGroup_engine - The name of the cache engine to be used for the clusters in this
replication group. Must be Redis.
$sel:preferredMaintenanceWindow:CreateReplicationGroup', createReplicationGroup_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster
is performed. It is specified as a range in the format
ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
is a 60 minute period. Valid values for ddd are:
Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
$sel:kmsKeyId:CreateReplicationGroup', createReplicationGroup_kmsKeyId - The ID of the KMS key used to encrypt the disk in the cluster.
$sel:multiAZEnabled:CreateReplicationGroup', createReplicationGroup_multiAZEnabled - A flag indicating if you have Multi-AZ enabled to enhance fault
tolerance. For more information, see
Minimizing Downtime: Multi-AZ.
$sel:cacheSubnetGroupName:CreateReplicationGroup', createReplicationGroup_cacheSubnetGroupName - The name of the cache subnet group to be used for the replication group.
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
$sel:numNodeGroups:CreateReplicationGroup', createReplicationGroup_numNodeGroups - An optional parameter that specifies the number of node groups (shards)
for this Redis (cluster mode enabled) replication group. For Redis
(cluster mode disabled) either omit this parameter or set it to 1.
Default: 1
$sel:snapshotRetentionLimit:CreateReplicationGroup', createReplicationGroup_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic snapshots
before deleting them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot that was taken today is retained for 5 days before
being deleted.
Default: 0 (i.e., automatic backups are disabled for this cluster).
$sel:globalReplicationGroupId:CreateReplicationGroup', createReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:replicasPerNodeGroup:CreateReplicationGroup', createReplicationGroup_replicasPerNodeGroup - An optional parameter that specifies the number of replica nodes in each
node group (shard). Valid values are 0 to 5.
$sel:numCacheClusters:CreateReplicationGroup', createReplicationGroup_numCacheClusters - The number of clusters this replication group initially has.
This parameter is not used if there is more than one node group (shard).
You should use ReplicasPerNodeGroup instead.
If AutomaticFailoverEnabled is true, the value of this parameter
must be at least 2. If AutomaticFailoverEnabled is false you can
omit this parameter (it will default to 1), or you can explicitly set it
to a value between 2 and 6.
The maximum permitted value for NumCacheClusters is 6 (1 primary plus
5 replicas).
$sel:preferredCacheClusterAZs:CreateReplicationGroup', createReplicationGroup_preferredCacheClusterAZs - A list of EC2 Availability Zones in which the replication group's
clusters are created. The order of the Availability Zones in the list is
the order in which clusters are allocated. The primary cluster is
created in the first AZ in the list.
This parameter is not used if there is more than one node group (shard).
You should use NodeGroupConfiguration instead.
If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of
NumCacheClusters.
Default: system chosen Availability Zones.
$sel:snapshotName:CreateReplicationGroup', createReplicationGroup_snapshotName - The name of a snapshot from which to restore data into the new
replication group. The snapshot status changes to restoring while the
new replication group is being created.
$sel:notificationTopicArn:CreateReplicationGroup', createReplicationGroup_notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
(SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
$sel:tags:CreateReplicationGroup', createReplicationGroup_tags - A list of tags to be added to this resource. Tags are comma-separated
key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include
multiple tags as shown following: Key=myKey, Value=myKeyValue
Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups
will be replicated to all nodes.
$sel:port:CreateReplicationGroup', createReplicationGroup_port - The port number on which each member of the replication group accepts
connections.
$sel:cacheSecurityGroupNames:CreateReplicationGroup', createReplicationGroup_cacheSecurityGroupNames - A list of cache security group names to associate with this replication
group.
$sel:replicationGroupId:CreateReplicationGroup', createReplicationGroup_replicationGroupId - The replication group identifier. This parameter is stored as a
lowercase string.
Constraints:
- A name must contain from 1 to 40 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
$sel:replicationGroupDescription:CreateReplicationGroup', createReplicationGroup_replicationGroupDescription - A user-created description for the replication group.
data CreateReplicationGroupResponse Source #
See: newCreateReplicationGroupResponse smart constructor.
Constructors
| CreateReplicationGroupResponse' (Maybe ReplicationGroup) Int |
Instances
newCreateReplicationGroupResponse Source #
Create a value of CreateReplicationGroupResponse 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:replicationGroup:CreateReplicationGroupResponse', createReplicationGroupResponse_replicationGroup - Undocumented member.
$sel:httpStatus:CreateReplicationGroupResponse', createReplicationGroupResponse_httpStatus - The response's http status code.
DeleteCacheCluster
data DeleteCacheCluster Source #
Represents the input of a DeleteCacheCluster operation.
See: newDeleteCacheCluster smart constructor.
Constructors
| DeleteCacheCluster' (Maybe Text) Text |
Instances
newDeleteCacheCluster Source #
Create a value of DeleteCacheCluster 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:finalSnapshotIdentifier:DeleteCacheCluster', deleteCacheCluster_finalSnapshotIdentifier - The user-supplied name of a final cluster snapshot. This is the unique
name that identifies the snapshot. ElastiCache creates the snapshot, and
then deletes the cluster immediately afterward.
$sel:cacheClusterId:DeleteCacheCluster', deleteCacheCluster_cacheClusterId - The cluster identifier for the cluster to be deleted. This parameter is
not case sensitive.
data DeleteCacheClusterResponse Source #
See: newDeleteCacheClusterResponse smart constructor.
Constructors
| DeleteCacheClusterResponse' (Maybe CacheCluster) Int |
Instances
newDeleteCacheClusterResponse Source #
Create a value of DeleteCacheClusterResponse 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:cacheCluster:DeleteCacheClusterResponse', deleteCacheClusterResponse_cacheCluster - Undocumented member.
$sel:httpStatus:DeleteCacheClusterResponse', deleteCacheClusterResponse_httpStatus - The response's http status code.
IncreaseNodeGroupsInGlobalReplicationGroup
data IncreaseNodeGroupsInGlobalReplicationGroup Source #
See: newIncreaseNodeGroupsInGlobalReplicationGroup smart constructor.
Constructors
| IncreaseNodeGroupsInGlobalReplicationGroup' (Maybe [RegionalConfiguration]) Text Int Bool |
Instances
newIncreaseNodeGroupsInGlobalReplicationGroup Source #
Arguments
Create a value of IncreaseNodeGroupsInGlobalReplicationGroup 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:regionalConfigurations:IncreaseNodeGroupsInGlobalReplicationGroup', increaseNodeGroupsInGlobalReplicationGroup_regionalConfigurations - Describes the replication group IDs, the Amazon regions where they are
stored and the shard configuration for each that comprise the Global
datastore
$sel:globalReplicationGroupId:IncreaseNodeGroupsInGlobalReplicationGroup', increaseNodeGroupsInGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:nodeGroupCount:IncreaseNodeGroupsInGlobalReplicationGroup', increaseNodeGroupsInGlobalReplicationGroup_nodeGroupCount - The number of node groups you wish to add
$sel:applyImmediately:IncreaseNodeGroupsInGlobalReplicationGroup', increaseNodeGroupsInGlobalReplicationGroup_applyImmediately - Indicates that the process begins immediately. At present, the only
permitted value for this parameter is true.
data IncreaseNodeGroupsInGlobalReplicationGroupResponse Source #
See: newIncreaseNodeGroupsInGlobalReplicationGroupResponse smart constructor.
Instances
newIncreaseNodeGroupsInGlobalReplicationGroupResponse Source #
Arguments
| :: Int |
|
| -> IncreaseNodeGroupsInGlobalReplicationGroupResponse |
Create a value of IncreaseNodeGroupsInGlobalReplicationGroupResponse 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:globalReplicationGroup:IncreaseNodeGroupsInGlobalReplicationGroupResponse', increaseNodeGroupsInGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:IncreaseNodeGroupsInGlobalReplicationGroupResponse', increaseNodeGroupsInGlobalReplicationGroupResponse_httpStatus - The response's http status code.
DescribeUsers (Paginated)
data DescribeUsers Source #
See: newDescribeUsers smart constructor.
Instances
newDescribeUsers :: DescribeUsers Source #
Create a value of DescribeUsers 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:filters:DescribeUsers', describeUsers_filters - Filter to determine the list of User IDs to return.
$sel:engine:DescribeUsers', describeUsers_engine - The Redis engine.
$sel:userId:DescribeUsers', describeUsers_userId - The ID of the user.
$sel:marker:DescribeUsers', describeUsers_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords. >
$sel:maxRecords:DescribeUsers', describeUsers_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is included
in the response so that the remaining results can be retrieved.
data DescribeUsersResponse Source #
See: newDescribeUsersResponse smart constructor.
Instances
newDescribeUsersResponse Source #
Create a value of DescribeUsersResponse 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:users:DescribeUsersResponse', describeUsersResponse_users - A list of users.
$sel:marker:DescribeUsers', describeUsersResponse_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords. >
$sel:httpStatus:DescribeUsersResponse', describeUsersResponse_httpStatus - The response's http status code.
RebootCacheCluster
data RebootCacheCluster Source #
Represents the input of a RebootCacheCluster operation.
See: newRebootCacheCluster smart constructor.
Constructors
| RebootCacheCluster' Text [Text] |
Instances
newRebootCacheCluster Source #
Create a value of RebootCacheCluster 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:cacheClusterId:RebootCacheCluster', rebootCacheCluster_cacheClusterId - The cluster identifier. This parameter is stored as a lowercase string.
$sel:cacheNodeIdsToReboot:RebootCacheCluster', rebootCacheCluster_cacheNodeIdsToReboot - A list of cache node IDs to reboot. A node ID is a numeric identifier
(0001, 0002, etc.). To reboot an entire cluster, specify all of the
cache node IDs.
data RebootCacheClusterResponse Source #
See: newRebootCacheClusterResponse smart constructor.
Constructors
| RebootCacheClusterResponse' (Maybe CacheCluster) Int |
Instances
newRebootCacheClusterResponse Source #
Create a value of RebootCacheClusterResponse 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:cacheCluster:RebootCacheClusterResponse', rebootCacheClusterResponse_cacheCluster - Undocumented member.
$sel:httpStatus:RebootCacheClusterResponse', rebootCacheClusterResponse_httpStatus - The response's http status code.
CreateUserGroup
data CreateUserGroup Source #
See: newCreateUserGroup smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateUserGroup |
Create a value of CreateUserGroup 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:userIds:CreateUserGroup', createUserGroup_userIds - The list of user IDs that belong to the user group.
$sel:tags:CreateUserGroup', createUserGroup_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:userGroupId:CreateUserGroup', createUserGroup_userGroupId - The ID of the user group.
$sel:engine:CreateUserGroup', createUserGroup_engine - The current supported value is Redis.
See: newUserGroup smart constructor.
Constructors
| UserGroup' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserGroupPendingChanges) (Maybe [Text]) |
Instances
newUserGroup :: UserGroup Source #
Create a value of UserGroup 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:status:UserGroup', userGroup_status - Indicates user group status. Can be "creating", "active",
"modifying", "deleting".
$sel:userIds:UserGroup', userGroup_userIds - The list of user IDs that belong to the user group.
$sel:arn:UserGroup', userGroup_arn - The Amazon Resource Name (ARN) of the user group.
$sel:userGroupId:UserGroup', userGroup_userGroupId - The ID of the user group.
$sel:engine:UserGroup', userGroup_engine - The current supported value is Redis.
$sel:pendingChanges:UserGroup', userGroup_pendingChanges - A list of updates being applied to the user group.
$sel:replicationGroups:UserGroup', userGroup_replicationGroups - A list of replication groups that the user group can access.
RevokeCacheSecurityGroupIngress
data RevokeCacheSecurityGroupIngress Source #
Represents the input of a RevokeCacheSecurityGroupIngress operation.
See: newRevokeCacheSecurityGroupIngress smart constructor.
Constructors
| RevokeCacheSecurityGroupIngress' Text Text Text |
Instances
newRevokeCacheSecurityGroupIngress Source #
Arguments
| :: Text |
|
| -> Text | |
| -> Text |
|
| -> RevokeCacheSecurityGroupIngress |
Create a value of RevokeCacheSecurityGroupIngress 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:cacheSecurityGroupName:RevokeCacheSecurityGroupIngress', revokeCacheSecurityGroupIngress_cacheSecurityGroupName - The name of the cache security group to revoke ingress from.
$sel:eC2SecurityGroupName:RevokeCacheSecurityGroupIngress', revokeCacheSecurityGroupIngress_eC2SecurityGroupName - The name of the Amazon EC2 security group to revoke access from.
$sel:eC2SecurityGroupOwnerId:RevokeCacheSecurityGroupIngress', revokeCacheSecurityGroupIngress_eC2SecurityGroupOwnerId - The Amazon account number of the Amazon EC2 security group owner. Note
that this is not the same thing as an Amazon access key ID - you must
provide a valid Amazon account number for this parameter.
data RevokeCacheSecurityGroupIngressResponse Source #
See: newRevokeCacheSecurityGroupIngressResponse smart constructor.
Constructors
| RevokeCacheSecurityGroupIngressResponse' (Maybe CacheSecurityGroup) Int |
Instances
newRevokeCacheSecurityGroupIngressResponse Source #
Arguments
| :: Int | |
| -> RevokeCacheSecurityGroupIngressResponse |
Create a value of RevokeCacheSecurityGroupIngressResponse 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:cacheSecurityGroup:RevokeCacheSecurityGroupIngressResponse', revokeCacheSecurityGroupIngressResponse_cacheSecurityGroup - Undocumented member.
$sel:httpStatus:RevokeCacheSecurityGroupIngressResponse', revokeCacheSecurityGroupIngressResponse_httpStatus - The response's http status code.
CreateCacheCluster
data CreateCacheCluster Source #
Represents the input of a CreateCacheCluster operation.
See: newCreateCacheCluster smart constructor.
Constructors
| CreateCacheCluster' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe Bool) (Maybe OutpostMode) (Maybe Text) (Maybe Text) (Maybe [LogDeliveryConfigurationRequest]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe AZMode) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [Tag]) (Maybe Int) (Maybe [Text]) Text |
Instances
newCreateCacheCluster Source #
Create a value of CreateCacheCluster 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:engineVersion:CreateCacheCluster', createCacheCluster_engineVersion - The version number of the cache engine to be used for this cluster. To
view the supported cache engine versions, use the
DescribeCacheEngineVersions operation.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
$sel:cacheNodeType:CreateCacheCluster', createCacheCluster_cacheNodeType - The compute and memory capacity of the nodes in the node group (shard).
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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
$sel:securityGroupIds:CreateCacheCluster', createCacheCluster_securityGroupIds - One or more VPC security groups associated with the cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
$sel:snapshotArns:CreateCacheCluster', createCacheCluster_snapshotArns - A single-element string list containing an Amazon Resource Name (ARN)
that uniquely identifies a Redis RDB snapshot file stored in Amazon S3.
The snapshot file is used to populate the node group (shard). The Amazon
S3 object name in the ARN cannot contain any commas.
This parameter is only valid if the Engine parameter is redis.
Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb
$sel:autoMinorVersionUpgrade:CreateCacheCluster', createCacheCluster_autoMinorVersionUpgrade - This parameter is currently disabled.
$sel:outpostMode:CreateCacheCluster', createCacheCluster_outpostMode - Specifies whether the nodes in the cluster are created in a single
outpost or across multiple outposts.
$sel:cacheParameterGroupName:CreateCacheCluster', createCacheCluster_cacheParameterGroupName - The name of the parameter group to associate with this cluster. If this
argument is omitted, the default parameter group for the specified
engine is used. You cannot use any parameter group which has
cluster-enabled='yes' when creating a cluster.
$sel:snapshotWindow:CreateCacheCluster', createCacheCluster_snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a
daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the Engine parameter is redis.
$sel:logDeliveryConfigurations:CreateCacheCluster', createCacheCluster_logDeliveryConfigurations - Specifies the destination, format and type of the logs.
$sel:authToken:CreateCacheCluster', createCacheCluster_authToken - Reserved parameter. The password used to access a password protected
server.
Password constraints:
- Must be only printable ASCII characters.
- Must be at least 16 characters and no more than 128 characters in length.
- The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.
For more information, see AUTH password at http://redis.io/commands/AUTH.
$sel:engine:CreateCacheCluster', createCacheCluster_engine - The name of the cache engine to be used for this cluster.
Valid values for this parameter are: memcached | redis
$sel:preferredAvailabilityZones:CreateCacheCluster', createCacheCluster_preferredAvailabilityZones - A list of the Availability Zones in which cache nodes are created. The
order of the zones in the list is not important.
This option is only supported on Memcached.
If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.
The number of Availability Zones listed must equal the value of
NumCacheNodes.
If you want all the nodes in the same Availability Zone, use
PreferredAvailabilityZone instead, or repeat the Availability Zone
multiple times in the list.
Default: System chosen Availability Zones.
$sel:preferredMaintenanceWindow:CreateCacheCluster', createCacheCluster_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster
is performed. It is specified as a range in the format
ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
is a 60 minute period. Valid values for ddd are:
$sel:cacheSubnetGroupName:CreateCacheCluster', createCacheCluster_cacheSubnetGroupName - The name of the subnet group to be used for the cluster.
Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.
$sel:preferredAvailabilityZone:CreateCacheCluster', createCacheCluster_preferredAvailabilityZone - The EC2 Availability Zone in which the cluster is created.
All nodes belonging to this cluster are placed in the preferred
Availability Zone. If you want to create your nodes across multiple
Availability Zones, use PreferredAvailabilityZones.
Default: System chosen Availability Zone.
$sel:snapshotRetentionLimit:CreateCacheCluster', createCacheCluster_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic snapshots
before deleting them. For example, if you set SnapshotRetentionLimit
to 5, a snapshot taken today is retained for 5 days before being
deleted.
This parameter is only valid if the Engine parameter is redis.
Default: 0 (i.e., automatic backups are disabled for this cache cluster).
$sel:preferredOutpostArns:CreateCacheCluster', createCacheCluster_preferredOutpostArns - The outpost ARNs in which the cache cluster is created.
$sel:aZMode:CreateCacheCluster', createCacheCluster_aZMode - Specifies whether the nodes in this Memcached cluster are created in a
single Availability Zone or created across multiple Availability Zones
in the cluster's region.
This parameter is only supported for Memcached clusters.
If the AZMode and PreferredAvailabilityZones are not specified,
ElastiCache assumes single-az mode.
$sel:snapshotName:CreateCacheCluster', createCacheCluster_snapshotName - The name of a Redis snapshot from which to restore data into the new
node group (shard). The snapshot status changes to restoring while the
new node group (shard) is being created.
This parameter is only valid if the Engine parameter is redis.
$sel:preferredOutpostArn:CreateCacheCluster', createCacheCluster_preferredOutpostArn - The outpost ARN in which the cache cluster is created.
$sel:replicationGroupId:CreateCacheCluster', createCacheCluster_replicationGroupId - The ID of the replication group to which this cluster should belong. If
this parameter is specified, the cluster is added to the specified
replication group as a read replica; otherwise, the cluster is a
standalone primary that is not part of any replication group.
If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.
This parameter is only valid if the Engine parameter is redis.
$sel:notificationTopicArn:CreateCacheCluster', createCacheCluster_notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
(SNS) topic to which notifications are sent.
The Amazon SNS topic owner must be the same as the cluster owner.
$sel:numCacheNodes:CreateCacheCluster', createCacheCluster_numCacheNodes - The initial number of cache nodes that the cluster has.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
If you need more than 40 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.
$sel:tags:CreateCacheCluster', createCacheCluster_tags - A list of tags to be added to this resource.
$sel:port:CreateCacheCluster', createCacheCluster_port - The port number on which each of the cache nodes accepts connections.
$sel:cacheSecurityGroupNames:CreateCacheCluster', createCacheCluster_cacheSecurityGroupNames - A list of security group names to associate with this cluster.
Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
$sel:cacheClusterId:CreateCacheCluster', createCacheCluster_cacheClusterId - The node group (shard) identifier. This parameter is stored as a
lowercase string.
Constraints:
- A name must contain from 1 to 50 alphanumeric characters or hyphens.
- The first character must be a letter.
- A name cannot end with a hyphen or contain two consecutive hyphens.
data CreateCacheClusterResponse Source #
See: newCreateCacheClusterResponse smart constructor.
Constructors
| CreateCacheClusterResponse' (Maybe CacheCluster) Int |
Instances
newCreateCacheClusterResponse Source #
Create a value of CreateCacheClusterResponse 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:cacheCluster:CreateCacheClusterResponse', createCacheClusterResponse_cacheCluster - Undocumented member.
$sel:httpStatus:CreateCacheClusterResponse', createCacheClusterResponse_httpStatus - The response's http status code.
DescribeEvents (Paginated)
data DescribeEvents Source #
Represents the input of a DescribeEvents operation.
See: newDescribeEvents smart constructor.
Constructors
| DescribeEvents' (Maybe ISO8601) (Maybe SourceType) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe ISO8601) (Maybe Int) |
Instances
newDescribeEvents :: DescribeEvents Source #
Create a value of DescribeEvents 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:startTime:DescribeEvents', describeEvents_startTime - The beginning of the time interval to retrieve events for, specified in
ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
$sel:sourceType:DescribeEvents', describeEvents_sourceType - The event source to retrieve events for. If no value is specified, all
events are returned.
$sel:sourceIdentifier:DescribeEvents', describeEvents_sourceIdentifier - The identifier of the event source for which events are returned. If not
specified, all sources are included in the response.
$sel:marker:DescribeEvents', describeEvents_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeEvents', describeEvents_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
$sel:endTime:DescribeEvents', describeEvents_endTime - The end of the time interval for which to retrieve events, specified in
ISO 8601 format.
Example: 2017-03-30T07:03:49.555Z
$sel:duration:DescribeEvents', describeEvents_duration - The number of minutes worth of events to retrieve.
data DescribeEventsResponse Source #
Represents the output of a DescribeEvents operation.
See: newDescribeEventsResponse smart constructor.
Instances
newDescribeEventsResponse Source #
Create a value of DescribeEventsResponse 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:events:DescribeEventsResponse', describeEventsResponse_events - A list of events. Each element in the list contains detailed information
about one event.
$sel:marker:DescribeEvents', describeEventsResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:httpStatus:DescribeEventsResponse', describeEventsResponse_httpStatus - The response's http status code.
DescribeEngineDefaultParameters (Paginated)
data DescribeEngineDefaultParameters Source #
Represents the input of a DescribeEngineDefaultParameters operation.
See: newDescribeEngineDefaultParameters smart constructor.
Instances
newDescribeEngineDefaultParameters Source #
Arguments
| :: Text |
|
| -> DescribeEngineDefaultParameters |
Create a value of DescribeEngineDefaultParameters 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:marker:DescribeEngineDefaultParameters', describeEngineDefaultParameters_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeEngineDefaultParameters', describeEngineDefaultParameters_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
$sel:cacheParameterGroupFamily:DescribeEngineDefaultParameters', describeEngineDefaultParameters_cacheParameterGroupFamily - The name of the cache parameter group family.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
redis6.x |
data DescribeEngineDefaultParametersResponse Source #
See: newDescribeEngineDefaultParametersResponse smart constructor.
Instances
newDescribeEngineDefaultParametersResponse Source #
Arguments
| :: Int | |
| -> EngineDefaults |
|
| -> DescribeEngineDefaultParametersResponse |
Create a value of DescribeEngineDefaultParametersResponse 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:httpStatus:DescribeEngineDefaultParametersResponse', describeEngineDefaultParametersResponse_httpStatus - The response's http status code.
$sel:engineDefaults:DescribeEngineDefaultParametersResponse', describeEngineDefaultParametersResponse_engineDefaults - Undocumented member.
DisassociateGlobalReplicationGroup
data DisassociateGlobalReplicationGroup Source #
See: newDisassociateGlobalReplicationGroup smart constructor.
Constructors
| DisassociateGlobalReplicationGroup' Text Text Text |
Instances
newDisassociateGlobalReplicationGroup Source #
Arguments
| :: Text |
|
| -> Text | |
| -> Text |
|
| -> DisassociateGlobalReplicationGroup |
Create a value of DisassociateGlobalReplicationGroup 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:globalReplicationGroupId:DisassociateGlobalReplicationGroup', disassociateGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:replicationGroupId:DisassociateGlobalReplicationGroup', disassociateGlobalReplicationGroup_replicationGroupId - The name of the secondary cluster you wish to remove from the Global
datastore
$sel:replicationGroupRegion:DisassociateGlobalReplicationGroup', disassociateGlobalReplicationGroup_replicationGroupRegion - The Amazon region of secondary cluster you wish to remove from the
Global datastore
data DisassociateGlobalReplicationGroupResponse Source #
See: newDisassociateGlobalReplicationGroupResponse smart constructor.
Instances
newDisassociateGlobalReplicationGroupResponse Source #
Arguments
| :: Int | |
| -> DisassociateGlobalReplicationGroupResponse |
Create a value of DisassociateGlobalReplicationGroupResponse 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:globalReplicationGroup:DisassociateGlobalReplicationGroupResponse', disassociateGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:DisassociateGlobalReplicationGroupResponse', disassociateGlobalReplicationGroupResponse_httpStatus - The response's http status code.
ModifyCacheParameterGroup
data ModifyCacheParameterGroup Source #
Represents the input of a ModifyCacheParameterGroup operation.
See: newModifyCacheParameterGroup smart constructor.
Constructors
| ModifyCacheParameterGroup' Text [ParameterNameValue] |
Instances
newModifyCacheParameterGroup Source #
Create a value of ModifyCacheParameterGroup 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:cacheParameterGroupName:ModifyCacheParameterGroup', modifyCacheParameterGroup_cacheParameterGroupName - The name of the cache parameter group to modify.
$sel:parameterNameValues:ModifyCacheParameterGroup', modifyCacheParameterGroup_parameterNameValues - An array of parameter names and values for the parameter update. You
must supply at least one parameter name and value; subsequent arguments
are optional. A maximum of 20 parameters may be modified per request.
data CacheParameterGroupNameMessage Source #
Represents the output of one of the following operations:
ModifyCacheParameterGroup
ResetCacheParameterGroup
See: newCacheParameterGroupNameMessage smart constructor.
Constructors
| CacheParameterGroupNameMessage' (Maybe Text) |
Instances
newCacheParameterGroupNameMessage :: CacheParameterGroupNameMessage Source #
Create a value of CacheParameterGroupNameMessage 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:cacheParameterGroupName:CacheParameterGroupNameMessage', cacheParameterGroupNameMessage_cacheParameterGroupName - The name of the cache parameter group.
TestFailover
data TestFailover Source #
See: newTestFailover smart constructor.
Constructors
| TestFailover' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> TestFailover |
Create a value of TestFailover 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:replicationGroupId:TestFailover', testFailover_replicationGroupId - The name of the replication group (console: cluster) whose automatic
failover is being tested by this operation.
$sel:nodeGroupId:TestFailover', testFailover_nodeGroupId - The name of the node group (called shard in the console) in this
replication group on which automatic failover is to be tested. You may
test automatic failover on up to 5 node groups in any rolling 24-hour
period.
data TestFailoverResponse Source #
See: newTestFailoverResponse smart constructor.
Constructors
| TestFailoverResponse' (Maybe ReplicationGroup) Int |
Instances
newTestFailoverResponse Source #
Arguments
| :: Int | |
| -> TestFailoverResponse |
Create a value of TestFailoverResponse 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:replicationGroup:TestFailoverResponse', testFailoverResponse_replicationGroup - Undocumented member.
$sel:httpStatus:TestFailoverResponse', testFailoverResponse_httpStatus - The response's http status code.
DeleteReplicationGroup
data DeleteReplicationGroup Source #
Represents the input of a DeleteReplicationGroup operation.
See: newDeleteReplicationGroup smart constructor.
Instances
newDeleteReplicationGroup Source #
Create a value of DeleteReplicationGroup 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:finalSnapshotIdentifier:DeleteReplicationGroup', deleteReplicationGroup_finalSnapshotIdentifier - The name of a final node group (shard) snapshot. ElastiCache creates the
snapshot from the primary node in the cluster, rather than one of the
replicas; this is to ensure that it captures the freshest data. After
the final snapshot is taken, the replication group is immediately
deleted.
$sel:retainPrimaryCluster:DeleteReplicationGroup', deleteReplicationGroup_retainPrimaryCluster - If set to true, all of the read replicas are deleted, but the primary
node is retained.
$sel:replicationGroupId:DeleteReplicationGroup', deleteReplicationGroup_replicationGroupId - The identifier for the cluster to be deleted. This parameter is not case
sensitive.
data DeleteReplicationGroupResponse Source #
See: newDeleteReplicationGroupResponse smart constructor.
Constructors
| DeleteReplicationGroupResponse' (Maybe ReplicationGroup) Int |
Instances
newDeleteReplicationGroupResponse Source #
Create a value of DeleteReplicationGroupResponse 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:replicationGroup:DeleteReplicationGroupResponse', deleteReplicationGroupResponse_replicationGroup - Undocumented member.
$sel:httpStatus:DeleteReplicationGroupResponse', deleteReplicationGroupResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
The input parameters for the ListTagsForResource operation.
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource 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:resourceName:ListTagsForResource', listTagsForResource_resourceName - The Amazon Resource Name (ARN) of the resource for which you want the
list of tags, for example
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
data TagListMessage Source #
Represents the output from the AddTagsToResource,
ListTagsForResource, and RemoveTagsFromResource operations.
See: newTagListMessage smart constructor.
Constructors
| TagListMessage' (Maybe [Tag]) |
Instances
newTagListMessage :: TagListMessage Source #
Create a value of TagListMessage 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:tagList:TagListMessage', tagListMessage_tagList - A list of tags as key-value pairs.
CompleteMigration
data CompleteMigration Source #
See: newCompleteMigration smart constructor.
Constructors
| CompleteMigration' (Maybe Bool) Text |
Instances
Create a value of CompleteMigration 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:force:CompleteMigration', completeMigration_force - Forces the migration to stop without ensuring that data is in sync. It
is recommended to use this option only to abort the migration and not
recommended when application wants to continue migration to ElastiCache.
$sel:replicationGroupId:CompleteMigration', completeMigration_replicationGroupId - The ID of the replication group to which data is being migrated.
data CompleteMigrationResponse Source #
See: newCompleteMigrationResponse smart constructor.
Constructors
| CompleteMigrationResponse' (Maybe ReplicationGroup) Int |
Instances
newCompleteMigrationResponse Source #
Create a value of CompleteMigrationResponse 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:replicationGroup:CompleteMigrationResponse', completeMigrationResponse_replicationGroup - Undocumented member.
$sel:httpStatus:CompleteMigrationResponse', completeMigrationResponse_httpStatus - The response's http status code.
DescribeCacheClusters (Paginated)
data DescribeCacheClusters Source #
Represents the input of a DescribeCacheClusters operation.
See: newDescribeCacheClusters smart constructor.
Instances
newDescribeCacheClusters :: DescribeCacheClusters Source #
Create a value of DescribeCacheClusters 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:showCacheClustersNotInReplicationGroups:DescribeCacheClusters', describeCacheClusters_showCacheClustersNotInReplicationGroups - An optional flag that can be included in the DescribeCacheCluster
request to show only nodes (API/CLI: clusters) that are not members of
a replication group. In practice, this mean Memcached and single node
Redis clusters.
$sel:cacheClusterId:DescribeCacheClusters', describeCacheClusters_cacheClusterId - The user-supplied cluster identifier. If this parameter is specified,
only information about that specific cluster is returned. This parameter
isn't case sensitive.
$sel:marker:DescribeCacheClusters', describeCacheClusters_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeCacheClusters', describeCacheClusters_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
$sel:showCacheNodeInfo:DescribeCacheClusters', describeCacheClusters_showCacheNodeInfo - An optional flag that can be included in the DescribeCacheCluster
request to retrieve information about the individual cache nodes.
data DescribeCacheClustersResponse Source #
Represents the output of a DescribeCacheClusters operation.
See: newDescribeCacheClustersResponse smart constructor.
Constructors
| DescribeCacheClustersResponse' (Maybe [CacheCluster]) (Maybe Text) Int |
Instances
newDescribeCacheClustersResponse Source #
Create a value of DescribeCacheClustersResponse 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:cacheClusters:DescribeCacheClustersResponse', describeCacheClustersResponse_cacheClusters - A list of clusters. Each item in the list contains detailed information
about one cluster.
$sel:marker:DescribeCacheClusters', describeCacheClustersResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:httpStatus:DescribeCacheClustersResponse', describeCacheClustersResponse_httpStatus - The response's http status code.
PurchaseReservedCacheNodesOffering
data PurchaseReservedCacheNodesOffering Source #
Represents the input of a PurchaseReservedCacheNodesOffering
operation.
See: newPurchaseReservedCacheNodesOffering smart constructor.
Instances
newPurchaseReservedCacheNodesOffering Source #
Arguments
| :: Text |
|
| -> PurchaseReservedCacheNodesOffering |
Create a value of PurchaseReservedCacheNodesOffering 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:cacheNodeCount:PurchaseReservedCacheNodesOffering', purchaseReservedCacheNodesOffering_cacheNodeCount - The number of cache node instances to reserve.
Default: 1
$sel:reservedCacheNodeId:PurchaseReservedCacheNodesOffering', purchaseReservedCacheNodesOffering_reservedCacheNodeId - A customer-specified identifier to track this reservation.
The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.
Example: myreservationID
$sel:tags:PurchaseReservedCacheNodesOffering', purchaseReservedCacheNodesOffering_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:reservedCacheNodesOfferingId:PurchaseReservedCacheNodesOffering', purchaseReservedCacheNodesOffering_reservedCacheNodesOfferingId - The ID of the reserved cache node offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
data PurchaseReservedCacheNodesOfferingResponse Source #
See: newPurchaseReservedCacheNodesOfferingResponse smart constructor.
Constructors
| PurchaseReservedCacheNodesOfferingResponse' (Maybe ReservedCacheNode) Int |
Instances
newPurchaseReservedCacheNodesOfferingResponse Source #
Arguments
| :: Int | |
| -> PurchaseReservedCacheNodesOfferingResponse |
Create a value of PurchaseReservedCacheNodesOfferingResponse 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:reservedCacheNode:PurchaseReservedCacheNodesOfferingResponse', purchaseReservedCacheNodesOfferingResponse_reservedCacheNode - Undocumented member.
$sel:httpStatus:PurchaseReservedCacheNodesOfferingResponse', purchaseReservedCacheNodesOfferingResponse_httpStatus - The response's http status code.
RemoveTagsFromResource
data RemoveTagsFromResource Source #
Represents the input of a RemoveTagsFromResource operation.
See: newRemoveTagsFromResource smart constructor.
Constructors
| RemoveTagsFromResource' Text [Text] |
Instances
newRemoveTagsFromResource Source #
Create a value of RemoveTagsFromResource 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:resourceName:RemoveTagsFromResource', removeTagsFromResource_resourceName - The Amazon Resource Name (ARN) of the resource from which you want the
tags removed, for example
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
$sel:tagKeys:RemoveTagsFromResource', removeTagsFromResource_tagKeys - A list of TagKeys identifying the tags you want removed from the named
resource.
data TagListMessage Source #
Represents the output from the AddTagsToResource,
ListTagsForResource, and RemoveTagsFromResource operations.
See: newTagListMessage smart constructor.
Constructors
| TagListMessage' (Maybe [Tag]) |
Instances
newTagListMessage :: TagListMessage Source #
Create a value of TagListMessage 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:tagList:TagListMessage', tagListMessage_tagList - A list of tags as key-value pairs.
ModifyReplicationGroup
data ModifyReplicationGroup Source #
Represents the input of a ModifyReplicationGroups operation.
See: newModifyReplicationGroup smart constructor.
Constructors
| ModifyReplicationGroup' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [LogDeliveryConfigurationRequest]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe AuthTokenUpdateStrategyType) (Maybe Text) (Maybe [Text]) Text |
Instances
newModifyReplicationGroup Source #
Create a value of ModifyReplicationGroup 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:automaticFailoverEnabled:ModifyReplicationGroup', modifyReplicationGroup_automaticFailoverEnabled - Determines whether a read replica is automatically promoted to
read/write primary if the existing primary encounters a failure.
Valid values: true | false
$sel:engineVersion:ModifyReplicationGroup', modifyReplicationGroup_engineVersion - The upgraded version of the cache engine to be run on the clusters in
the replication group.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.
$sel:cacheNodeType:ModifyReplicationGroup', modifyReplicationGroup_cacheNodeType - A valid cache node type that you want to scale this replication group
to.
$sel:snapshottingClusterId:ModifyReplicationGroup', modifyReplicationGroup_snapshottingClusterId - The cluster ID that is used as the daily snapshot source for the
replication group. This parameter cannot be set for Redis (cluster mode
enabled) replication groups.
$sel:securityGroupIds:ModifyReplicationGroup', modifyReplicationGroup_securityGroupIds - Specifies the VPC Security Groups associated with the clusters in the
replication group.
This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).
$sel:autoMinorVersionUpgrade:ModifyReplicationGroup', modifyReplicationGroup_autoMinorVersionUpgrade - This parameter is currently disabled.
$sel:cacheParameterGroupName:ModifyReplicationGroup', modifyReplicationGroup_cacheParameterGroupName - The name of the cache parameter group to apply to all of the clusters in
this replication group. This change is asynchronously applied as soon as
possible for parameters when the ApplyImmediately parameter is
specified as true for this request.
$sel:replicationGroupDescription:ModifyReplicationGroup', modifyReplicationGroup_replicationGroupDescription - A description for the replication group. Maximum length is 255
characters.
$sel:snapshotWindow:ModifyReplicationGroup', modifyReplicationGroup_snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a
daily snapshot of the node group (shard) specified by
SnapshottingClusterId.
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
$sel:logDeliveryConfigurations:ModifyReplicationGroup', modifyReplicationGroup_logDeliveryConfigurations - Specifies the destination, format and type of the logs.
$sel:authToken:ModifyReplicationGroup', modifyReplicationGroup_authToken - Reserved parameter. The password used to access a password protected
server. This parameter must be specified with the
auth-token-update-strategy parameter. Password constraints:
- Must be only printable ASCII characters
- Must be at least 16 characters and no more than 128 characters in length
- Cannot contain any of the following characters: '/', '"', or '@', '%'
For more information, see AUTH password at AUTH.
$sel:primaryClusterId:ModifyReplicationGroup', modifyReplicationGroup_primaryClusterId - For replication groups with a single primary, if this parameter is
specified, ElastiCache promotes the specified cluster in the specified
replication group to the primary role. The nodes of all other clusters
in the replication group are read replicas.
$sel:preferredMaintenanceWindow:ModifyReplicationGroup', modifyReplicationGroup_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster
is performed. It is specified as a range in the format
ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
$sel:multiAZEnabled:ModifyReplicationGroup', modifyReplicationGroup_multiAZEnabled - A flag to indicate MultiAZ is enabled.
$sel:userGroupIdsToAdd:ModifyReplicationGroup', modifyReplicationGroup_userGroupIdsToAdd - The ID of the user group you are associating with the replication group.
$sel:nodeGroupId:ModifyReplicationGroup', modifyReplicationGroup_nodeGroupId - Deprecated. This parameter is not used.
$sel:snapshotRetentionLimit:ModifyReplicationGroup', modifyReplicationGroup_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic node group
(shard) snapshots before deleting them. For example, if you set
SnapshotRetentionLimit to 5, a snapshot that was taken today is
retained for 5 days before being deleted.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
$sel:userGroupIdsToRemove:ModifyReplicationGroup', modifyReplicationGroup_userGroupIdsToRemove - The ID of the user group to disassociate from the replication group,
meaning the users in the group no longer can access the replication
group.
$sel:notificationTopicStatus:ModifyReplicationGroup', modifyReplicationGroup_notificationTopicStatus - The status of the Amazon SNS notification topic for the replication
group. Notifications are sent only if the status is active.
Valid values: active | inactive
$sel:applyImmediately:ModifyReplicationGroup', modifyReplicationGroup_applyImmediately - If true, this parameter causes the modifications in this request and
any pending modifications to be applied, asynchronously and as soon as
possible, regardless of the PreferredMaintenanceWindow setting for the
replication group.
If false, changes to the nodes in the replication group are applied on
the next maintenance reboot, or the next failure reboot, whichever
occurs first.
Valid values: true | false
Default: false
$sel:removeUserGroups:ModifyReplicationGroup', modifyReplicationGroup_removeUserGroups - Removes the user group associated with this replication group.
$sel:authTokenUpdateStrategy:ModifyReplicationGroup', modifyReplicationGroup_authTokenUpdateStrategy - Specifies the strategy to use to update the AUTH token. This parameter
must be specified with the auth-token parameter. Possible values:
- Rotate
- Set
For more information, see Authenticating Users with Redis AUTH
$sel:notificationTopicArn:ModifyReplicationGroup', modifyReplicationGroup_notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications are sent.
The Amazon SNS topic owner must be same as the replication group owner.
$sel:cacheSecurityGroupNames:ModifyReplicationGroup', modifyReplicationGroup_cacheSecurityGroupNames - A list of cache security group names to authorize for the clusters in
this replication group. This change is asynchronously applied as soon as
possible.
This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must
not be Default.
$sel:replicationGroupId:ModifyReplicationGroup', modifyReplicationGroup_replicationGroupId - The identifier of the replication group to modify.
data ModifyReplicationGroupResponse Source #
See: newModifyReplicationGroupResponse smart constructor.
Constructors
| ModifyReplicationGroupResponse' (Maybe ReplicationGroup) Int |
Instances
newModifyReplicationGroupResponse Source #
Create a value of ModifyReplicationGroupResponse 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:replicationGroup:ModifyReplicationGroupResponse', modifyReplicationGroupResponse_replicationGroup - Undocumented member.
$sel:httpStatus:ModifyReplicationGroupResponse', modifyReplicationGroupResponse_httpStatus - The response's http status code.
DescribeCacheParameters (Paginated)
data DescribeCacheParameters Source #
Represents the input of a DescribeCacheParameters operation.
See: newDescribeCacheParameters smart constructor.
Instances
newDescribeCacheParameters Source #
Create a value of DescribeCacheParameters 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:marker:DescribeCacheParameters', describeCacheParameters_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeCacheParameters', describeCacheParameters_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
$sel:source:DescribeCacheParameters', describeCacheParameters_source - The parameter types to return.
Valid values: user | system | engine-default
$sel:cacheParameterGroupName:DescribeCacheParameters', describeCacheParameters_cacheParameterGroupName - The name of a specific cache parameter group to return details for.
data DescribeCacheParametersResponse Source #
Represents the output of a DescribeCacheParameters operation.
See: newDescribeCacheParametersResponse smart constructor.
Constructors
| DescribeCacheParametersResponse' (Maybe [CacheNodeTypeSpecificParameter]) (Maybe Text) (Maybe [Parameter]) Int |
Instances
newDescribeCacheParametersResponse Source #
Create a value of DescribeCacheParametersResponse 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:cacheNodeTypeSpecificParameters:DescribeCacheParametersResponse', describeCacheParametersResponse_cacheNodeTypeSpecificParameters - A list of parameters specific to a particular cache node type. Each
element in the list contains detailed information about one parameter.
$sel:marker:DescribeCacheParameters', describeCacheParametersResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:parameters:DescribeCacheParametersResponse', describeCacheParametersResponse_parameters - A list of Parameter instances.
$sel:httpStatus:DescribeCacheParametersResponse', describeCacheParametersResponse_httpStatus - The response's http status code.
DescribeGlobalReplicationGroups (Paginated)
data DescribeGlobalReplicationGroups Source #
See: newDescribeGlobalReplicationGroups smart constructor.
Instances
newDescribeGlobalReplicationGroups :: DescribeGlobalReplicationGroups Source #
Create a value of DescribeGlobalReplicationGroups 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:showMemberInfo:DescribeGlobalReplicationGroups', describeGlobalReplicationGroups_showMemberInfo - Returns the list of members that comprise the Global datastore.
$sel:marker:DescribeGlobalReplicationGroups', describeGlobalReplicationGroups_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeGlobalReplicationGroups', describeGlobalReplicationGroups_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is included
in the response so that the remaining results can be retrieved.
$sel:globalReplicationGroupId:DescribeGlobalReplicationGroups', describeGlobalReplicationGroups_globalReplicationGroupId - The name of the Global datastore
data DescribeGlobalReplicationGroupsResponse Source #
See: newDescribeGlobalReplicationGroupsResponse smart constructor.
Constructors
| DescribeGlobalReplicationGroupsResponse' (Maybe Text) (Maybe [GlobalReplicationGroup]) Int |
Instances
newDescribeGlobalReplicationGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeGlobalReplicationGroupsResponse |
Create a value of DescribeGlobalReplicationGroupsResponse 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:marker:DescribeGlobalReplicationGroups', describeGlobalReplicationGroupsResponse_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords. >
$sel:globalReplicationGroups:DescribeGlobalReplicationGroupsResponse', describeGlobalReplicationGroupsResponse_globalReplicationGroups - Indicates the slot configuration and global identifier for each slice
group.
$sel:httpStatus:DescribeGlobalReplicationGroupsResponse', describeGlobalReplicationGroupsResponse_httpStatus - The response's http status code.
DescribeCacheSubnetGroups (Paginated)
data DescribeCacheSubnetGroups Source #
Represents the input of a DescribeCacheSubnetGroups operation.
See: newDescribeCacheSubnetGroups smart constructor.
Instances
newDescribeCacheSubnetGroups :: DescribeCacheSubnetGroups Source #
Create a value of DescribeCacheSubnetGroups 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:cacheSubnetGroupName:DescribeCacheSubnetGroups', describeCacheSubnetGroups_cacheSubnetGroupName - The name of the cache subnet group to return details for.
$sel:marker:DescribeCacheSubnetGroups', describeCacheSubnetGroups_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeCacheSubnetGroups', describeCacheSubnetGroups_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
data DescribeCacheSubnetGroupsResponse Source #
Represents the output of a DescribeCacheSubnetGroups operation.
See: newDescribeCacheSubnetGroupsResponse smart constructor.
Constructors
| DescribeCacheSubnetGroupsResponse' (Maybe Text) (Maybe [CacheSubnetGroup]) Int |
Instances
newDescribeCacheSubnetGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeCacheSubnetGroupsResponse |
Create a value of DescribeCacheSubnetGroupsResponse 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:marker:DescribeCacheSubnetGroups', describeCacheSubnetGroupsResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:cacheSubnetGroups:DescribeCacheSubnetGroupsResponse', describeCacheSubnetGroupsResponse_cacheSubnetGroups - A list of cache subnet groups. Each element in the list contains
detailed information about one group.
$sel:httpStatus:DescribeCacheSubnetGroupsResponse', describeCacheSubnetGroupsResponse_httpStatus - The response's http status code.
DescribeUpdateActions (Paginated)
data DescribeUpdateActions Source #
See: newDescribeUpdateActions smart constructor.
Constructors
| DescribeUpdateActions' (Maybe [Text]) (Maybe Text) (Maybe [UpdateActionStatus]) (Maybe Text) (Maybe TimeRangeFilter) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe Bool) (Maybe [ServiceUpdateStatus]) |
Instances
newDescribeUpdateActions :: DescribeUpdateActions Source #
Create a value of DescribeUpdateActions 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:cacheClusterIds:DescribeUpdateActions', describeUpdateActions_cacheClusterIds - The cache cluster IDs
$sel:serviceUpdateName:DescribeUpdateActions', describeUpdateActions_serviceUpdateName - The unique ID of the service update
$sel:updateActionStatus:DescribeUpdateActions', describeUpdateActions_updateActionStatus - The status of the update action.
$sel:engine:DescribeUpdateActions', describeUpdateActions_engine - The Elasticache engine to which the update applies. Either Redis or
Memcached
$sel:serviceUpdateTimeRange:DescribeUpdateActions', describeUpdateActions_serviceUpdateTimeRange - The range of time specified to search for service updates that are in
available status
$sel:marker:DescribeUpdateActions', describeUpdateActions_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeUpdateActions', describeUpdateActions_maxRecords - The maximum number of records to include in the response
$sel:replicationGroupIds:DescribeUpdateActions', describeUpdateActions_replicationGroupIds - The replication group IDs
$sel:showNodeLevelUpdateStatus:DescribeUpdateActions', describeUpdateActions_showNodeLevelUpdateStatus - Dictates whether to include node level update status in the response
$sel:serviceUpdateStatus:DescribeUpdateActions', describeUpdateActions_serviceUpdateStatus - The status of the service update
data DescribeUpdateActionsResponse Source #
See: newDescribeUpdateActionsResponse smart constructor.
Constructors
| DescribeUpdateActionsResponse' (Maybe [UpdateAction]) (Maybe Text) Int |
Instances
newDescribeUpdateActionsResponse Source #
Create a value of DescribeUpdateActionsResponse 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:updateActions:DescribeUpdateActionsResponse', describeUpdateActionsResponse_updateActions - Returns a list of update actions
$sel:marker:DescribeUpdateActions', describeUpdateActionsResponse_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:httpStatus:DescribeUpdateActionsResponse', describeUpdateActionsResponse_httpStatus - The response's http status code.
RebalanceSlotsInGlobalReplicationGroup
data RebalanceSlotsInGlobalReplicationGroup Source #
See: newRebalanceSlotsInGlobalReplicationGroup smart constructor.
Constructors
| RebalanceSlotsInGlobalReplicationGroup' Text Bool |
Instances
newRebalanceSlotsInGlobalReplicationGroup Source #
Arguments
| :: Text |
|
| -> Bool |
|
| -> RebalanceSlotsInGlobalReplicationGroup |
Create a value of RebalanceSlotsInGlobalReplicationGroup 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:globalReplicationGroupId:RebalanceSlotsInGlobalReplicationGroup', rebalanceSlotsInGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:applyImmediately:RebalanceSlotsInGlobalReplicationGroup', rebalanceSlotsInGlobalReplicationGroup_applyImmediately - If True, redistribution is applied immediately.
data RebalanceSlotsInGlobalReplicationGroupResponse Source #
See: newRebalanceSlotsInGlobalReplicationGroupResponse smart constructor.
Instances
newRebalanceSlotsInGlobalReplicationGroupResponse Source #
Arguments
| :: Int |
|
| -> RebalanceSlotsInGlobalReplicationGroupResponse |
Create a value of RebalanceSlotsInGlobalReplicationGroupResponse 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:globalReplicationGroup:RebalanceSlotsInGlobalReplicationGroupResponse', rebalanceSlotsInGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:RebalanceSlotsInGlobalReplicationGroupResponse', rebalanceSlotsInGlobalReplicationGroupResponse_httpStatus - The response's http status code.
CreateCacheSecurityGroup
data CreateCacheSecurityGroup Source #
Represents the input of a CreateCacheSecurityGroup operation.
See: newCreateCacheSecurityGroup smart constructor.
Constructors
| CreateCacheSecurityGroup' (Maybe [Tag]) Text Text |
Instances
newCreateCacheSecurityGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateCacheSecurityGroup |
Create a value of CreateCacheSecurityGroup 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:tags:CreateCacheSecurityGroup', createCacheSecurityGroup_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:cacheSecurityGroupName:CreateCacheSecurityGroup', createCacheSecurityGroup_cacheSecurityGroupName - A name for the cache security group. This value is stored as a lowercase
string.
Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word "Default".
Example: mysecuritygroup
$sel:description:CreateCacheSecurityGroup', createCacheSecurityGroup_description - A description for the cache security group.
data CreateCacheSecurityGroupResponse Source #
See: newCreateCacheSecurityGroupResponse smart constructor.
Constructors
| CreateCacheSecurityGroupResponse' (Maybe CacheSecurityGroup) Int |
Instances
newCreateCacheSecurityGroupResponse Source #
Create a value of CreateCacheSecurityGroupResponse 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:cacheSecurityGroup:CreateCacheSecurityGroupResponse', createCacheSecurityGroupResponse_cacheSecurityGroup - Undocumented member.
$sel:httpStatus:CreateCacheSecurityGroupResponse', createCacheSecurityGroupResponse_httpStatus - The response's http status code.
DecreaseReplicaCount
data DecreaseReplicaCount Source #
See: newDecreaseReplicaCount smart constructor.
Constructors
| DecreaseReplicaCount' (Maybe Int) (Maybe [ConfigureShard]) (Maybe [Text]) Text Bool |
Instances
newDecreaseReplicaCount Source #
Arguments
| :: Text | |
| -> Bool | |
| -> DecreaseReplicaCount |
Create a value of DecreaseReplicaCount 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:newReplicaCount':DecreaseReplicaCount', decreaseReplicaCount_newReplicaCount - The number of read replica nodes you want at the completion of this
operation. For Redis (cluster mode disabled) replication groups, this is
the number of replica nodes in the replication group. For Redis (cluster
mode enabled) replication groups, this is the number of replica nodes in
each of the replication group's node groups.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
- If Multi-AZ is enabled: 1
- If Multi-AZ is not enabled: 0
- Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
$sel:replicaConfiguration:DecreaseReplicaCount', decreaseReplicaCount_replicaConfiguration - A list of ConfigureShard objects that can be used to configure each
shard in a Redis (cluster mode enabled) replication group. The
ConfigureShard has three members: NewReplicaCount, NodeGroupId,
and PreferredAvailabilityZones.
$sel:replicasToRemove:DecreaseReplicaCount', decreaseReplicaCount_replicasToRemove - A list of the node ids to remove from the replication group or node
group (shard).
$sel:replicationGroupId:DecreaseReplicaCount', decreaseReplicaCount_replicationGroupId - The id of the replication group from which you want to remove replica
nodes.
$sel:applyImmediately:DecreaseReplicaCount', decreaseReplicaCount_applyImmediately - If True, the number of replica nodes is decreased immediately.
ApplyImmediately=False is not currently supported.
data DecreaseReplicaCountResponse Source #
See: newDecreaseReplicaCountResponse smart constructor.
Constructors
| DecreaseReplicaCountResponse' (Maybe ReplicationGroup) Int |
Instances
newDecreaseReplicaCountResponse Source #
Create a value of DecreaseReplicaCountResponse 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:replicationGroup:DecreaseReplicaCountResponse', decreaseReplicaCountResponse_replicationGroup - Undocumented member.
$sel:httpStatus:DecreaseReplicaCountResponse', decreaseReplicaCountResponse_httpStatus - The response's http status code.
AddTagsToResource
data AddTagsToResource Source #
Represents the input of an AddTagsToResource operation.
See: newAddTagsToResource smart constructor.
Constructors
| AddTagsToResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> AddTagsToResource |
Create a value of AddTagsToResource 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:resourceName:AddTagsToResource', addTagsToResource_resourceName - The Amazon Resource Name (ARN) of the resource to which the tags are to
be added, for example
arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or
arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
ElastiCache resources are cluster and snapshot.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Service Namespaces.
$sel:tags:AddTagsToResource', addTagsToResource_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
data TagListMessage Source #
Represents the output from the AddTagsToResource,
ListTagsForResource, and RemoveTagsFromResource operations.
See: newTagListMessage smart constructor.
Constructors
| TagListMessage' (Maybe [Tag]) |
Instances
newTagListMessage :: TagListMessage Source #
Create a value of TagListMessage 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:tagList:TagListMessage', tagListMessage_tagList - A list of tags as key-value pairs.
AuthorizeCacheSecurityGroupIngress
data AuthorizeCacheSecurityGroupIngress Source #
Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
See: newAuthorizeCacheSecurityGroupIngress smart constructor.
Constructors
| AuthorizeCacheSecurityGroupIngress' Text Text Text |
Instances
newAuthorizeCacheSecurityGroupIngress Source #
Arguments
Create a value of AuthorizeCacheSecurityGroupIngress 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:cacheSecurityGroupName:AuthorizeCacheSecurityGroupIngress', authorizeCacheSecurityGroupIngress_cacheSecurityGroupName - The cache security group that allows network ingress.
$sel:eC2SecurityGroupName:AuthorizeCacheSecurityGroupIngress', authorizeCacheSecurityGroupIngress_eC2SecurityGroupName - The Amazon EC2 security group to be authorized for ingress to the cache
security group.
$sel:eC2SecurityGroupOwnerId:AuthorizeCacheSecurityGroupIngress', authorizeCacheSecurityGroupIngress_eC2SecurityGroupOwnerId - The Amazon account number of the Amazon EC2 security group owner. Note
that this is not the same thing as an Amazon access key ID - you must
provide a valid Amazon account number for this parameter.
data AuthorizeCacheSecurityGroupIngressResponse Source #
See: newAuthorizeCacheSecurityGroupIngressResponse smart constructor.
Instances
newAuthorizeCacheSecurityGroupIngressResponse Source #
Arguments
| :: Int | |
| -> AuthorizeCacheSecurityGroupIngressResponse |
Create a value of AuthorizeCacheSecurityGroupIngressResponse 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:cacheSecurityGroup:AuthorizeCacheSecurityGroupIngressResponse', authorizeCacheSecurityGroupIngressResponse_cacheSecurityGroup - Undocumented member.
$sel:httpStatus:AuthorizeCacheSecurityGroupIngressResponse', authorizeCacheSecurityGroupIngressResponse_httpStatus - The response's http status code.
CopySnapshot
data CopySnapshot Source #
Represents the input of a CopySnapshotMessage operation.
See: newCopySnapshot smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CopySnapshot |
Create a value of CopySnapshot 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:targetBucket:CopySnapshot', copySnapshot_targetBucket - The Amazon S3 bucket to which the snapshot is exported. This parameter
is used only when exporting a snapshot for external access.
When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.
$sel:kmsKeyId:CopySnapshot', copySnapshot_kmsKeyId - The ID of the KMS key used to encrypt the target snapshot.
$sel:tags:CopySnapshot', copySnapshot_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:sourceSnapshotName:CopySnapshot', copySnapshot_sourceSnapshotName - The name of an existing snapshot from which to make a copy.
$sel:targetSnapshotName:CopySnapshot', copySnapshot_targetSnapshotName - A name for the snapshot copy. ElastiCache does not permit overwriting a
snapshot, therefore this name must be unique within its context -
ElastiCache or an Amazon S3 bucket if exporting.
data CopySnapshotResponse Source #
See: newCopySnapshotResponse smart constructor.
Constructors
| CopySnapshotResponse' (Maybe Snapshot) Int |
Instances
newCopySnapshotResponse Source #
Arguments
| :: Int | |
| -> CopySnapshotResponse |
Create a value of CopySnapshotResponse 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:snapshot:CopySnapshotResponse', copySnapshotResponse_snapshot - Undocumented member.
$sel:httpStatus:CopySnapshotResponse', copySnapshotResponse_httpStatus - The response's http status code.
FailoverGlobalReplicationGroup
data FailoverGlobalReplicationGroup Source #
See: newFailoverGlobalReplicationGroup smart constructor.
Constructors
| FailoverGlobalReplicationGroup' Text Text Text |
Instances
newFailoverGlobalReplicationGroup Source #
Arguments
| :: Text |
|
| -> Text | |
| -> Text |
|
| -> FailoverGlobalReplicationGroup |
Create a value of FailoverGlobalReplicationGroup 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:globalReplicationGroupId:FailoverGlobalReplicationGroup', failoverGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:primaryRegion:FailoverGlobalReplicationGroup', failoverGlobalReplicationGroup_primaryRegion - The Amazon region of the primary cluster of the Global datastore
$sel:primaryReplicationGroupId:FailoverGlobalReplicationGroup', failoverGlobalReplicationGroup_primaryReplicationGroupId - The name of the primary replication group
data FailoverGlobalReplicationGroupResponse Source #
See: newFailoverGlobalReplicationGroupResponse smart constructor.
Instances
newFailoverGlobalReplicationGroupResponse Source #
Arguments
| :: Int | |
| -> FailoverGlobalReplicationGroupResponse |
Create a value of FailoverGlobalReplicationGroupResponse 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:globalReplicationGroup:FailoverGlobalReplicationGroupResponse', failoverGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:FailoverGlobalReplicationGroupResponse', failoverGlobalReplicationGroupResponse_httpStatus - The response's http status code.
CreateCacheSubnetGroup
data CreateCacheSubnetGroup Source #
Represents the input of a CreateCacheSubnetGroup operation.
See: newCreateCacheSubnetGroup smart constructor.
Instances
newCreateCacheSubnetGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateCacheSubnetGroup |
Create a value of CreateCacheSubnetGroup 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:tags:CreateCacheSubnetGroup', createCacheSubnetGroup_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:cacheSubnetGroupName:CreateCacheSubnetGroup', createCacheSubnetGroup_cacheSubnetGroupName - A name for the cache subnet group. This value is stored as a lowercase
string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
$sel:cacheSubnetGroupDescription:CreateCacheSubnetGroup', createCacheSubnetGroup_cacheSubnetGroupDescription - A description for the cache subnet group.
$sel:subnetIds:CreateCacheSubnetGroup', createCacheSubnetGroup_subnetIds - A list of VPC subnet IDs for the cache subnet group.
data CreateCacheSubnetGroupResponse Source #
See: newCreateCacheSubnetGroupResponse smart constructor.
Constructors
| CreateCacheSubnetGroupResponse' (Maybe CacheSubnetGroup) Int |
Instances
newCreateCacheSubnetGroupResponse Source #
Create a value of CreateCacheSubnetGroupResponse 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:cacheSubnetGroup:CreateCacheSubnetGroupResponse', createCacheSubnetGroupResponse_cacheSubnetGroup - Undocumented member.
$sel:httpStatus:CreateCacheSubnetGroupResponse', createCacheSubnetGroupResponse_httpStatus - The response's http status code.
CreateGlobalReplicationGroup
data CreateGlobalReplicationGroup Source #
See: newCreateGlobalReplicationGroup smart constructor.
Constructors
| CreateGlobalReplicationGroup' (Maybe Text) Text Text |
Instances
newCreateGlobalReplicationGroup Source #
Arguments
| :: Text |
|
| -> Text |
|
| -> CreateGlobalReplicationGroup |
Create a value of CreateGlobalReplicationGroup 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:globalReplicationGroupDescription:CreateGlobalReplicationGroup', createGlobalReplicationGroup_globalReplicationGroupDescription - Provides details of the Global datastore
$sel:globalReplicationGroupIdSuffix:CreateGlobalReplicationGroup', createGlobalReplicationGroup_globalReplicationGroupIdSuffix - The suffix name of a Global datastore. Amazon ElastiCache automatically
applies a prefix to the Global datastore ID when it is created. Each
Amazon Region has its own prefix. For instance, a Global datastore ID
created in the US-West-1 region will begin with "dsdfu" along with the
suffix name you provide. The suffix, combined with the auto-generated
prefix, guarantees uniqueness of the Global datastore name across
multiple regions.
For a full list of Amazon Regions and their respective Global datastore iD prefixes, see Using the Amazon CLI with Global datastores .
$sel:primaryReplicationGroupId:CreateGlobalReplicationGroup', createGlobalReplicationGroup_primaryReplicationGroupId - The name of the primary cluster that accepts writes and will replicate
updates to the secondary cluster.
data CreateGlobalReplicationGroupResponse Source #
See: newCreateGlobalReplicationGroupResponse smart constructor.
Constructors
| CreateGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int |
Instances
newCreateGlobalReplicationGroupResponse Source #
Arguments
| :: Int | |
| -> CreateGlobalReplicationGroupResponse |
Create a value of CreateGlobalReplicationGroupResponse 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:globalReplicationGroup:CreateGlobalReplicationGroupResponse', createGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:CreateGlobalReplicationGroupResponse', createGlobalReplicationGroupResponse_httpStatus - The response's http status code.
DescribeCacheParameterGroups (Paginated)
data DescribeCacheParameterGroups Source #
Represents the input of a DescribeCacheParameterGroups operation.
See: newDescribeCacheParameterGroups smart constructor.
Instances
newDescribeCacheParameterGroups :: DescribeCacheParameterGroups Source #
Create a value of DescribeCacheParameterGroups 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:cacheParameterGroupName:DescribeCacheParameterGroups', describeCacheParameterGroups_cacheParameterGroupName - The name of a specific cache parameter group to return details for.
$sel:marker:DescribeCacheParameterGroups', describeCacheParameterGroups_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeCacheParameterGroups', describeCacheParameterGroups_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
data DescribeCacheParameterGroupsResponse Source #
Represents the output of a DescribeCacheParameterGroups operation.
See: newDescribeCacheParameterGroupsResponse smart constructor.
Constructors
| DescribeCacheParameterGroupsResponse' (Maybe [CacheParameterGroup]) (Maybe Text) Int |
Instances
newDescribeCacheParameterGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeCacheParameterGroupsResponse |
Create a value of DescribeCacheParameterGroupsResponse 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:cacheParameterGroups:DescribeCacheParameterGroupsResponse', describeCacheParameterGroupsResponse_cacheParameterGroups - A list of cache parameter groups. Each element in the list contains
detailed information about one cache parameter group.
$sel:marker:DescribeCacheParameterGroups', describeCacheParameterGroupsResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:httpStatus:DescribeCacheParameterGroupsResponse', describeCacheParameterGroupsResponse_httpStatus - The response's http status code.
ResetCacheParameterGroup
data ResetCacheParameterGroup Source #
Represents the input of a ResetCacheParameterGroup operation.
See: newResetCacheParameterGroup smart constructor.
Constructors
| ResetCacheParameterGroup' (Maybe Bool) (Maybe [ParameterNameValue]) Text |
Instances
newResetCacheParameterGroup Source #
Create a value of ResetCacheParameterGroup 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:resetAllParameters:ResetCacheParameterGroup', resetCacheParameterGroup_resetAllParameters - If true, all parameters in the cache parameter group are reset to
their default values. If false, only the parameters listed by
ParameterNameValues are reset to their default values.
Valid values: true | false
$sel:parameterNameValues:ResetCacheParameterGroup', resetCacheParameterGroup_parameterNameValues - An array of parameter names to reset to their default values. If
ResetAllParameters is true, do not use ParameterNameValues. If
ResetAllParameters is false, you must specify the name of at least
one parameter to reset.
$sel:cacheParameterGroupName:ResetCacheParameterGroup', resetCacheParameterGroup_cacheParameterGroupName - The name of the cache parameter group to reset.
data CacheParameterGroupNameMessage Source #
Represents the output of one of the following operations:
ModifyCacheParameterGroup
ResetCacheParameterGroup
See: newCacheParameterGroupNameMessage smart constructor.
Constructors
| CacheParameterGroupNameMessage' (Maybe Text) |
Instances
newCacheParameterGroupNameMessage :: CacheParameterGroupNameMessage Source #
Create a value of CacheParameterGroupNameMessage 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:cacheParameterGroupName:CacheParameterGroupNameMessage', cacheParameterGroupNameMessage_cacheParameterGroupName - The name of the cache parameter group.
ListAllowedNodeTypeModifications
data ListAllowedNodeTypeModifications Source #
The input parameters for the ListAllowedNodeTypeModifications
operation.
See: newListAllowedNodeTypeModifications smart constructor.
Constructors
| ListAllowedNodeTypeModifications' (Maybe Text) (Maybe Text) |
Instances
newListAllowedNodeTypeModifications :: ListAllowedNodeTypeModifications Source #
Create a value of ListAllowedNodeTypeModifications 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:cacheClusterId:ListAllowedNodeTypeModifications', listAllowedNodeTypeModifications_cacheClusterId - The name of the cluster you want to scale up to a larger node instanced
type. ElastiCache uses the cluster id to identify the current node type
of this cluster and from that to create a list of node types you can
scale up to.
You must provide a value for either the CacheClusterId or the
ReplicationGroupId.
$sel:replicationGroupId:ListAllowedNodeTypeModifications', listAllowedNodeTypeModifications_replicationGroupId - The name of the replication group want to scale up to a larger node
type. ElastiCache uses the replication group id to identify the current
node type being used by this replication group, and from that to create
a list of node types you can scale up to.
You must provide a value for either the CacheClusterId or the
ReplicationGroupId.
data ListAllowedNodeTypeModificationsResponse Source #
Represents the allowed node types you can use to modify your cluster or replication group.
See: newListAllowedNodeTypeModificationsResponse smart constructor.
Instances
newListAllowedNodeTypeModificationsResponse Source #
Arguments
| :: Int | |
| -> ListAllowedNodeTypeModificationsResponse |
Create a value of ListAllowedNodeTypeModificationsResponse 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:scaleUpModifications:ListAllowedNodeTypeModificationsResponse', listAllowedNodeTypeModificationsResponse_scaleUpModifications - A string list, each element of which specifies a cache node type which
you can use to scale your cluster or replication group.
When scaling up a Redis cluster or replication group using
ModifyCacheCluster or ModifyReplicationGroup, use a value from this
list for the CacheNodeType parameter.
$sel:scaleDownModifications:ListAllowedNodeTypeModificationsResponse', listAllowedNodeTypeModificationsResponse_scaleDownModifications - A string list, each element of which specifies a cache node type which
you can use to scale your cluster or replication group. When scaling
down a Redis cluster or replication group using ModifyCacheCluster or
ModifyReplicationGroup, use a value from this list for the CacheNodeType
parameter.
$sel:httpStatus:ListAllowedNodeTypeModificationsResponse', listAllowedNodeTypeModificationsResponse_httpStatus - The response's http status code.
IncreaseReplicaCount
data IncreaseReplicaCount Source #
See: newIncreaseReplicaCount smart constructor.
Constructors
| IncreaseReplicaCount' (Maybe Int) (Maybe [ConfigureShard]) Text Bool |
Instances
newIncreaseReplicaCount Source #
Arguments
| :: Text | |
| -> Bool | |
| -> IncreaseReplicaCount |
Create a value of IncreaseReplicaCount 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:newReplicaCount':IncreaseReplicaCount', increaseReplicaCount_newReplicaCount - The number of read replica nodes you want at the completion of this
operation. For Redis (cluster mode disabled) replication groups, this is
the number of replica nodes in the replication group. For Redis (cluster
mode enabled) replication groups, this is the number of replica nodes in
each of the replication group's node groups.
$sel:replicaConfiguration:IncreaseReplicaCount', increaseReplicaCount_replicaConfiguration - A list of ConfigureShard objects that can be used to configure each
shard in a Redis (cluster mode enabled) replication group. The
ConfigureShard has three members: NewReplicaCount, NodeGroupId,
and PreferredAvailabilityZones.
$sel:replicationGroupId:IncreaseReplicaCount', increaseReplicaCount_replicationGroupId - The id of the replication group to which you want to add replica nodes.
$sel:applyImmediately:IncreaseReplicaCount', increaseReplicaCount_applyImmediately - If True, the number of replica nodes is increased immediately.
ApplyImmediately=False is not currently supported.
data IncreaseReplicaCountResponse Source #
See: newIncreaseReplicaCountResponse smart constructor.
Constructors
| IncreaseReplicaCountResponse' (Maybe ReplicationGroup) Int |
Instances
newIncreaseReplicaCountResponse Source #
Create a value of IncreaseReplicaCountResponse 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:replicationGroup:IncreaseReplicaCountResponse', increaseReplicaCountResponse_replicationGroup - Undocumented member.
$sel:httpStatus:IncreaseReplicaCountResponse', increaseReplicaCountResponse_httpStatus - The response's http status code.
ModifyReplicationGroupShardConfiguration
data ModifyReplicationGroupShardConfiguration Source #
Represents the input for a ModifyReplicationGroupShardConfiguration
operation.
See: newModifyReplicationGroupShardConfiguration smart constructor.
Constructors
| ModifyReplicationGroupShardConfiguration' (Maybe [Text]) (Maybe [ReshardingConfiguration]) (Maybe [Text]) Text Int Bool |
Instances
newModifyReplicationGroupShardConfiguration Source #
Arguments
Create a value of ModifyReplicationGroupShardConfiguration 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:nodeGroupsToRetain:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_nodeGroupsToRetain - If the value of NodeGroupCount is less than the current number of node
groups (shards), then either NodeGroupsToRemove or
NodeGroupsToRetain is required. NodeGroupsToRetain is a list of
NodeGroupIds to retain in the cluster.
ElastiCache for Redis will attempt to remove all node groups except
those listed by NodeGroupsToRetain from the cluster.
$sel:reshardingConfiguration:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_reshardingConfiguration - Specifies the preferred availability zones for each node group in the
cluster. If the value of NodeGroupCount is greater than the current
number of node groups (shards), you can use this parameter to specify
the preferred availability zones of the cluster's shards. If you omit
this parameter ElastiCache selects availability zones for you.
You can specify this parameter only if the value of NodeGroupCount is
greater than the current number of node groups (shards).
$sel:nodeGroupsToRemove:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_nodeGroupsToRemove - If the value of NodeGroupCount is less than the current number of node
groups (shards), then either NodeGroupsToRemove or
NodeGroupsToRetain is required. NodeGroupsToRemove is a list of
NodeGroupIds to remove from the cluster.
ElastiCache for Redis will attempt to remove all node groups listed by
NodeGroupsToRemove from the cluster.
$sel:replicationGroupId:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_replicationGroupId - The name of the Redis (cluster mode enabled) cluster (replication group)
on which the shards are to be configured.
$sel:nodeGroupCount:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_nodeGroupCount - The number of node groups (shards) that results from the modification of
the shard configuration.
$sel:applyImmediately:ModifyReplicationGroupShardConfiguration', modifyReplicationGroupShardConfiguration_applyImmediately - Indicates that the shard reconfiguration process begins immediately. At
present, the only permitted value for this parameter is true.
Value: true
data ModifyReplicationGroupShardConfigurationResponse Source #
See: newModifyReplicationGroupShardConfigurationResponse smart constructor.
Instances
newModifyReplicationGroupShardConfigurationResponse Source #
Arguments
| :: Int |
|
| -> ModifyReplicationGroupShardConfigurationResponse |
Create a value of ModifyReplicationGroupShardConfigurationResponse 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:replicationGroup:ModifyReplicationGroupShardConfigurationResponse', modifyReplicationGroupShardConfigurationResponse_replicationGroup - Undocumented member.
$sel:httpStatus:ModifyReplicationGroupShardConfigurationResponse', modifyReplicationGroupShardConfigurationResponse_httpStatus - The response's http status code.
BatchApplyUpdateAction
data BatchApplyUpdateAction Source #
See: newBatchApplyUpdateAction smart constructor.
Instances
newBatchApplyUpdateAction Source #
Create a value of BatchApplyUpdateAction 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:cacheClusterIds:BatchApplyUpdateAction', batchApplyUpdateAction_cacheClusterIds - The cache cluster IDs
$sel:replicationGroupIds:BatchApplyUpdateAction', batchApplyUpdateAction_replicationGroupIds - The replication group IDs
$sel:serviceUpdateName:BatchApplyUpdateAction', batchApplyUpdateAction_serviceUpdateName - The unique ID of the service update
data UpdateActionResultsMessage Source #
See: newUpdateActionResultsMessage smart constructor.
Constructors
| UpdateActionResultsMessage' (Maybe [UnprocessedUpdateAction]) (Maybe [ProcessedUpdateAction]) |
Instances
newUpdateActionResultsMessage :: UpdateActionResultsMessage Source #
Create a value of UpdateActionResultsMessage 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:unprocessedUpdateActions:UpdateActionResultsMessage', updateActionResultsMessage_unprocessedUpdateActions - Update actions that haven't been processed successfully
$sel:processedUpdateActions:UpdateActionResultsMessage', updateActionResultsMessage_processedUpdateActions - Update actions that have been processed successfully
DeleteUserGroup
data DeleteUserGroup Source #
See: newDeleteUserGroup smart constructor.
Constructors
| DeleteUserGroup' Text |
Instances
Arguments
| :: Text | |
| -> DeleteUserGroup |
Create a value of DeleteUserGroup 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:userGroupId:DeleteUserGroup', deleteUserGroup_userGroupId - The ID of the user group.
See: newUserGroup smart constructor.
Constructors
| UserGroup' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserGroupPendingChanges) (Maybe [Text]) |
Instances
newUserGroup :: UserGroup Source #
Create a value of UserGroup 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:status:UserGroup', userGroup_status - Indicates user group status. Can be "creating", "active",
"modifying", "deleting".
$sel:userIds:UserGroup', userGroup_userIds - The list of user IDs that belong to the user group.
$sel:arn:UserGroup', userGroup_arn - The Amazon Resource Name (ARN) of the user group.
$sel:userGroupId:UserGroup', userGroup_userGroupId - The ID of the user group.
$sel:engine:UserGroup', userGroup_engine - The current supported value is Redis.
$sel:pendingChanges:UserGroup', userGroup_pendingChanges - A list of updates being applied to the user group.
$sel:replicationGroups:UserGroup', userGroup_replicationGroups - A list of replication groups that the user group can access.
DescribeServiceUpdates (Paginated)
data DescribeServiceUpdates Source #
See: newDescribeServiceUpdates smart constructor.
Constructors
| DescribeServiceUpdates' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe [ServiceUpdateStatus]) |
Instances
newDescribeServiceUpdates :: DescribeServiceUpdates Source #
Create a value of DescribeServiceUpdates 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:serviceUpdateName:DescribeServiceUpdates', describeServiceUpdates_serviceUpdateName - The unique ID of the service update
$sel:marker:DescribeServiceUpdates', describeServiceUpdates_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeServiceUpdates', describeServiceUpdates_maxRecords - The maximum number of records to include in the response
$sel:serviceUpdateStatus:DescribeServiceUpdates', describeServiceUpdates_serviceUpdateStatus - The status of the service update
data DescribeServiceUpdatesResponse Source #
See: newDescribeServiceUpdatesResponse smart constructor.
Constructors
| DescribeServiceUpdatesResponse' (Maybe [ServiceUpdate]) (Maybe Text) Int |
Instances
newDescribeServiceUpdatesResponse Source #
Create a value of DescribeServiceUpdatesResponse 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:serviceUpdates:DescribeServiceUpdatesResponse', describeServiceUpdatesResponse_serviceUpdates - A list of service updates
$sel:marker:DescribeServiceUpdates', describeServiceUpdatesResponse_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:httpStatus:DescribeServiceUpdatesResponse', describeServiceUpdatesResponse_httpStatus - The response's http status code.
DescribeSnapshots (Paginated)
data DescribeSnapshots Source #
Represents the input of a DescribeSnapshotsMessage operation.
See: newDescribeSnapshots smart constructor.
Constructors
| DescribeSnapshots' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) |
Instances
newDescribeSnapshots :: DescribeSnapshots Source #
Create a value of DescribeSnapshots 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:cacheClusterId:DescribeSnapshots', describeSnapshots_cacheClusterId - A user-supplied cluster identifier. If this parameter is specified, only
snapshots associated with that specific cluster are described.
$sel:marker:DescribeSnapshots', describeSnapshots_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeSnapshots', describeSnapshots_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 50
Constraints: minimum 20; maximum 50.
$sel:snapshotName:DescribeSnapshots', describeSnapshots_snapshotName - A user-supplied name of the snapshot. If this parameter is specified,
only this snapshot are described.
$sel:showNodeGroupConfig:DescribeSnapshots', describeSnapshots_showNodeGroupConfig - A Boolean value which if true, the node group (shard) configuration is
included in the snapshot description.
$sel:replicationGroupId:DescribeSnapshots', describeSnapshots_replicationGroupId - A user-supplied replication group identifier. If this parameter is
specified, only snapshots associated with that specific replication
group are described.
$sel:snapshotSource:DescribeSnapshots', describeSnapshots_snapshotSource - If set to system, the output shows snapshots that were automatically
created by ElastiCache. If set to user the output shows snapshots that
were manually created. If omitted, the output shows both automatically
and manually created snapshots.
data DescribeSnapshotsResponse Source #
Represents the output of a DescribeSnapshots operation.
See: newDescribeSnapshotsResponse smart constructor.
Instances
newDescribeSnapshotsResponse Source #
Create a value of DescribeSnapshotsResponse 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:snapshots:DescribeSnapshotsResponse', describeSnapshotsResponse_snapshots - A list of snapshots. Each item in the list contains detailed information
about one snapshot.
$sel:marker:DescribeSnapshots', describeSnapshotsResponse_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:httpStatus:DescribeSnapshotsResponse', describeSnapshotsResponse_httpStatus - The response's http status code.
DescribeReplicationGroups (Paginated)
data DescribeReplicationGroups Source #
Represents the input of a DescribeReplicationGroups operation.
See: newDescribeReplicationGroups smart constructor.
Instances
newDescribeReplicationGroups :: DescribeReplicationGroups Source #
Create a value of DescribeReplicationGroups 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:marker:DescribeReplicationGroups', describeReplicationGroups_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeReplicationGroups', describeReplicationGroups_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
$sel:replicationGroupId:DescribeReplicationGroups', describeReplicationGroups_replicationGroupId - The identifier for the replication group to be described. This parameter
is not case sensitive.
If you do not specify this parameter, information about all replication groups is returned.
data DescribeReplicationGroupsResponse Source #
Represents the output of a DescribeReplicationGroups operation.
See: newDescribeReplicationGroupsResponse smart constructor.
Constructors
| DescribeReplicationGroupsResponse' (Maybe Text) (Maybe [ReplicationGroup]) Int |
Instances
newDescribeReplicationGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeReplicationGroupsResponse |
Create a value of DescribeReplicationGroupsResponse 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:marker:DescribeReplicationGroups', describeReplicationGroupsResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:replicationGroups:DescribeReplicationGroupsResponse', describeReplicationGroupsResponse_replicationGroups - A list of replication groups. Each item in the list contains detailed
information about one replication group.
$sel:httpStatus:DescribeReplicationGroupsResponse', describeReplicationGroupsResponse_httpStatus - The response's http status code.
CreateUser
data CreateUser Source #
See: newCreateUser smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> CreateUser |
Create a value of CreateUser 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:passwords:CreateUser', createUser_passwords - Passwords used for this user. You can create up to two passwords for
each user.
$sel:noPasswordRequired:CreateUser', createUser_noPasswordRequired - Indicates a password is not required for this user.
$sel:tags:CreateUser', createUser_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:userId:CreateUser', createUser_userId - The ID of the user.
$sel:userName:CreateUser', createUser_userName - The username of the user.
$sel:engine:CreateUser', createUser_engine - The current supported value is Redis.
$sel:accessString:CreateUser', createUser_accessString - Access permissions string used for this user.
See: newUser smart constructor.
Constructors
| User' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
Create a value of User 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:status:User', user_status - Indicates the user status. Can be "active", "modifying" or
"deleting".
$sel:arn:User', user_arn - The Amazon Resource Name (ARN) of the user.
$sel:userGroupIds:User', user_userGroupIds - Returns a list of the user group IDs the user belongs to.
$sel:authentication:User', user_authentication - Denotes whether the user requires a password to authenticate.
$sel:engine:User', user_engine - The current supported value is Redis.
$sel:userName:User', user_userName - The username of the user.
$sel:accessString:User', user_accessString - Access permissions string used for this user.
$sel:userId:User', user_userId - The ID of the user.
DeleteSnapshot
data DeleteSnapshot Source #
Represents the input of a DeleteSnapshot operation.
See: newDeleteSnapshot smart constructor.
Constructors
| DeleteSnapshot' Text |
Instances
Arguments
| :: Text | |
| -> DeleteSnapshot |
Create a value of DeleteSnapshot 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:snapshotName:DeleteSnapshot', deleteSnapshot_snapshotName - The name of the snapshot to be deleted.
data DeleteSnapshotResponse Source #
See: newDeleteSnapshotResponse smart constructor.
Constructors
| DeleteSnapshotResponse' (Maybe Snapshot) Int |
Instances
newDeleteSnapshotResponse Source #
Create a value of DeleteSnapshotResponse 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:snapshot:DeleteSnapshotResponse', deleteSnapshotResponse_snapshot - Undocumented member.
$sel:httpStatus:DeleteSnapshotResponse', deleteSnapshotResponse_httpStatus - The response's http status code.
DescribeReservedCacheNodesOfferings (Paginated)
data DescribeReservedCacheNodesOfferings Source #
Represents the input of a DescribeReservedCacheNodesOfferings
operation.
See: newDescribeReservedCacheNodesOfferings smart constructor.
Constructors
| DescribeReservedCacheNodesOfferings' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDescribeReservedCacheNodesOfferings :: DescribeReservedCacheNodesOfferings Source #
Create a value of DescribeReservedCacheNodesOfferings 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:cacheNodeType:DescribeReservedCacheNodesOfferings', describeReservedCacheNodesOfferings_cacheNodeType - The cache node type filter value. Use this parameter to show only the
available offerings matching the specified cache node type.
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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
$sel:productDescription:DescribeReservedCacheNodesOfferings', describeReservedCacheNodesOfferings_productDescription - The product description filter value. Use this parameter to show only
the available offerings matching the specified product description.
$sel:marker:DescribeReservedCacheNodesOfferings', describeReservedCacheNodesOfferings_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeReservedCacheNodesOfferings', describeReservedCacheNodesOfferings_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
$sel:offeringType:DescribeReservedCacheNodesOfferings', describeReservedCacheNodesOfferings_offeringType - The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type.
Valid Values:
"Light Utilization"|"Medium Utilization"|"Heavy Utilization" |"All Upfront"|"Partial Upfront"| "No Upfront"
$sel:duration:DescribeReservedCacheNodesOfferings', describeReservedCacheNodesOfferings_duration - Duration filter value, specified in years or seconds. Use this parameter
to show only reservations for a given duration.
Valid Values: 1 | 3 | 31536000 | 94608000
$sel:reservedCacheNodesOfferingId:DescribeReservedCacheNodesOfferings', describeReservedCacheNodesOfferings_reservedCacheNodesOfferingId - The offering identifier filter value. Use this parameter to show only
the available offering that matches the specified reservation
identifier.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
data DescribeReservedCacheNodesOfferingsResponse Source #
Represents the output of a DescribeReservedCacheNodesOfferings
operation.
See: newDescribeReservedCacheNodesOfferingsResponse smart constructor.
Constructors
| DescribeReservedCacheNodesOfferingsResponse' (Maybe Text) (Maybe [ReservedCacheNodesOffering]) Int |
Instances
newDescribeReservedCacheNodesOfferingsResponse Source #
Arguments
| :: Int |
|
| -> DescribeReservedCacheNodesOfferingsResponse |
Create a value of DescribeReservedCacheNodesOfferingsResponse 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:marker:DescribeReservedCacheNodesOfferings', describeReservedCacheNodesOfferingsResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:reservedCacheNodesOfferings:DescribeReservedCacheNodesOfferingsResponse', describeReservedCacheNodesOfferingsResponse_reservedCacheNodesOfferings - A list of reserved cache node offerings. Each element in the list
contains detailed information about one offering.
$sel:httpStatus:DescribeReservedCacheNodesOfferingsResponse', describeReservedCacheNodesOfferingsResponse_httpStatus - The response's http status code.
ModifyCacheSubnetGroup
data ModifyCacheSubnetGroup Source #
Represents the input of a ModifyCacheSubnetGroup operation.
See: newModifyCacheSubnetGroup smart constructor.
Instances
newModifyCacheSubnetGroup Source #
Create a value of ModifyCacheSubnetGroup 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:subnetIds:ModifyCacheSubnetGroup', modifyCacheSubnetGroup_subnetIds - The EC2 subnet IDs for the cache subnet group.
$sel:cacheSubnetGroupDescription:ModifyCacheSubnetGroup', modifyCacheSubnetGroup_cacheSubnetGroupDescription - A description of the cache subnet group.
$sel:cacheSubnetGroupName:ModifyCacheSubnetGroup', modifyCacheSubnetGroup_cacheSubnetGroupName - The name for the cache subnet group. This value is stored as a lowercase
string.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
Example: mysubnetgroup
data ModifyCacheSubnetGroupResponse Source #
See: newModifyCacheSubnetGroupResponse smart constructor.
Constructors
| ModifyCacheSubnetGroupResponse' (Maybe CacheSubnetGroup) Int |
Instances
newModifyCacheSubnetGroupResponse Source #
Create a value of ModifyCacheSubnetGroupResponse 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:cacheSubnetGroup:ModifyCacheSubnetGroupResponse', modifyCacheSubnetGroupResponse_cacheSubnetGroup - Undocumented member.
$sel:httpStatus:ModifyCacheSubnetGroupResponse', modifyCacheSubnetGroupResponse_httpStatus - The response's http status code.
DeleteUser
data DeleteUser Source #
See: newDeleteUser smart constructor.
Constructors
| DeleteUser' Text |
Instances
Arguments
| :: Text | |
| -> DeleteUser |
Create a value of DeleteUser 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:userId:DeleteUser', deleteUser_userId - The ID of the user.
See: newUser smart constructor.
Constructors
| User' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
Create a value of User 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:status:User', user_status - Indicates the user status. Can be "active", "modifying" or
"deleting".
$sel:arn:User', user_arn - The Amazon Resource Name (ARN) of the user.
$sel:userGroupIds:User', user_userGroupIds - Returns a list of the user group IDs the user belongs to.
$sel:authentication:User', user_authentication - Denotes whether the user requires a password to authenticate.
$sel:engine:User', user_engine - The current supported value is Redis.
$sel:userName:User', user_userName - The username of the user.
$sel:accessString:User', user_accessString - Access permissions string used for this user.
$sel:userId:User', user_userId - The ID of the user.
CreateSnapshot
data CreateSnapshot Source #
Represents the input of a CreateSnapshot operation.
See: newCreateSnapshot smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateSnapshot |
Create a value of CreateSnapshot 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:cacheClusterId:CreateSnapshot', createSnapshot_cacheClusterId - The identifier of an existing cluster. The snapshot is created from this
cluster.
$sel:kmsKeyId:CreateSnapshot', createSnapshot_kmsKeyId - The ID of the KMS key used to encrypt the snapshot.
$sel:replicationGroupId:CreateSnapshot', createSnapshot_replicationGroupId - The identifier of an existing replication group. The snapshot is created
from this replication group.
$sel:tags:CreateSnapshot', createSnapshot_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:snapshotName:CreateSnapshot', createSnapshot_snapshotName - A name for the snapshot being created.
data CreateSnapshotResponse Source #
See: newCreateSnapshotResponse smart constructor.
Constructors
| CreateSnapshotResponse' (Maybe Snapshot) Int |
Instances
newCreateSnapshotResponse Source #
Create a value of CreateSnapshotResponse 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:snapshot:CreateSnapshotResponse', createSnapshotResponse_snapshot - Undocumented member.
$sel:httpStatus:CreateSnapshotResponse', createSnapshotResponse_httpStatus - The response's http status code.
ModifyGlobalReplicationGroup
data ModifyGlobalReplicationGroup Source #
See: newModifyGlobalReplicationGroup smart constructor.
Constructors
| ModifyGlobalReplicationGroup' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Bool |
Instances
newModifyGlobalReplicationGroup Source #
Arguments
| :: Text | |
| -> Bool | |
| -> ModifyGlobalReplicationGroup |
Create a value of ModifyGlobalReplicationGroup 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:automaticFailoverEnabled:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_automaticFailoverEnabled - Determines whether a read replica is automatically promoted to
read/write primary if the existing primary encounters a failure.
$sel:engineVersion:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_engineVersion - The upgraded version of the cache engine to be run on the clusters in
the Global datastore.
$sel:cacheNodeType:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_cacheNodeType - A valid cache node type that you want to scale this Global datastore to.
$sel:cacheParameterGroupName:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_cacheParameterGroupName - The name of the cache parameter group to use with the Global datastore.
It must be compatible with the major engine version used by the Global
datastore.
$sel:globalReplicationGroupDescription:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_globalReplicationGroupDescription - A description of the Global datastore
$sel:globalReplicationGroupId:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:applyImmediately:ModifyGlobalReplicationGroup', modifyGlobalReplicationGroup_applyImmediately - This parameter causes the modifications in this request and any pending
modifications to be applied, asynchronously and as soon as possible.
Modifications to Global Replication Groups cannot be requested to be
applied in PreferredMaintenceWindow.
data ModifyGlobalReplicationGroupResponse Source #
See: newModifyGlobalReplicationGroupResponse smart constructor.
Constructors
| ModifyGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int |
Instances
newModifyGlobalReplicationGroupResponse Source #
Arguments
| :: Int | |
| -> ModifyGlobalReplicationGroupResponse |
Create a value of ModifyGlobalReplicationGroupResponse 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:globalReplicationGroup:ModifyGlobalReplicationGroupResponse', modifyGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:ModifyGlobalReplicationGroupResponse', modifyGlobalReplicationGroupResponse_httpStatus - The response's http status code.
DescribeUserGroups (Paginated)
data DescribeUserGroups Source #
See: newDescribeUserGroups smart constructor.
Instances
newDescribeUserGroups :: DescribeUserGroups Source #
Create a value of DescribeUserGroups 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:userGroupId:DescribeUserGroups', describeUserGroups_userGroupId - The ID of the user group.
$sel:marker:DescribeUserGroups', describeUserGroups_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords. >
$sel:maxRecords:DescribeUserGroups', describeUserGroups_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is included
in the response so that the remaining results can be retrieved.
data DescribeUserGroupsResponse Source #
See: newDescribeUserGroupsResponse smart constructor.
Instances
newDescribeUserGroupsResponse Source #
Create a value of DescribeUserGroupsResponse 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:userGroups:DescribeUserGroupsResponse', describeUserGroupsResponse_userGroups - Returns a list of user groups.
$sel:marker:DescribeUserGroups', describeUserGroupsResponse_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords. >
$sel:httpStatus:DescribeUserGroupsResponse', describeUserGroupsResponse_httpStatus - The response's http status code.
DeleteCacheParameterGroup
data DeleteCacheParameterGroup Source #
Represents the input of a DeleteCacheParameterGroup operation.
See: newDeleteCacheParameterGroup smart constructor.
Constructors
| DeleteCacheParameterGroup' Text |
Instances
newDeleteCacheParameterGroup Source #
Create a value of DeleteCacheParameterGroup 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:cacheParameterGroupName:DeleteCacheParameterGroup', deleteCacheParameterGroup_cacheParameterGroupName - The name of the cache parameter group to delete.
The specified cache security group must not be associated with any clusters.
data DeleteCacheParameterGroupResponse Source #
See: newDeleteCacheParameterGroupResponse smart constructor.
Constructors
| DeleteCacheParameterGroupResponse' | |
Instances
newDeleteCacheParameterGroupResponse :: DeleteCacheParameterGroupResponse Source #
Create a value of DeleteCacheParameterGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeCacheSecurityGroups (Paginated)
data DescribeCacheSecurityGroups Source #
Represents the input of a DescribeCacheSecurityGroups operation.
See: newDescribeCacheSecurityGroups smart constructor.
Instances
newDescribeCacheSecurityGroups :: DescribeCacheSecurityGroups Source #
Create a value of DescribeCacheSecurityGroups 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:cacheSecurityGroupName:DescribeCacheSecurityGroups', describeCacheSecurityGroups_cacheSecurityGroupName - The name of the cache security group to return details for.
$sel:marker:DescribeCacheSecurityGroups', describeCacheSecurityGroups_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeCacheSecurityGroups', describeCacheSecurityGroups_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
data DescribeCacheSecurityGroupsResponse Source #
Represents the output of a DescribeCacheSecurityGroups operation.
See: newDescribeCacheSecurityGroupsResponse smart constructor.
Constructors
| DescribeCacheSecurityGroupsResponse' (Maybe [CacheSecurityGroup]) (Maybe Text) Int |
Instances
newDescribeCacheSecurityGroupsResponse Source #
Arguments
| :: Int | |
| -> DescribeCacheSecurityGroupsResponse |
Create a value of DescribeCacheSecurityGroupsResponse 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:cacheSecurityGroups:DescribeCacheSecurityGroupsResponse', describeCacheSecurityGroupsResponse_cacheSecurityGroups - A list of cache security groups. Each element in the list contains
detailed information about one group.
$sel:marker:DescribeCacheSecurityGroups', describeCacheSecurityGroupsResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:httpStatus:DescribeCacheSecurityGroupsResponse', describeCacheSecurityGroupsResponse_httpStatus - The response's http status code.
BatchStopUpdateAction
data BatchStopUpdateAction Source #
See: newBatchStopUpdateAction smart constructor.
Instances
newBatchStopUpdateAction Source #
Create a value of BatchStopUpdateAction 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:cacheClusterIds:BatchStopUpdateAction', batchStopUpdateAction_cacheClusterIds - The cache cluster IDs
$sel:replicationGroupIds:BatchStopUpdateAction', batchStopUpdateAction_replicationGroupIds - The replication group IDs
$sel:serviceUpdateName:BatchStopUpdateAction', batchStopUpdateAction_serviceUpdateName - The unique ID of the service update
data UpdateActionResultsMessage Source #
See: newUpdateActionResultsMessage smart constructor.
Constructors
| UpdateActionResultsMessage' (Maybe [UnprocessedUpdateAction]) (Maybe [ProcessedUpdateAction]) |
Instances
newUpdateActionResultsMessage :: UpdateActionResultsMessage Source #
Create a value of UpdateActionResultsMessage 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:unprocessedUpdateActions:UpdateActionResultsMessage', updateActionResultsMessage_unprocessedUpdateActions - Update actions that haven't been processed successfully
$sel:processedUpdateActions:UpdateActionResultsMessage', updateActionResultsMessage_processedUpdateActions - Update actions that have been processed successfully
ModifyCacheCluster
data ModifyCacheCluster Source #
Represents the input of a ModifyCacheCluster operation.
See: newModifyCacheCluster smart constructor.
Constructors
| ModifyCacheCluster' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [LogDeliveryConfigurationRequest]) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe AZMode) (Maybe Bool) (Maybe AuthTokenUpdateStrategyType) (Maybe Text) (Maybe Int) (Maybe [Text]) Text |
Instances
newModifyCacheCluster Source #
Create a value of ModifyCacheCluster 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:engineVersion:ModifyCacheCluster', modifyCacheCluster_engineVersion - The upgraded version of the cache engine to be run on the cache nodes.
Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.
$sel:cacheNodeType:ModifyCacheCluster', modifyCacheCluster_cacheNodeType - A valid cache node type that you want to scale this cluster up to.
$sel:securityGroupIds:ModifyCacheCluster', modifyCacheCluster_securityGroupIds - Specifies the VPC Security Groups associated with the cluster.
This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
$sel:autoMinorVersionUpgrade:ModifyCacheCluster', modifyCacheCluster_autoMinorVersionUpgrade - This parameter is currently disabled.
$sel:cacheParameterGroupName:ModifyCacheCluster', modifyCacheCluster_cacheParameterGroupName - The name of the cache parameter group to apply to this cluster. This
change is asynchronously applied as soon as possible for parameters when
the ApplyImmediately parameter is specified as true for this
request.
$sel:snapshotWindow:ModifyCacheCluster', modifyCacheCluster_snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a
daily snapshot of your cluster.
$sel:newAvailabilityZones':ModifyCacheCluster', modifyCacheCluster_newAvailabilityZones - This option is only supported on Memcached clusters.
The list of Availability Zones where the new Memcached cache nodes are created.
This parameter is only valid when NumCacheNodes in the request is
greater than the sum of the number of active cache nodes and the number
of cache nodes pending creation (which may be zero). The number of
Availability Zones supplied in this list must match the cache nodes
being added in this request.
Scenarios:
- Scenario 1: You have 3 active nodes and wish to add 2 nodes.
Specify
NumCacheNodes=5(3 + 2) and optionally specify two Availability Zones for the two new nodes. - Scenario 2: You have 3 active nodes and 2 nodes pending creation
(from the scenario 1 call) and want to add 1 more node. Specify
NumCacheNodes=6((3 + 2) + 1) and optionally specify an Availability Zone for the new node. - Scenario 3: You want to cancel all pending operations. Specify
NumCacheNodes=3to cancel all pending operations.
The Availability Zone placement of nodes pending creation cannot be
modified. If you wish to cancel any nodes pending creation, add 0 nodes
by setting NumCacheNodes to the number of current nodes.
If cross-az is specified, existing Memcached nodes remain in their
current Availability Zone. Only newly created nodes can be located in
different Availability Zones. For guidance on how to move existing
Memcached nodes to different Availability Zones, see the __Availability
Zone Considerations__ section of
Cache Node Considerations for Memcached.
Impact of new add/remove requests upon pending requests
Scenario-1
- Pending Action: Delete
- New Request: Delete
- Result: The new delete, pending or immediate, replaces the pending delete.
Scenario-2
- Pending Action: Delete
- New Request: Create
- Result: The new create, pending or immediate, replaces the pending delete.
Scenario-3
- Pending Action: Create
- New Request: Delete
- Result: The new delete, pending or immediate, replaces the pending create.
Scenario-4
- Pending Action: Create
- New Request: Create
Result: The new create is added to the pending create.
Important: If the new create request is __Apply Immediately - Yes__, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
$sel:logDeliveryConfigurations:ModifyCacheCluster', modifyCacheCluster_logDeliveryConfigurations - Specifies the destination, format and type of the logs.
$sel:authToken:ModifyCacheCluster', modifyCacheCluster_authToken - Reserved parameter. The password used to access a password protected
server. This parameter must be specified with the auth-token-update
parameter. Password constraints:
- Must be only printable ASCII characters
- Must be at least 16 characters and no more than 128 characters in length
- Cannot contain any of the following characters: '/', '"', or '@', '%'
For more information, see AUTH password at AUTH.
$sel:preferredMaintenanceWindow:ModifyCacheCluster', modifyCacheCluster_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster
is performed. It is specified as a range in the format
ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
$sel:cacheNodeIdsToRemove:ModifyCacheCluster', modifyCacheCluster_cacheNodeIdsToRemove - A list of cache node IDs to be removed. A node ID is a numeric
identifier (0001, 0002, etc.). This parameter is only valid when
NumCacheNodes is less than the existing number of cache nodes. The
number of cache node IDs supplied in this parameter must match the
difference between the existing number of cache nodes in the cluster or
pending cache nodes, whichever is greater, and the value of
NumCacheNodes in the request.
For example: If you have 3 active cache nodes, 7 pending cache nodes,
and the number of cache nodes in this ModifyCacheCluster call is 5,
you must list 2 (7 - 5) cache node IDs to remove.
$sel:snapshotRetentionLimit:ModifyCacheCluster', modifyCacheCluster_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic cluster
snapshots before deleting them. For example, if you set
SnapshotRetentionLimit to 5, a snapshot that was taken today is
retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are
turned off.
$sel:notificationTopicStatus:ModifyCacheCluster', modifyCacheCluster_notificationTopicStatus - The status of the Amazon SNS notification topic. Notifications are sent
only if the status is active.
Valid values: active | inactive
$sel:aZMode:ModifyCacheCluster', modifyCacheCluster_aZMode - Specifies whether the new nodes in this Memcached cluster are all
created in a single Availability Zone or created across multiple
Availability Zones.
Valid values: single-az | cross-az.
This option is only supported for Memcached clusters.
You cannot specify single-az if the Memcached cluster already has
cache nodes in different Availability Zones. If cross-az is specified,
existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes are located in different Availability Zones.
$sel:applyImmediately:ModifyCacheCluster', modifyCacheCluster_applyImmediately - If true, this parameter causes the modifications in this request and
any pending modifications to be applied, asynchronously and as soon as
possible, regardless of the PreferredMaintenanceWindow setting for the
cluster.
If false, changes to the cluster are applied on the next maintenance
reboot, or the next failure reboot, whichever occurs first.
If you perform a ModifyCacheCluster before a pending modification is
applied, the pending modification is replaced by the newer modification.
Valid values: true | false
Default: false
$sel:authTokenUpdateStrategy:ModifyCacheCluster', modifyCacheCluster_authTokenUpdateStrategy - Specifies the strategy to use to update the AUTH token. This parameter
must be specified with the auth-token parameter. Possible values:
- Rotate
- Set
For more information, see Authenticating Users with Redis AUTH
$sel:notificationTopicArn:ModifyCacheCluster', modifyCacheCluster_notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which
notifications are sent.
The Amazon SNS topic owner must be same as the cluster owner.
$sel:numCacheNodes:ModifyCacheCluster', modifyCacheCluster_numCacheNodes - The number of cache nodes that the cluster should have. If the value for
NumCacheNodes is greater than the sum of the number of current cache
nodes and the number of cache nodes pending creation (which may be
zero), more nodes are added. If the value is less than the number of
existing cache nodes, nodes are removed. If the value is equal to the
number of current cache nodes, any pending add or remove requests are
canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove
parameter to provide the IDs of the specific cache nodes to remove.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
Adding or removing Memcached cache nodes can be applied immediately or
as a pending operation (see ApplyImmediately).
A pending operation to modify the number of cache nodes in a cluster
during its maintenance window, whether by adding or removing nodes in
accordance with the scale out architecture, is not queued. The
customer's latest request to add or remove nodes to the cluster
overrides any previous pending operations to modify the number of cache
nodes in the cluster. For example, a request to remove 2 nodes would
override a previous pending operation to remove 3 nodes. Similarly, a
request to add 2 nodes would override a previous pending operation to
remove 3 nodes and vice versa. As Memcached cache nodes may now be
provisioned in different Availability Zones with flexible cache node
placement, a request to add nodes does not automatically override a
previous pending operation to add nodes. The customer can modify the
previous pending operation to add more nodes or explicitly cancel the
pending request and retry the new request. To cancel pending operations
to modify the number of cache nodes in a cluster, use the
ModifyCacheCluster request and set NumCacheNodes equal to the number
of cache nodes currently in the cluster.
$sel:cacheSecurityGroupNames:ModifyCacheCluster', modifyCacheCluster_cacheSecurityGroupNames - A list of cache security group names to authorize on this cluster. This
change is asynchronously applied as soon as possible.
You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).
Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
$sel:cacheClusterId:ModifyCacheCluster', modifyCacheCluster_cacheClusterId - The cluster identifier. This value is stored as a lowercase string.
data ModifyCacheClusterResponse Source #
See: newModifyCacheClusterResponse smart constructor.
Constructors
| ModifyCacheClusterResponse' (Maybe CacheCluster) Int |
Instances
newModifyCacheClusterResponse Source #
Create a value of ModifyCacheClusterResponse 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:cacheCluster:ModifyCacheClusterResponse', modifyCacheClusterResponse_cacheCluster - Undocumented member.
$sel:httpStatus:ModifyCacheClusterResponse', modifyCacheClusterResponse_httpStatus - The response's http status code.
DescribeCacheEngineVersions (Paginated)
data DescribeCacheEngineVersions Source #
Represents the input of a DescribeCacheEngineVersions operation.
See: newDescribeCacheEngineVersions smart constructor.
Constructors
| DescribeCacheEngineVersions' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Int) |
Instances
newDescribeCacheEngineVersions :: DescribeCacheEngineVersions Source #
Create a value of DescribeCacheEngineVersions 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:engineVersion:DescribeCacheEngineVersions', describeCacheEngineVersions_engineVersion - The cache engine version to return.
Example: 1.4.14
$sel:cacheParameterGroupFamily:DescribeCacheEngineVersions', describeCacheEngineVersions_cacheParameterGroupFamily - The name of a specific cache parameter group family to return details
for.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
redis6.x |
Constraints:
- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
$sel:defaultOnly:DescribeCacheEngineVersions', describeCacheEngineVersions_defaultOnly - If true, specifies that only the default version of the specified
engine or engine and major version combination is to be returned.
$sel:engine:DescribeCacheEngineVersions', describeCacheEngineVersions_engine - The cache engine to return. Valid values: memcached | redis
$sel:marker:DescribeCacheEngineVersions', describeCacheEngineVersions_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeCacheEngineVersions', describeCacheEngineVersions_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
data DescribeCacheEngineVersionsResponse Source #
Represents the output of a DescribeCacheEngineVersions operation.
See: newDescribeCacheEngineVersionsResponse smart constructor.
Constructors
| DescribeCacheEngineVersionsResponse' (Maybe [CacheEngineVersion]) (Maybe Text) Int |
Instances
newDescribeCacheEngineVersionsResponse Source #
Arguments
| :: Int | |
| -> DescribeCacheEngineVersionsResponse |
Create a value of DescribeCacheEngineVersionsResponse 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:cacheEngineVersions:DescribeCacheEngineVersionsResponse', describeCacheEngineVersionsResponse_cacheEngineVersions - A list of cache engine version details. Each element in the list
contains detailed information about one cache engine version.
$sel:marker:DescribeCacheEngineVersions', describeCacheEngineVersionsResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:httpStatus:DescribeCacheEngineVersionsResponse', describeCacheEngineVersionsResponse_httpStatus - The response's http status code.
ModifyUserGroup
data ModifyUserGroup Source #
See: newModifyUserGroup smart constructor.
Instances
Arguments
| :: Text | |
| -> ModifyUserGroup |
Create a value of ModifyUserGroup 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:userIdsToAdd:ModifyUserGroup', modifyUserGroup_userIdsToAdd - The list of user IDs to add to the user group.
$sel:userIdsToRemove:ModifyUserGroup', modifyUserGroup_userIdsToRemove - The list of user IDs to remove from the user group.
$sel:userGroupId:ModifyUserGroup', modifyUserGroup_userGroupId - The ID of the user group.
See: newUserGroup smart constructor.
Constructors
| UserGroup' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserGroupPendingChanges) (Maybe [Text]) |
Instances
newUserGroup :: UserGroup Source #
Create a value of UserGroup 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:status:UserGroup', userGroup_status - Indicates user group status. Can be "creating", "active",
"modifying", "deleting".
$sel:userIds:UserGroup', userGroup_userIds - The list of user IDs that belong to the user group.
$sel:arn:UserGroup', userGroup_arn - The Amazon Resource Name (ARN) of the user group.
$sel:userGroupId:UserGroup', userGroup_userGroupId - The ID of the user group.
$sel:engine:UserGroup', userGroup_engine - The current supported value is Redis.
$sel:pendingChanges:UserGroup', userGroup_pendingChanges - A list of updates being applied to the user group.
$sel:replicationGroups:UserGroup', userGroup_replicationGroups - A list of replication groups that the user group can access.
CreateCacheParameterGroup
data CreateCacheParameterGroup Source #
Represents the input of a CreateCacheParameterGroup operation.
See: newCreateCacheParameterGroup smart constructor.
Instances
newCreateCacheParameterGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateCacheParameterGroup |
Create a value of CreateCacheParameterGroup 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:tags:CreateCacheParameterGroup', createCacheParameterGroup_tags - A list of tags to be added to this resource. A tag is a key-value pair.
A tag key must be accompanied by a tag value, although null is accepted.
$sel:cacheParameterGroupName:CreateCacheParameterGroup', createCacheParameterGroup_cacheParameterGroupName - A user-specified name for the cache parameter group.
$sel:cacheParameterGroupFamily:CreateCacheParameterGroup', createCacheParameterGroup_cacheParameterGroupFamily - The name of the cache parameter group family that the cache parameter
group can be used with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
redis6.x |
$sel:description:CreateCacheParameterGroup', createCacheParameterGroup_description - A user-specified description for the cache parameter group.
data CreateCacheParameterGroupResponse Source #
See: newCreateCacheParameterGroupResponse smart constructor.
Constructors
| CreateCacheParameterGroupResponse' (Maybe CacheParameterGroup) Int |
Instances
newCreateCacheParameterGroupResponse Source #
Arguments
| :: Int | |
| -> CreateCacheParameterGroupResponse |
Create a value of CreateCacheParameterGroupResponse 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:cacheParameterGroup:CreateCacheParameterGroupResponse', createCacheParameterGroupResponse_cacheParameterGroup - Undocumented member.
$sel:httpStatus:CreateCacheParameterGroupResponse', createCacheParameterGroupResponse_httpStatus - The response's http status code.
DescribeReservedCacheNodes (Paginated)
data DescribeReservedCacheNodes Source #
Represents the input of a DescribeReservedCacheNodes operation.
See: newDescribeReservedCacheNodes smart constructor.
Constructors
| DescribeReservedCacheNodes' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDescribeReservedCacheNodes :: DescribeReservedCacheNodes Source #
Create a value of DescribeReservedCacheNodes 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:cacheNodeType:DescribeReservedCacheNodes', describeReservedCacheNodes_cacheNodeType - The cache node type filter value. Use this parameter to show only those
reservations matching the specified cache node type.
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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
$sel:productDescription:DescribeReservedCacheNodes', describeReservedCacheNodes_productDescription - The product description filter value. Use this parameter to show only
those reservations matching the specified product description.
$sel:marker:DescribeReservedCacheNodes', describeReservedCacheNodes_marker - An optional marker returned from a prior request. Use this marker for
pagination of results from this operation. If this parameter is
specified, the response includes only records beyond the marker, up to
the value specified by MaxRecords.
$sel:maxRecords:DescribeReservedCacheNodes', describeReservedCacheNodes_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a marker is
included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: minimum 20; maximum 100.
$sel:reservedCacheNodeId:DescribeReservedCacheNodes', describeReservedCacheNodes_reservedCacheNodeId - The reserved cache node identifier filter value. Use this parameter to
show only the reservation that matches the specified reservation ID.
$sel:offeringType:DescribeReservedCacheNodes', describeReservedCacheNodes_offeringType - The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type.
Valid values:
"Light Utilization"|"Medium Utilization"|"Heavy Utilization"|"All Upfront"|"Partial Upfront"| "No Upfront"
$sel:duration:DescribeReservedCacheNodes', describeReservedCacheNodes_duration - The duration filter value, specified in years or seconds. Use this
parameter to show only reservations for this duration.
Valid Values: 1 | 3 | 31536000 | 94608000
$sel:reservedCacheNodesOfferingId:DescribeReservedCacheNodes', describeReservedCacheNodes_reservedCacheNodesOfferingId - The offering identifier filter value. Use this parameter to show only
purchased reservations matching the specified offering identifier.
data DescribeReservedCacheNodesResponse Source #
Represents the output of a DescribeReservedCacheNodes operation.
See: newDescribeReservedCacheNodesResponse smart constructor.
Constructors
| DescribeReservedCacheNodesResponse' (Maybe Text) (Maybe [ReservedCacheNode]) Int |
Instances
newDescribeReservedCacheNodesResponse Source #
Arguments
| :: Int | |
| -> DescribeReservedCacheNodesResponse |
Create a value of DescribeReservedCacheNodesResponse 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:marker:DescribeReservedCacheNodes', describeReservedCacheNodesResponse_marker - Provides an identifier to allow retrieval of paginated results.
$sel:reservedCacheNodes:DescribeReservedCacheNodesResponse', describeReservedCacheNodesResponse_reservedCacheNodes - A list of reserved cache nodes. Each element in the list contains
detailed information about one node.
$sel:httpStatus:DescribeReservedCacheNodesResponse', describeReservedCacheNodesResponse_httpStatus - The response's http status code.
DeleteGlobalReplicationGroup
data DeleteGlobalReplicationGroup Source #
See: newDeleteGlobalReplicationGroup smart constructor.
Constructors
| DeleteGlobalReplicationGroup' Text Bool |
Instances
newDeleteGlobalReplicationGroup Source #
Arguments
| :: Text | |
| -> Bool |
|
| -> DeleteGlobalReplicationGroup |
Create a value of DeleteGlobalReplicationGroup 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:globalReplicationGroupId:DeleteGlobalReplicationGroup', deleteGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:retainPrimaryReplicationGroup:DeleteGlobalReplicationGroup', deleteGlobalReplicationGroup_retainPrimaryReplicationGroup - The primary replication group is retained as a standalone replication
group.
data DeleteGlobalReplicationGroupResponse Source #
See: newDeleteGlobalReplicationGroupResponse smart constructor.
Constructors
| DeleteGlobalReplicationGroupResponse' (Maybe GlobalReplicationGroup) Int |
Instances
newDeleteGlobalReplicationGroupResponse Source #
Arguments
| :: Int | |
| -> DeleteGlobalReplicationGroupResponse |
Create a value of DeleteGlobalReplicationGroupResponse 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:globalReplicationGroup:DeleteGlobalReplicationGroupResponse', deleteGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:DeleteGlobalReplicationGroupResponse', deleteGlobalReplicationGroupResponse_httpStatus - The response's http status code.
DecreaseNodeGroupsInGlobalReplicationGroup
data DecreaseNodeGroupsInGlobalReplicationGroup Source #
See: newDecreaseNodeGroupsInGlobalReplicationGroup smart constructor.
Instances
newDecreaseNodeGroupsInGlobalReplicationGroup Source #
Arguments
Create a value of DecreaseNodeGroupsInGlobalReplicationGroup 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:globalNodeGroupsToRemove:DecreaseNodeGroupsInGlobalReplicationGroup', decreaseNodeGroupsInGlobalReplicationGroup_globalNodeGroupsToRemove - If the value of NodeGroupCount is less than the current number of node
groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is
required. GlobalNodeGroupsToRemove is a list of NodeGroupIds to remove
from the cluster. ElastiCache for Redis will attempt to remove all node
groups listed by GlobalNodeGroupsToRemove from the cluster.
$sel:globalNodeGroupsToRetain:DecreaseNodeGroupsInGlobalReplicationGroup', decreaseNodeGroupsInGlobalReplicationGroup_globalNodeGroupsToRetain - If the value of NodeGroupCount is less than the current number of node
groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is
required. GlobalNodeGroupsToRetain is a list of NodeGroupIds to retain
from the cluster. ElastiCache for Redis will attempt to retain all node
groups listed by GlobalNodeGroupsToRetain from the cluster.
$sel:globalReplicationGroupId:DecreaseNodeGroupsInGlobalReplicationGroup', decreaseNodeGroupsInGlobalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:nodeGroupCount:DecreaseNodeGroupsInGlobalReplicationGroup', decreaseNodeGroupsInGlobalReplicationGroup_nodeGroupCount - The number of node groups (shards) that results from the modification of
the shard configuration
$sel:applyImmediately:DecreaseNodeGroupsInGlobalReplicationGroup', decreaseNodeGroupsInGlobalReplicationGroup_applyImmediately - Indicates that the shard reconfiguration process begins immediately. At
present, the only permitted value for this parameter is true.
data DecreaseNodeGroupsInGlobalReplicationGroupResponse Source #
See: newDecreaseNodeGroupsInGlobalReplicationGroupResponse smart constructor.
Instances
newDecreaseNodeGroupsInGlobalReplicationGroupResponse Source #
Arguments
| :: Int |
|
| -> DecreaseNodeGroupsInGlobalReplicationGroupResponse |
Create a value of DecreaseNodeGroupsInGlobalReplicationGroupResponse 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:globalReplicationGroup:DecreaseNodeGroupsInGlobalReplicationGroupResponse', decreaseNodeGroupsInGlobalReplicationGroupResponse_globalReplicationGroup - Undocumented member.
$sel:httpStatus:DecreaseNodeGroupsInGlobalReplicationGroupResponse', decreaseNodeGroupsInGlobalReplicationGroupResponse_httpStatus - The response's http status code.
ModifyUser
data ModifyUser Source #
See: newModifyUser smart constructor.
Instances
Arguments
| :: Text | |
| -> ModifyUser |
Create a value of ModifyUser 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:appendAccessString:ModifyUser', modifyUser_appendAccessString - Adds additional user permissions to the access string.
$sel:accessString:ModifyUser', modifyUser_accessString - Access permissions string used for this user.
$sel:passwords:ModifyUser', modifyUser_passwords - The passwords belonging to the user. You are allowed up to two.
$sel:noPasswordRequired:ModifyUser', modifyUser_noPasswordRequired - Indicates no password is required for the user.
$sel:userId:ModifyUser', modifyUser_userId - The ID of the user.
See: newUser smart constructor.
Constructors
| User' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
Create a value of User 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:status:User', user_status - Indicates the user status. Can be "active", "modifying" or
"deleting".
$sel:arn:User', user_arn - The Amazon Resource Name (ARN) of the user.
$sel:userGroupIds:User', user_userGroupIds - Returns a list of the user group IDs the user belongs to.
$sel:authentication:User', user_authentication - Denotes whether the user requires a password to authenticate.
$sel:engine:User', user_engine - The current supported value is Redis.
$sel:userName:User', user_userName - The username of the user.
$sel:accessString:User', user_accessString - Access permissions string used for this user.
$sel:userId:User', user_userId - The ID of the user.
DeleteCacheSubnetGroup
data DeleteCacheSubnetGroup Source #
Represents the input of a DeleteCacheSubnetGroup operation.
See: newDeleteCacheSubnetGroup smart constructor.
Constructors
| DeleteCacheSubnetGroup' Text |
Instances
newDeleteCacheSubnetGroup Source #
Create a value of DeleteCacheSubnetGroup 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:cacheSubnetGroupName:DeleteCacheSubnetGroup', deleteCacheSubnetGroup_cacheSubnetGroupName - The name of the cache subnet group to delete.
Constraints: Must contain no more than 255 alphanumeric characters or hyphens.
data DeleteCacheSubnetGroupResponse Source #
See: newDeleteCacheSubnetGroupResponse smart constructor.
Constructors
| DeleteCacheSubnetGroupResponse' | |
Instances
| Eq DeleteCacheSubnetGroupResponse Source # | |
| Read DeleteCacheSubnetGroupResponse Source # | |
| Show DeleteCacheSubnetGroupResponse Source # | |
Defined in Amazonka.ElastiCache.DeleteCacheSubnetGroup Methods showsPrec :: Int -> DeleteCacheSubnetGroupResponse -> ShowS # show :: DeleteCacheSubnetGroupResponse -> String # showList :: [DeleteCacheSubnetGroupResponse] -> ShowS # | |
| Generic DeleteCacheSubnetGroupResponse Source # | |
Defined in Amazonka.ElastiCache.DeleteCacheSubnetGroup Associated Types type Rep DeleteCacheSubnetGroupResponse :: Type -> Type # | |
| NFData DeleteCacheSubnetGroupResponse Source # | |
Defined in Amazonka.ElastiCache.DeleteCacheSubnetGroup Methods rnf :: DeleteCacheSubnetGroupResponse -> () # | |
| type Rep DeleteCacheSubnetGroupResponse Source # | |
Defined in Amazonka.ElastiCache.DeleteCacheSubnetGroup | |
newDeleteCacheSubnetGroupResponse :: DeleteCacheSubnetGroupResponse Source #
Create a value of DeleteCacheSubnetGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
AZMode
Constructors
| AZMode' | |
Fields
| |
Bundled Patterns
| pattern AZMode_Cross_az :: AZMode | |
| pattern AZMode_Single_az :: AZMode |
Instances
AuthTokenUpdateStatus
newtype AuthTokenUpdateStatus Source #
Constructors
| AuthTokenUpdateStatus' | |
Fields | |
Bundled Patterns
| pattern AuthTokenUpdateStatus_ROTATING :: AuthTokenUpdateStatus | |
| pattern AuthTokenUpdateStatus_SETTING :: AuthTokenUpdateStatus |
Instances
AuthTokenUpdateStrategyType
newtype AuthTokenUpdateStrategyType Source #
Constructors
| AuthTokenUpdateStrategyType' | |
Fields | |
Bundled Patterns
Instances
AuthenticationType
newtype AuthenticationType Source #
Constructors
| AuthenticationType' | |
Fields | |
Bundled Patterns
| pattern AuthenticationType_No_password :: AuthenticationType | |
| pattern AuthenticationType_Password :: AuthenticationType |
Instances
AutomaticFailoverStatus
newtype AutomaticFailoverStatus Source #
Constructors
| AutomaticFailoverStatus' | |
Fields | |
Bundled Patterns
Instances
ChangeType
newtype ChangeType Source #
Constructors
| ChangeType' | |
Fields | |
Bundled Patterns
| pattern ChangeType_Immediate :: ChangeType | |
| pattern ChangeType_Requires_reboot :: ChangeType |
Instances
DestinationType
newtype DestinationType Source #
Constructors
| DestinationType' | |
Fields | |
Bundled Patterns
| pattern DestinationType_Cloudwatch_logs :: DestinationType | |
| pattern DestinationType_Kinesis_firehose :: DestinationType |
Instances
LogDeliveryConfigurationStatus
newtype LogDeliveryConfigurationStatus Source #
Constructors
| LogDeliveryConfigurationStatus' | |
Fields | |
Bundled Patterns
Instances
LogFormat
Constructors
| LogFormat' | |
Fields | |
Bundled Patterns
| pattern LogFormat_Json :: LogFormat | |
| pattern LogFormat_Text :: LogFormat |
Instances
LogType
Constructors
| LogType' | |
Fields
| |
Bundled Patterns
| pattern LogType_Slow_log :: LogType |
Instances
MultiAZStatus
newtype MultiAZStatus Source #
Constructors
| MultiAZStatus' | |
Fields | |
Bundled Patterns
| pattern MultiAZStatus_Disabled :: MultiAZStatus | |
| pattern MultiAZStatus_Enabled :: MultiAZStatus |
Instances
NodeUpdateInitiatedBy
newtype NodeUpdateInitiatedBy Source #
Constructors
| NodeUpdateInitiatedBy' | |
Fields | |
Bundled Patterns
| pattern NodeUpdateInitiatedBy_Customer :: NodeUpdateInitiatedBy | |
| pattern NodeUpdateInitiatedBy_System :: NodeUpdateInitiatedBy |
Instances
NodeUpdateStatus
newtype NodeUpdateStatus Source #
Constructors
| NodeUpdateStatus' | |
Fields | |
Bundled Patterns
| pattern NodeUpdateStatus_Complete :: NodeUpdateStatus | |
| pattern NodeUpdateStatus_In_progress :: NodeUpdateStatus | |
| pattern NodeUpdateStatus_Not_applied :: NodeUpdateStatus | |
| pattern NodeUpdateStatus_Stopped :: NodeUpdateStatus | |
| pattern NodeUpdateStatus_Stopping :: NodeUpdateStatus | |
| pattern NodeUpdateStatus_Waiting_to_start :: NodeUpdateStatus |
Instances
OutpostMode
newtype OutpostMode Source #
Constructors
| OutpostMode' | |
Fields | |
Bundled Patterns
| pattern OutpostMode_Cross_outpost :: OutpostMode | |
| pattern OutpostMode_Single_outpost :: OutpostMode |
Instances
PendingAutomaticFailoverStatus
newtype PendingAutomaticFailoverStatus Source #
Constructors
| PendingAutomaticFailoverStatus' | |
Fields | |
Bundled Patterns
| pattern PendingAutomaticFailoverStatus_Disabled :: PendingAutomaticFailoverStatus | |
| pattern PendingAutomaticFailoverStatus_Enabled :: PendingAutomaticFailoverStatus |
Instances
ServiceUpdateSeverity
newtype ServiceUpdateSeverity Source #
Constructors
| ServiceUpdateSeverity' | |
Fields | |
Bundled Patterns
| pattern ServiceUpdateSeverity_Critical :: ServiceUpdateSeverity | |
| pattern ServiceUpdateSeverity_Important :: ServiceUpdateSeverity | |
| pattern ServiceUpdateSeverity_Low :: ServiceUpdateSeverity | |
| pattern ServiceUpdateSeverity_Medium :: ServiceUpdateSeverity |
Instances
ServiceUpdateStatus
newtype ServiceUpdateStatus Source #
Constructors
| ServiceUpdateStatus' | |
Fields | |
Bundled Patterns
| pattern ServiceUpdateStatus_Available :: ServiceUpdateStatus | |
| pattern ServiceUpdateStatus_Cancelled :: ServiceUpdateStatus | |
| pattern ServiceUpdateStatus_Expired :: ServiceUpdateStatus |
Instances
ServiceUpdateType
newtype ServiceUpdateType Source #
Constructors
| ServiceUpdateType' | |
Fields | |
Bundled Patterns
| pattern ServiceUpdateType_Security_update :: ServiceUpdateType |
Instances
SlaMet
Constructors
| SlaMet' | |
Fields
| |
Bundled Patterns
| pattern SlaMet_N_a :: SlaMet | |
| pattern SlaMet_No :: SlaMet | |
| pattern SlaMet_Yes :: SlaMet |
Instances
SourceType
newtype SourceType Source #
Constructors
| SourceType' | |
Fields | |
Bundled Patterns
| pattern SourceType_Cache_cluster :: SourceType | |
| pattern SourceType_Cache_parameter_group :: SourceType | |
| pattern SourceType_Cache_security_group :: SourceType | |
| pattern SourceType_Cache_subnet_group :: SourceType | |
| pattern SourceType_Replication_group :: SourceType | |
| pattern SourceType_User :: SourceType | |
| pattern SourceType_User_group :: SourceType |
Instances
UpdateActionStatus
newtype UpdateActionStatus Source #
Constructors
| UpdateActionStatus' | |
Fields | |
Bundled Patterns
| pattern UpdateActionStatus_Complete :: UpdateActionStatus | |
| pattern UpdateActionStatus_In_progress :: UpdateActionStatus | |
| pattern UpdateActionStatus_Not_applicable :: UpdateActionStatus | |
| pattern UpdateActionStatus_Not_applied :: UpdateActionStatus | |
| pattern UpdateActionStatus_Scheduled :: UpdateActionStatus | |
| pattern UpdateActionStatus_Scheduling :: UpdateActionStatus | |
| pattern UpdateActionStatus_Stopped :: UpdateActionStatus | |
| pattern UpdateActionStatus_Stopping :: UpdateActionStatus | |
| pattern UpdateActionStatus_Waiting_to_start :: UpdateActionStatus |
Instances
Authentication
data Authentication Source #
Indicates whether the user requires a password to authenticate.
See: newAuthentication smart constructor.
Constructors
| Authentication' (Maybe Int) (Maybe AuthenticationType) |
Instances
newAuthentication :: Authentication Source #
Create a value of Authentication 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:passwordCount:Authentication', authentication_passwordCount - The number of passwords belonging to the user. The maximum is two.
$sel:type':Authentication', authentication_type - Indicates whether the user requires a password to authenticate.
AvailabilityZone
data AvailabilityZone Source #
Describes an Availability Zone in which the cluster is launched.
See: newAvailabilityZone smart constructor.
Constructors
| AvailabilityZone' (Maybe Text) |
Instances
newAvailabilityZone :: AvailabilityZone Source #
Create a value of AvailabilityZone 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:name:AvailabilityZone', availabilityZone_name - The name of the Availability Zone.
CacheCluster
data CacheCluster Source #
Contains all of the attributes of a specific cluster.
See: newCacheCluster smart constructor.
Constructors
| CacheCluster' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [CacheNode]) (Maybe ISO8601) (Maybe Bool) (Maybe Bool) (Maybe [SecurityGroupMembership]) (Maybe NotificationConfiguration) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [LogDeliveryConfiguration]) (Maybe Endpoint) (Maybe Text) (Maybe [CacheSecurityGroupMembership]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CacheParameterGroupStatus) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe PendingModifiedValues) (Maybe Int) |
Instances
newCacheCluster :: CacheCluster Source #
Create a value of CacheCluster 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:authTokenLastModifiedDate:CacheCluster', cacheCluster_authTokenLastModifiedDate - The date the auth token was last modified
$sel:engineVersion:CacheCluster', cacheCluster_engineVersion - The version of the cache engine that is used in this cluster.
$sel:cacheNodeType:CacheCluster', cacheCluster_cacheNodeType - The name of the compute and memory capacity node type for the cluster.
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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
$sel:cacheNodes:CacheCluster', cacheCluster_cacheNodes - A list of cache nodes that are members of the cluster.
$sel:cacheClusterCreateTime:CacheCluster', cacheCluster_cacheClusterCreateTime - The date and time when the cluster was created.
$sel:atRestEncryptionEnabled:CacheCluster', cacheCluster_atRestEncryptionEnabled - A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the
cluster is created. To enable at-rest encryption on a cluster you must
set AtRestEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an
Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
$sel:autoMinorVersionUpgrade:CacheCluster', cacheCluster_autoMinorVersionUpgrade - This parameter is currently disabled.
$sel:securityGroups:CacheCluster', cacheCluster_securityGroups - A list of VPC Security Groups associated with the cluster.
$sel:notificationConfiguration:CacheCluster', cacheCluster_notificationConfiguration - Describes a notification topic and its status. Notification topics are
used for publishing ElastiCache events to subscribers using Amazon
Simple Notification Service (SNS).
$sel:arn:CacheCluster', cacheCluster_arn - The ARN (Amazon Resource Name) of the cache cluster.
$sel:transitEncryptionEnabled:CacheCluster', cacheCluster_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the
cluster is created. To enable in-transit encryption on a cluster you
must set TransitEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an
Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
$sel:snapshotWindow:CacheCluster', cacheCluster_snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a
daily snapshot of your cluster.
Example: 05:00-09:00
$sel:cacheClusterId:CacheCluster', cacheCluster_cacheClusterId - The user-supplied identifier of the cluster. This identifier is a unique
key that identifies a cluster.
$sel:logDeliveryConfigurations:CacheCluster', cacheCluster_logDeliveryConfigurations - Returns the destination, format and type of the logs.
$sel:configurationEndpoint:CacheCluster', cacheCluster_configurationEndpoint - Represents a Memcached cluster endpoint which can be used by an
application to connect to any node in the cluster. The configuration
endpoint will always have .cfg in it.
Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
$sel:engine:CacheCluster', cacheCluster_engine - The name of the cache engine (memcached or redis) to be used for
this cluster.
$sel:cacheSecurityGroups:CacheCluster', cacheCluster_cacheSecurityGroups - A list of cache security group elements, composed of name and status
sub-elements.
$sel:replicationGroupLogDeliveryEnabled:CacheCluster', cacheCluster_replicationGroupLogDeliveryEnabled - A boolean value indicating whether log delivery is enabled for the
replication group.
$sel:authTokenEnabled:CacheCluster', cacheCluster_authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis
commands.
Default: false
$sel:clientDownloadLandingPage:CacheCluster', cacheCluster_clientDownloadLandingPage - The URL of the web page where you can download the latest ElastiCache
client library.
$sel:preferredMaintenanceWindow:CacheCluster', cacheCluster_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster
is performed. It is specified as a range in the format
ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
$sel:cacheSubnetGroupName:CacheCluster', cacheCluster_cacheSubnetGroupName - The name of the cache subnet group associated with the cluster.
$sel:preferredAvailabilityZone:CacheCluster', cacheCluster_preferredAvailabilityZone - The name of the Availability Zone in which the cluster is located or
"Multiple" if the cache nodes are located in different Availability
Zones.
$sel:cacheParameterGroup:CacheCluster', cacheCluster_cacheParameterGroup - Status of the cache parameter group.
$sel:cacheClusterStatus:CacheCluster', cacheCluster_cacheClusterStatus - The current state of this cluster, one of the following values:
available, creating, deleted, deleting, incompatible-network,
modifying, rebooting cluster nodes, restore-failed, or
snapshotting.
$sel:snapshotRetentionLimit:CacheCluster', cacheCluster_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic cluster
snapshots before deleting them. For example, if you set
SnapshotRetentionLimit to 5, a snapshot that was taken today is
retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
$sel:preferredOutpostArn:CacheCluster', cacheCluster_preferredOutpostArn - The outpost ARN in which the cache cluster is created.
$sel:replicationGroupId:CacheCluster', cacheCluster_replicationGroupId - The replication group to which this cluster belongs. If this field is
empty, the cluster is not associated with any replication group.
$sel:pendingModifiedValues:CacheCluster', cacheCluster_pendingModifiedValues - Undocumented member.
$sel:numCacheNodes:CacheCluster', cacheCluster_numCacheNodes - The number of cache nodes in the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
CacheEngineVersion
data CacheEngineVersion Source #
Provides all of the details about a particular cache engine version.
See: newCacheEngineVersion smart constructor.
Instances
newCacheEngineVersion :: CacheEngineVersion Source #
Create a value of CacheEngineVersion 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:engineVersion:CacheEngineVersion', cacheEngineVersion_engineVersion - The version number of the cache engine.
$sel:cacheParameterGroupFamily:CacheEngineVersion', cacheEngineVersion_cacheParameterGroupFamily - The name of the cache parameter group family associated with this cache
engine.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
redis6.x |
$sel:cacheEngineDescription:CacheEngineVersion', cacheEngineVersion_cacheEngineDescription - The description of the cache engine.
$sel:engine:CacheEngineVersion', cacheEngineVersion_engine - The name of the cache engine.
$sel:cacheEngineVersionDescription:CacheEngineVersion', cacheEngineVersion_cacheEngineVersionDescription - The description of the cache engine version.
CacheNode
Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.
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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
See: newCacheNode smart constructor.
Constructors
| CacheNode' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Endpoint) |
Instances
newCacheNode :: CacheNode Source #
Create a value of CacheNode 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:sourceCacheNodeId:CacheNode', cacheNode_sourceCacheNodeId - The ID of the primary node to which this read replica node is
synchronized. If this field is empty, this node is not associated with a
primary cluster.
$sel:parameterGroupStatus:CacheNode', cacheNode_parameterGroupStatus - The status of the parameter group applied to this cache node.
$sel:cacheNodeCreateTime:CacheNode', cacheNode_cacheNodeCreateTime - The date and time when the cache node was created.
$sel:customerAvailabilityZone:CacheNode', cacheNode_customerAvailabilityZone - The Availability Zone where this node was created and now resides.
$sel:cacheNodeId:CacheNode', cacheNode_cacheNodeId - The cache node identifier. A node ID is a numeric identifier (0001,
0002, etc.). The combination of cluster ID and node ID uniquely
identifies every cache node used in a customer's Amazon account.
$sel:customerOutpostArn:CacheNode', cacheNode_customerOutpostArn - The customer outpost ARN of the cache node.
$sel:cacheNodeStatus:CacheNode', cacheNode_cacheNodeStatus - The current state of this cache node, one of the following values:
available, creating, rebooting, or deleting.
$sel:endpoint:CacheNode', cacheNode_endpoint - The hostname for connecting to this cache node.
CacheNodeTypeSpecificParameter
data CacheNodeTypeSpecificParameter Source #
A parameter that has a different value for each cache node type it is
applied to. For example, in a Redis cluster, a cache.m1.large cache
node type would have a larger maxmemory value than a cache.m1.small
type.
See: newCacheNodeTypeSpecificParameter smart constructor.
Constructors
| CacheNodeTypeSpecificParameter' (Maybe [CacheNodeTypeSpecificValue]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeType) |
Instances
newCacheNodeTypeSpecificParameter :: CacheNodeTypeSpecificParameter Source #
Create a value of CacheNodeTypeSpecificParameter 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:cacheNodeTypeSpecificValues:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_cacheNodeTypeSpecificValues - A list of cache node types and their corresponding values for this
parameter.
$sel:minimumEngineVersion:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_minimumEngineVersion - The earliest cache engine version to which the parameter can apply.
$sel:source:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_source - The source of the parameter value.
$sel:isModifiable:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_isModifiable - Indicates whether (true) or not (false) the parameter can be
modified. Some parameters have security or operational implications that
prevent them from being changed.
$sel:dataType:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_dataType - The valid data type for the parameter.
$sel:allowedValues:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_allowedValues - The valid range of values for the parameter.
$sel:parameterName:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_parameterName - The name of the parameter.
$sel:description:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_description - A description of the parameter.
$sel:changeType:CacheNodeTypeSpecificParameter', cacheNodeTypeSpecificParameter_changeType - Indicates whether a change to the parameter is applied immediately or
requires a reboot for the change to be applied. You can force a reboot
or wait until the next maintenance window's reboot. For more
information, see
Rebooting a Cluster.
CacheNodeTypeSpecificValue
data CacheNodeTypeSpecificValue Source #
A value that applies only to a certain cache node type.
See: newCacheNodeTypeSpecificValue smart constructor.
Constructors
| CacheNodeTypeSpecificValue' (Maybe Text) (Maybe Text) |
Instances
newCacheNodeTypeSpecificValue :: CacheNodeTypeSpecificValue Source #
Create a value of CacheNodeTypeSpecificValue 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:cacheNodeType:CacheNodeTypeSpecificValue', cacheNodeTypeSpecificValue_cacheNodeType - The cache node type for which this value applies.
$sel:value:CacheNodeTypeSpecificValue', cacheNodeTypeSpecificValue_value - The value for the cache node type.
CacheNodeUpdateStatus
data CacheNodeUpdateStatus Source #
The status of the service update on the cache node
See: newCacheNodeUpdateStatus smart constructor.
Constructors
| CacheNodeUpdateStatus' (Maybe ISO8601) (Maybe NodeUpdateInitiatedBy) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe NodeUpdateStatus) (Maybe ISO8601) |
Instances
newCacheNodeUpdateStatus :: CacheNodeUpdateStatus Source #
Create a value of CacheNodeUpdateStatus 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:nodeUpdateEndDate:CacheNodeUpdateStatus', cacheNodeUpdateStatus_nodeUpdateEndDate - The end date of the update for a node
$sel:nodeUpdateInitiatedBy:CacheNodeUpdateStatus', cacheNodeUpdateStatus_nodeUpdateInitiatedBy - Reflects whether the update was initiated by the customer or
automatically applied
$sel:nodeUpdateStatusModifiedDate:CacheNodeUpdateStatus', cacheNodeUpdateStatus_nodeUpdateStatusModifiedDate - The date when the NodeUpdateStatus was last modified>
$sel:cacheNodeId:CacheNodeUpdateStatus', cacheNodeUpdateStatus_cacheNodeId - The node ID of the cache cluster
$sel:nodeUpdateInitiatedDate:CacheNodeUpdateStatus', cacheNodeUpdateStatus_nodeUpdateInitiatedDate - The date when the update is triggered
$sel:nodeUpdateStartDate:CacheNodeUpdateStatus', cacheNodeUpdateStatus_nodeUpdateStartDate - The start date of the update for a node
$sel:nodeUpdateStatus:CacheNodeUpdateStatus', cacheNodeUpdateStatus_nodeUpdateStatus - The update status of the node
$sel:nodeDeletionDate:CacheNodeUpdateStatus', cacheNodeUpdateStatus_nodeDeletionDate - The deletion date of the node
CacheParameterGroup
data CacheParameterGroup Source #
Represents the output of a CreateCacheParameterGroup operation.
See: newCacheParameterGroup smart constructor.
Instances
newCacheParameterGroup :: CacheParameterGroup Source #
Create a value of CacheParameterGroup 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:cacheParameterGroupFamily:CacheParameterGroup', cacheParameterGroup_cacheParameterGroupFamily - The name of the cache parameter group family that this cache parameter
group is compatible with.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
redis6.x |
$sel:arn:CacheParameterGroup', cacheParameterGroup_arn - The ARN (Amazon Resource Name) of the cache parameter group.
$sel:cacheParameterGroupName:CacheParameterGroup', cacheParameterGroup_cacheParameterGroupName - The name of the cache parameter group.
$sel:isGlobal:CacheParameterGroup', cacheParameterGroup_isGlobal - Indicates whether the parameter group is associated with a Global
datastore
$sel:description:CacheParameterGroup', cacheParameterGroup_description - The description for this cache parameter group.
CacheParameterGroupNameMessage
data CacheParameterGroupNameMessage Source #
Represents the output of one of the following operations:
ModifyCacheParameterGroup
ResetCacheParameterGroup
See: newCacheParameterGroupNameMessage smart constructor.
Constructors
| CacheParameterGroupNameMessage' (Maybe Text) |
Instances
newCacheParameterGroupNameMessage :: CacheParameterGroupNameMessage Source #
Create a value of CacheParameterGroupNameMessage 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:cacheParameterGroupName:CacheParameterGroupNameMessage', cacheParameterGroupNameMessage_cacheParameterGroupName - The name of the cache parameter group.
CacheParameterGroupStatus
data CacheParameterGroupStatus Source #
Status of the cache parameter group.
See: newCacheParameterGroupStatus smart constructor.
Instances
newCacheParameterGroupStatus :: CacheParameterGroupStatus Source #
Create a value of CacheParameterGroupStatus 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:cacheParameterGroupName:CacheParameterGroupStatus', cacheParameterGroupStatus_cacheParameterGroupName - The name of the cache parameter group.
$sel:cacheNodeIdsToReboot:CacheParameterGroupStatus', cacheParameterGroupStatus_cacheNodeIdsToReboot - A list of the cache node IDs which need to be rebooted for parameter
changes to be applied. A node ID is a numeric identifier (0001, 0002,
etc.).
$sel:parameterApplyStatus:CacheParameterGroupStatus', cacheParameterGroupStatus_parameterApplyStatus - The status of parameter updates.
CacheSecurityGroup
data CacheSecurityGroup Source #
Represents the output of one of the following operations:
AuthorizeCacheSecurityGroupIngress
CreateCacheSecurityGroup
RevokeCacheSecurityGroupIngress
See: newCacheSecurityGroup smart constructor.
Constructors
| CacheSecurityGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [EC2SecurityGroup]) (Maybe Text) |
Instances
newCacheSecurityGroup :: CacheSecurityGroup Source #
Create a value of CacheSecurityGroup 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:cacheSecurityGroupName:CacheSecurityGroup', cacheSecurityGroup_cacheSecurityGroupName - The name of the cache security group.
$sel:arn:CacheSecurityGroup', cacheSecurityGroup_arn - The ARN of the cache security group,
$sel:ownerId:CacheSecurityGroup', cacheSecurityGroup_ownerId - The Amazon account ID of the cache security group owner.
$sel:eC2SecurityGroups:CacheSecurityGroup', cacheSecurityGroup_eC2SecurityGroups - A list of Amazon EC2 security groups that are associated with this cache
security group.
$sel:description:CacheSecurityGroup', cacheSecurityGroup_description - The description of the cache security group.
CacheSecurityGroupMembership
data CacheSecurityGroupMembership Source #
Represents a cluster's status within a particular cache security group.
See: newCacheSecurityGroupMembership smart constructor.
Constructors
| CacheSecurityGroupMembership' (Maybe Text) (Maybe Text) |
Instances
newCacheSecurityGroupMembership :: CacheSecurityGroupMembership Source #
Create a value of CacheSecurityGroupMembership 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:status:CacheSecurityGroupMembership', cacheSecurityGroupMembership_status - The membership status in the cache security group. The status changes
when a cache security group is modified, or when the cache security
groups assigned to a cluster are modified.
$sel:cacheSecurityGroupName:CacheSecurityGroupMembership', cacheSecurityGroupMembership_cacheSecurityGroupName - The name of the cache security group.
CacheSubnetGroup
data CacheSubnetGroup Source #
Represents the output of one of the following operations:
CreateCacheSubnetGroup
ModifyCacheSubnetGroup
See: newCacheSubnetGroup smart constructor.
Instances
newCacheSubnetGroup :: CacheSubnetGroup Source #
Create a value of CacheSubnetGroup 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:arn:CacheSubnetGroup', cacheSubnetGroup_arn - The ARN (Amazon Resource Name) of the cache subnet group.
$sel:vpcId:CacheSubnetGroup', cacheSubnetGroup_vpcId - The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
group.
$sel:subnets:CacheSubnetGroup', cacheSubnetGroup_subnets - A list of subnets associated with the cache subnet group.
$sel:cacheSubnetGroupName:CacheSubnetGroup', cacheSubnetGroup_cacheSubnetGroupName - The name of the cache subnet group.
$sel:cacheSubnetGroupDescription:CacheSubnetGroup', cacheSubnetGroup_cacheSubnetGroupDescription - The description of the cache subnet group.
CloudWatchLogsDestinationDetails
data CloudWatchLogsDestinationDetails Source #
The configuration details of the CloudWatch Logs destination.
See: newCloudWatchLogsDestinationDetails smart constructor.
Constructors
| CloudWatchLogsDestinationDetails' (Maybe Text) |
Instances
newCloudWatchLogsDestinationDetails :: CloudWatchLogsDestinationDetails Source #
Create a value of CloudWatchLogsDestinationDetails 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:logGroup:CloudWatchLogsDestinationDetails', cloudWatchLogsDestinationDetails_logGroup - The name of the CloudWatch Logs log group.
ConfigureShard
data ConfigureShard Source #
Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.
See: newConfigureShard smart constructor.
Instances
Arguments
| :: Text | |
| -> Int | |
| -> ConfigureShard |
Create a value of ConfigureShard 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:preferredAvailabilityZones:ConfigureShard', configureShard_preferredAvailabilityZones - A list of PreferredAvailabilityZone strings that specify which
availability zones the replication group's nodes are to be in. The
nummber of PreferredAvailabilityZone values must equal the value of
NewReplicaCount plus 1 to account for the primary node. If this member
of ReplicaConfiguration is omitted, ElastiCache for Redis selects the
availability zone for each of the replicas.
$sel:preferredOutpostArns:ConfigureShard', configureShard_preferredOutpostArns - The outpost ARNs in which the cache cluster is created.
$sel:nodeGroupId:ConfigureShard', configureShard_nodeGroupId - The 4-digit id for the node group you are configuring. For Redis
(cluster mode disabled) replication groups, the node group id is always
0001. To find a Redis (cluster mode enabled)'s node group's (shard's)
id, see
Finding a Shard's Id.
$sel:newReplicaCount':ConfigureShard', configureShard_newReplicaCount - The number of replicas you want in this node group at the end of this
operation. The maximum value for NewReplicaCount is 5. The minimum
value depends upon the type of Redis replication group you are working
with.
The minimum number of replicas in a shard or replication group is:
Redis (cluster mode disabled)
- If Multi-AZ: 1
- If Multi-AZ: 0
- Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
CustomerNodeEndpoint
data CustomerNodeEndpoint Source #
The endpoint from which data should be migrated.
See: newCustomerNodeEndpoint smart constructor.
Constructors
| CustomerNodeEndpoint' (Maybe Text) (Maybe Int) |
Instances
newCustomerNodeEndpoint :: CustomerNodeEndpoint Source #
Create a value of CustomerNodeEndpoint 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:address:CustomerNodeEndpoint', customerNodeEndpoint_address - The address of the node endpoint
$sel:port:CustomerNodeEndpoint', customerNodeEndpoint_port - The port of the node endpoint
DestinationDetails
data DestinationDetails Source #
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
See: newDestinationDetails smart constructor.
Constructors
| DestinationDetails' (Maybe CloudWatchLogsDestinationDetails) (Maybe KinesisFirehoseDestinationDetails) |
Instances
newDestinationDetails :: DestinationDetails Source #
Create a value of DestinationDetails 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:cloudWatchLogsDetails:DestinationDetails', destinationDetails_cloudWatchLogsDetails - The configuration details of the CloudWatch Logs destination.
$sel:kinesisFirehoseDetails:DestinationDetails', destinationDetails_kinesisFirehoseDetails - The configuration details of the Kinesis Data Firehose destination.
EC2SecurityGroup
data EC2SecurityGroup Source #
Provides ownership and status information for an Amazon EC2 security group.
See: newEC2SecurityGroup smart constructor.
Instances
newEC2SecurityGroup :: EC2SecurityGroup Source #
Create a value of EC2SecurityGroup 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:status:EC2SecurityGroup', eC2SecurityGroup_status - The status of the Amazon EC2 security group.
$sel:eC2SecurityGroupOwnerId:EC2SecurityGroup', eC2SecurityGroup_eC2SecurityGroupOwnerId - The Amazon account ID of the Amazon EC2 security group owner.
$sel:eC2SecurityGroupName:EC2SecurityGroup', eC2SecurityGroup_eC2SecurityGroupName - The name of the Amazon EC2 security group.
Endpoint
Represents the information required for client programs to connect to a cache node.
See: newEndpoint smart constructor.
Instances
| Eq Endpoint Source # | |
| Read Endpoint Source # | |
| Show Endpoint Source # | |
| Generic Endpoint Source # | |
| NFData Endpoint Source # | |
Defined in Amazonka.ElastiCache.Types.Endpoint | |
| Hashable Endpoint Source # | |
Defined in Amazonka.ElastiCache.Types.Endpoint | |
| FromXML Endpoint Source # | |
| type Rep Endpoint Source # | |
Defined in Amazonka.ElastiCache.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.ElastiCache.Types.Endpoint" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "Endpoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "port") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) | |
newEndpoint :: Endpoint Source #
Create a value of Endpoint 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:address:Endpoint', endpoint_address - The DNS hostname of the cache node.
$sel:port:Endpoint', endpoint_port - The port number that the cache engine is listening on.
EngineDefaults
data EngineDefaults Source #
Represents the output of a DescribeEngineDefaultParameters operation.
See: newEngineDefaults smart constructor.
Constructors
| EngineDefaults' (Maybe Text) (Maybe [CacheNodeTypeSpecificParameter]) (Maybe Text) (Maybe [Parameter]) |
Instances
newEngineDefaults :: EngineDefaults Source #
Create a value of EngineDefaults 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:cacheParameterGroupFamily:EngineDefaults', engineDefaults_cacheParameterGroupFamily - Specifies the name of the cache parameter group family to which the
engine default parameters apply.
Valid values are: memcached1.4 | memcached1.5 | memcached1.6 |
redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |
redis6.x |
$sel:cacheNodeTypeSpecificParameters:EngineDefaults', engineDefaults_cacheNodeTypeSpecificParameters - A list of parameters specific to a particular cache node type. Each
element in the list contains detailed information about one parameter.
$sel:marker:EngineDefaults', engineDefaults_marker - Provides an identifier to allow retrieval of paginated results.
$sel:parameters:EngineDefaults', engineDefaults_parameters - Contains a list of engine default parameters.
Event
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.
See: newEvent smart constructor.
Instances
| Eq Event Source # | |
| Read Event Source # | |
| Show Event Source # | |
| Generic Event Source # | |
| NFData Event Source # | |
Defined in Amazonka.ElastiCache.Types.Event | |
| Hashable Event Source # | |
Defined in Amazonka.ElastiCache.Types.Event | |
| FromXML Event Source # | |
| type Rep Event Source # | |
Defined in Amazonka.ElastiCache.Types.Event type Rep Event = D1 ('MetaData "Event" "Amazonka.ElastiCache.Types.Event" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType)) :*: S1 ('MetaSel ('Just "sourceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
Create a value of Event 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:sourceType:Event', event_sourceType - Specifies the origin of this event - a cluster, a parameter group, a
security group, etc.
$sel:sourceIdentifier:Event', event_sourceIdentifier - The identifier for the source of the event. For example, if the event
occurred at the cluster level, the identifier would be the name of the
cluster.
$sel:date:Event', event_date - The date and time when the event occurred.
$sel:message:Event', event_message - The text of the event.
Filter
Used to streamline results of a search based on the property being filtered.
See: newFilter smart constructor.
Instances
| Eq Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| Generic Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.ElastiCache.Types.Filter | |
| Hashable Filter Source # | |
Defined in Amazonka.ElastiCache.Types.Filter | |
| ToQuery Filter Source # | |
Defined in Amazonka.ElastiCache.Types.Filter Methods toQuery :: Filter -> QueryString # | |
| type Rep Filter Source # | |
Defined in Amazonka.ElastiCache.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.ElastiCache.Types.Filter" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))) | |
Create a value of Filter 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:name:Filter', filter_name - The property being filtered. For example, UserId.
$sel:values:Filter', filter_values - The property values to filter on. For example, "user-123".
GlobalNodeGroup
data GlobalNodeGroup Source #
Indicates the slot configuration and global identifier for a slice group.
See: newGlobalNodeGroup smart constructor.
Constructors
| GlobalNodeGroup' (Maybe Text) (Maybe Text) |
Instances
newGlobalNodeGroup :: GlobalNodeGroup Source #
Create a value of GlobalNodeGroup 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:slots:GlobalNodeGroup', globalNodeGroup_slots - The keyspace for this node group
$sel:globalNodeGroupId:GlobalNodeGroup', globalNodeGroup_globalNodeGroupId - The name of the global node group
GlobalReplicationGroup
data GlobalReplicationGroup Source #
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region. The secondary cluster accepts only reads. The primary cluster automatically replicates updates to the secondary cluster.
- The GlobalReplicationGroupIdSuffix represents the name of the Global datastore, which is what you use to associate a secondary cluster.
See: newGlobalReplicationGroup smart constructor.
Constructors
| GlobalReplicationGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe [GlobalReplicationGroupMember]) (Maybe Text) (Maybe Bool) (Maybe [GlobalNodeGroup]) (Maybe Text) (Maybe Text) |
Instances
newGlobalReplicationGroup :: GlobalReplicationGroup Source #
Create a value of GlobalReplicationGroup 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:engineVersion:GlobalReplicationGroup', globalReplicationGroup_engineVersion - The Elasticache Redis engine version.
$sel:status:GlobalReplicationGroup', globalReplicationGroup_status - The status of the Global datastore
$sel:cacheNodeType:GlobalReplicationGroup', globalReplicationGroup_cacheNodeType - The cache node type of the Global datastore
$sel:clusterEnabled:GlobalReplicationGroup', globalReplicationGroup_clusterEnabled - A flag that indicates whether the Global datastore is cluster enabled.
$sel:atRestEncryptionEnabled:GlobalReplicationGroup', globalReplicationGroup_atRestEncryptionEnabled - A flag that enables encryption at rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the
replication group is created. To enable encryption at rest on a
replication group you must set AtRestEncryptionEnabled to true when
you create the replication group.
Required: Only available when creating a replication group in an
Amazon VPC using redis version 3.2.6, 4.x or later.
$sel:arn:GlobalReplicationGroup', globalReplicationGroup_arn - The ARN (Amazon Resource Name) of the global replication group.
$sel:transitEncryptionEnabled:GlobalReplicationGroup', globalReplicationGroup_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true. You cannot
modify the value of TransitEncryptionEnabled after the cluster is
created. To enable in-transit encryption on a cluster you must set
TransitEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an
Amazon VPC using redis version 3.2.6, 4.x or later.
$sel:members:GlobalReplicationGroup', globalReplicationGroup_members - The replication groups that comprise the Global datastore.
$sel:engine:GlobalReplicationGroup', globalReplicationGroup_engine - The Elasticache engine. For Redis only.
$sel:authTokenEnabled:GlobalReplicationGroup', globalReplicationGroup_authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis
commands.
Default: false
$sel:globalNodeGroups:GlobalReplicationGroup', globalReplicationGroup_globalNodeGroups - Indicates the slot configuration and global identifier for each slice
group.
$sel:globalReplicationGroupId:GlobalReplicationGroup', globalReplicationGroup_globalReplicationGroupId - The name of the Global datastore
$sel:globalReplicationGroupDescription:GlobalReplicationGroup', globalReplicationGroup_globalReplicationGroupDescription - The optional description of the Global datastore
GlobalReplicationGroupInfo
data GlobalReplicationGroupInfo Source #
The name of the Global datastore and role of this replication group in the Global datastore.
See: newGlobalReplicationGroupInfo smart constructor.
Constructors
| GlobalReplicationGroupInfo' (Maybe Text) (Maybe Text) |
Instances
newGlobalReplicationGroupInfo :: GlobalReplicationGroupInfo Source #
Create a value of GlobalReplicationGroupInfo 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:globalReplicationGroupMemberRole:GlobalReplicationGroupInfo', globalReplicationGroupInfo_globalReplicationGroupMemberRole - The role of the replication group in a Global datastore. Can be primary
or secondary.
$sel:globalReplicationGroupId:GlobalReplicationGroupInfo', globalReplicationGroupInfo_globalReplicationGroupId - The name of the Global datastore
GlobalReplicationGroupMember
data GlobalReplicationGroupMember Source #
A member of a Global datastore. It contains the Replication Group Id, the Amazon region and the role of the replication group.
See: newGlobalReplicationGroupMember smart constructor.
Constructors
| GlobalReplicationGroupMember' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe AutomaticFailoverStatus) |
Instances
newGlobalReplicationGroupMember :: GlobalReplicationGroupMember Source #
Create a value of GlobalReplicationGroupMember 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:status:GlobalReplicationGroupMember', globalReplicationGroupMember_status - The status of the membership of the replication group.
$sel:replicationGroupRegion:GlobalReplicationGroupMember', globalReplicationGroupMember_replicationGroupRegion - The Amazon region of the Global datastore member.
$sel:role':GlobalReplicationGroupMember', globalReplicationGroupMember_role - Indicates the role of the replication group, primary or secondary.
$sel:replicationGroupId:GlobalReplicationGroupMember', globalReplicationGroupMember_replicationGroupId - The replication group id of the Global datastore member.
$sel:automaticFailover:GlobalReplicationGroupMember', globalReplicationGroupMember_automaticFailover - Indicates whether automatic failover is enabled for the replication
group.
KinesisFirehoseDestinationDetails
data KinesisFirehoseDestinationDetails Source #
The configuration details of the Kinesis Data Firehose destination.
See: newKinesisFirehoseDestinationDetails smart constructor.
Constructors
| KinesisFirehoseDestinationDetails' (Maybe Text) |
Instances
newKinesisFirehoseDestinationDetails :: KinesisFirehoseDestinationDetails Source #
Create a value of KinesisFirehoseDestinationDetails 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:deliveryStream:KinesisFirehoseDestinationDetails', kinesisFirehoseDestinationDetails_deliveryStream - The name of the Kinesis Data Firehose delivery stream.
LogDeliveryConfiguration
data LogDeliveryConfiguration Source #
Returns the destination, format and type of the logs.
See: newLogDeliveryConfiguration smart constructor.
Constructors
| LogDeliveryConfiguration' (Maybe LogDeliveryConfigurationStatus) (Maybe LogFormat) (Maybe DestinationDetails) (Maybe LogType) (Maybe DestinationType) (Maybe Text) |
Instances
newLogDeliveryConfiguration :: LogDeliveryConfiguration Source #
Create a value of LogDeliveryConfiguration 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:status:LogDeliveryConfiguration', logDeliveryConfiguration_status - Returns the log delivery configuration status. Values are one of
enabling | disabling | modifying | active | error
$sel:logFormat:LogDeliveryConfiguration', logDeliveryConfiguration_logFormat - Returns the log format, either JSON or TEXT.
$sel:destinationDetails:LogDeliveryConfiguration', logDeliveryConfiguration_destinationDetails - Configuration details of either a CloudWatch Logs destination or Kinesis
Data Firehose destination.
$sel:logType:LogDeliveryConfiguration', logDeliveryConfiguration_logType - Refers to slow-log.
$sel:destinationType:LogDeliveryConfiguration', logDeliveryConfiguration_destinationType - Returns the destination type, either cloudwatch-logs or
kinesis-firehose.
$sel:message:LogDeliveryConfiguration', logDeliveryConfiguration_message - Returns an error message for the log delivery configuration.
LogDeliveryConfigurationRequest
data LogDeliveryConfigurationRequest Source #
Specifies the destination, format and type of the logs.
See: newLogDeliveryConfigurationRequest smart constructor.
Constructors
| LogDeliveryConfigurationRequest' (Maybe LogFormat) (Maybe Bool) (Maybe DestinationDetails) (Maybe LogType) (Maybe DestinationType) |
Instances
newLogDeliveryConfigurationRequest :: LogDeliveryConfigurationRequest Source #
Create a value of LogDeliveryConfigurationRequest 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:logFormat:LogDeliveryConfigurationRequest', logDeliveryConfigurationRequest_logFormat - Specifies either JSON or TEXT
$sel:enabled:LogDeliveryConfigurationRequest', logDeliveryConfigurationRequest_enabled - Specify if log delivery is enabled. Default true.
$sel:destinationDetails:LogDeliveryConfigurationRequest', logDeliveryConfigurationRequest_destinationDetails - Configuration details of either a CloudWatch Logs destination or Kinesis
Data Firehose destination.
$sel:logType:LogDeliveryConfigurationRequest', logDeliveryConfigurationRequest_logType - Refers to slow-log.
$sel:destinationType:LogDeliveryConfigurationRequest', logDeliveryConfigurationRequest_destinationType - Specify either cloudwatch-logs or kinesis-firehose as the
destination type.
NodeGroup
Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
See: newNodeGroup smart constructor.
Constructors
| NodeGroup' (Maybe Text) (Maybe Endpoint) (Maybe Text) (Maybe [NodeGroupMember]) (Maybe Text) (Maybe Endpoint) |
Instances
newNodeGroup :: NodeGroup Source #
Create a value of NodeGroup 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:status:NodeGroup', nodeGroup_status - The current state of this replication group - creating, available,
modifying, deleting.
$sel:primaryEndpoint:NodeGroup', nodeGroup_primaryEndpoint - The endpoint of the primary node in this node group (shard).
$sel:slots:NodeGroup', nodeGroup_slots - The keyspace for this node group (shard).
$sel:nodeGroupMembers:NodeGroup', nodeGroup_nodeGroupMembers - A list containing information about individual nodes within the node
group (shard).
$sel:nodeGroupId:NodeGroup', nodeGroup_nodeGroupId - The identifier for the node group (shard). A Redis (cluster mode
disabled) replication group contains only 1 node group; therefore, the
node group ID is 0001. A Redis (cluster mode enabled) replication group
contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user
can provide the id for a node group.
$sel:readerEndpoint:NodeGroup', nodeGroup_readerEndpoint - The endpoint of the replica nodes in this node group (shard).
NodeGroupConfiguration
data NodeGroupConfiguration Source #
Node group (shard) configuration options. Each node group (shard)
configuration has the following: Slots, PrimaryAvailabilityZone,
ReplicaAvailabilityZones, ReplicaCount.
See: newNodeGroupConfiguration smart constructor.
Constructors
| NodeGroupConfiguration' (Maybe Text) (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) |
Instances
newNodeGroupConfiguration :: NodeGroupConfiguration Source #
Create a value of NodeGroupConfiguration 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:slots:NodeGroupConfiguration', nodeGroupConfiguration_slots - A string that specifies the keyspace for a particular node group.
Keyspaces range from 0 to 16,383. The string is in the format
startkey-endkey.
Example: "0-3999"
$sel:replicaOutpostArns:NodeGroupConfiguration', nodeGroupConfiguration_replicaOutpostArns - The outpost ARN of the node replicas.
$sel:replicaCount:NodeGroupConfiguration', nodeGroupConfiguration_replicaCount - The number of read replica nodes in this node group (shard).
$sel:primaryAvailabilityZone:NodeGroupConfiguration', nodeGroupConfiguration_primaryAvailabilityZone - The Availability Zone where the primary node of this node group (shard)
is launched.
$sel:replicaAvailabilityZones:NodeGroupConfiguration', nodeGroupConfiguration_replicaAvailabilityZones - A list of Availability Zones to be used for the read replicas. The
number of Availability Zones in this list must match the value of
ReplicaCount or ReplicasPerNodeGroup if not specified.
$sel:primaryOutpostArn:NodeGroupConfiguration', nodeGroupConfiguration_primaryOutpostArn - The outpost ARN of the primary node.
$sel:nodeGroupId:NodeGroupConfiguration', nodeGroupConfiguration_nodeGroupId - Either the ElastiCache for Redis supplied 4-digit id or a user supplied
id for the node group these configuration values apply to.
NodeGroupMember
data NodeGroupMember Source #
Represents a single node within a node group (shard).
See: newNodeGroupMember smart constructor.
Constructors
| NodeGroupMember' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Endpoint) |
Instances
newNodeGroupMember :: NodeGroupMember Source #
Create a value of NodeGroupMember 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:cacheClusterId:NodeGroupMember', nodeGroupMember_cacheClusterId - The ID of the cluster to which the node belongs.
$sel:cacheNodeId:NodeGroupMember', nodeGroupMember_cacheNodeId - The ID of the node within its cluster. A node ID is a numeric identifier
(0001, 0002, etc.).
$sel:preferredAvailabilityZone:NodeGroupMember', nodeGroupMember_preferredAvailabilityZone - The name of the Availability Zone in which the node is located.
$sel:currentRole:NodeGroupMember', nodeGroupMember_currentRole - The role that is currently assigned to the node - primary or
replica. This member is only applicable for Redis (cluster mode
disabled) replication groups.
$sel:preferredOutpostArn:NodeGroupMember', nodeGroupMember_preferredOutpostArn - The outpost ARN of the node group member.
$sel:readEndpoint:NodeGroupMember', nodeGroupMember_readEndpoint - The information required for client programs to connect to a node for
read operations. The read endpoint is only applicable on Redis (cluster
mode disabled) clusters.
NodeGroupMemberUpdateStatus
data NodeGroupMemberUpdateStatus Source #
The status of the service update on the node group member
See: newNodeGroupMemberUpdateStatus smart constructor.
Constructors
| NodeGroupMemberUpdateStatus' (Maybe ISO8601) (Maybe NodeUpdateInitiatedBy) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe NodeUpdateStatus) (Maybe ISO8601) |
Instances
newNodeGroupMemberUpdateStatus :: NodeGroupMemberUpdateStatus Source #
Create a value of NodeGroupMemberUpdateStatus 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:nodeUpdateEndDate:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_nodeUpdateEndDate - The end date of the update for a node
$sel:nodeUpdateInitiatedBy:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_nodeUpdateInitiatedBy - Reflects whether the update was initiated by the customer or
automatically applied
$sel:nodeUpdateStatusModifiedDate:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_nodeUpdateStatusModifiedDate - The date when the NodeUpdateStatus was last modified
$sel:cacheClusterId:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_cacheClusterId - The cache cluster ID
$sel:cacheNodeId:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_cacheNodeId - The node ID of the cache cluster
$sel:nodeUpdateInitiatedDate:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_nodeUpdateInitiatedDate - The date when the update is triggered
$sel:nodeUpdateStartDate:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_nodeUpdateStartDate - The start date of the update for a node
$sel:nodeUpdateStatus:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_nodeUpdateStatus - The update status of the node
$sel:nodeDeletionDate:NodeGroupMemberUpdateStatus', nodeGroupMemberUpdateStatus_nodeDeletionDate - The deletion date of the node
NodeGroupUpdateStatus
data NodeGroupUpdateStatus Source #
The status of the service update on the node group
See: newNodeGroupUpdateStatus smart constructor.
Constructors
| NodeGroupUpdateStatus' (Maybe [NodeGroupMemberUpdateStatus]) (Maybe Text) |
Instances
newNodeGroupUpdateStatus :: NodeGroupUpdateStatus Source #
Create a value of NodeGroupUpdateStatus 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:nodeGroupMemberUpdateStatus:NodeGroupUpdateStatus', nodeGroupUpdateStatus_nodeGroupMemberUpdateStatus - The status of the service update on the node group member
$sel:nodeGroupId:NodeGroupUpdateStatus', nodeGroupUpdateStatus_nodeGroupId - The ID of the node group
NodeSnapshot
data NodeSnapshot Source #
Represents an individual cache node in a snapshot of a cluster.
See: newNodeSnapshot smart constructor.
Constructors
| NodeSnapshot' (Maybe NodeGroupConfiguration) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) |
Instances
newNodeSnapshot :: NodeSnapshot Source #
Create a value of NodeSnapshot 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:nodeGroupConfiguration:NodeSnapshot', nodeSnapshot_nodeGroupConfiguration - The configuration for the source node group (shard).
$sel:cacheNodeCreateTime:NodeSnapshot', nodeSnapshot_cacheNodeCreateTime - The date and time when the cache node was created in the source cluster.
$sel:cacheClusterId:NodeSnapshot', nodeSnapshot_cacheClusterId - A unique identifier for the source cluster.
$sel:cacheNodeId:NodeSnapshot', nodeSnapshot_cacheNodeId - The cache node identifier for the node in the source cluster.
$sel:nodeGroupId:NodeSnapshot', nodeSnapshot_nodeGroupId - A unique identifier for the source node group (shard).
$sel:snapshotCreateTime:NodeSnapshot', nodeSnapshot_snapshotCreateTime - The date and time when the source node's metadata and cache data set
was obtained for the snapshot.
$sel:cacheSize:NodeSnapshot', nodeSnapshot_cacheSize - The size of the cache on the source cache node.
NotificationConfiguration
data NotificationConfiguration Source #
Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).
See: newNotificationConfiguration smart constructor.
Constructors
| NotificationConfiguration' (Maybe Text) (Maybe Text) |
Instances
newNotificationConfiguration :: NotificationConfiguration Source #
Create a value of NotificationConfiguration 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:topicStatus:NotificationConfiguration', notificationConfiguration_topicStatus - The current state of the topic.
$sel:topicArn:NotificationConfiguration', notificationConfiguration_topicArn - The Amazon Resource Name (ARN) that identifies the topic.
Parameter
Describes an individual setting that controls some aspect of ElastiCache behavior.
See: newParameter smart constructor.
Constructors
| Parameter' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ChangeType) |
Instances
newParameter :: Parameter Source #
Create a value of Parameter 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:parameterValue:Parameter', parameter_parameterValue - The value of the parameter.
$sel:minimumEngineVersion:Parameter', parameter_minimumEngineVersion - The earliest cache engine version to which the parameter can apply.
$sel:source:Parameter', parameter_source - The source of the parameter.
$sel:isModifiable:Parameter', parameter_isModifiable - Indicates whether (true) or not (false) the parameter can be
modified. Some parameters have security or operational implications that
prevent them from being changed.
$sel:dataType:Parameter', parameter_dataType - The valid data type for the parameter.
$sel:allowedValues:Parameter', parameter_allowedValues - The valid range of values for the parameter.
$sel:parameterName:Parameter', parameter_parameterName - The name of the parameter.
$sel:description:Parameter', parameter_description - A description of the parameter.
$sel:changeType:Parameter', parameter_changeType - Indicates whether a change to the parameter is applied immediately or
requires a reboot for the change to be applied. You can force a reboot
or wait until the next maintenance window's reboot. For more
information, see
Rebooting a Cluster.
ParameterNameValue
data ParameterNameValue Source #
Describes a name-value pair that is used to update the value of a parameter.
See: newParameterNameValue smart constructor.
Constructors
| ParameterNameValue' (Maybe Text) (Maybe Text) |
Instances
newParameterNameValue :: ParameterNameValue Source #
Create a value of ParameterNameValue 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:parameterValue:ParameterNameValue', parameterNameValue_parameterValue - The value of the parameter.
$sel:parameterName:ParameterNameValue', parameterNameValue_parameterName - The name of the parameter.
PendingLogDeliveryConfiguration
data PendingLogDeliveryConfiguration Source #
The log delivery configurations being modified
See: newPendingLogDeliveryConfiguration smart constructor.
Constructors
| PendingLogDeliveryConfiguration' (Maybe LogFormat) (Maybe DestinationDetails) (Maybe LogType) (Maybe DestinationType) |
Instances
newPendingLogDeliveryConfiguration :: PendingLogDeliveryConfiguration Source #
Create a value of PendingLogDeliveryConfiguration 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:logFormat:PendingLogDeliveryConfiguration', pendingLogDeliveryConfiguration_logFormat - Returns the log format, either JSON or TEXT
$sel:destinationDetails:PendingLogDeliveryConfiguration', pendingLogDeliveryConfiguration_destinationDetails - Configuration details of either a CloudWatch Logs destination or Kinesis
Data Firehose destination.
$sel:logType:PendingLogDeliveryConfiguration', pendingLogDeliveryConfiguration_logType - Refers to slow-log.
$sel:destinationType:PendingLogDeliveryConfiguration', pendingLogDeliveryConfiguration_destinationType - Returns the destination type, either CloudWatch Logs or Kinesis Data
Firehose.
PendingModifiedValues
data PendingModifiedValues Source #
A group of settings that are applied to the cluster in the future, or that are currently being applied.
See: newPendingModifiedValues smart constructor.
Constructors
| PendingModifiedValues' (Maybe Text) (Maybe Text) (Maybe AuthTokenUpdateStatus) (Maybe [PendingLogDeliveryConfiguration]) (Maybe [Text]) (Maybe Int) |
Instances
newPendingModifiedValues :: PendingModifiedValues Source #
Create a value of PendingModifiedValues 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:engineVersion:PendingModifiedValues', pendingModifiedValues_engineVersion - The new cache engine version that the cluster runs.
$sel:cacheNodeType:PendingModifiedValues', pendingModifiedValues_cacheNodeType - The cache node type that this cluster or replication group is scaled to.
$sel:authTokenStatus:PendingModifiedValues', pendingModifiedValues_authTokenStatus - The auth token status
$sel:logDeliveryConfigurations:PendingModifiedValues', pendingModifiedValues_logDeliveryConfigurations - The log delivery configurations being modified
$sel:cacheNodeIdsToRemove:PendingModifiedValues', pendingModifiedValues_cacheNodeIdsToRemove - A list of cache node IDs that are being removed (or will be removed)
from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002,
etc.).
$sel:numCacheNodes:PendingModifiedValues', pendingModifiedValues_numCacheNodes - The new number of cache nodes for the cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
ProcessedUpdateAction
data ProcessedUpdateAction Source #
Update action that has been processed for the corresponding apply/stop request
See: newProcessedUpdateAction smart constructor.
Constructors
| ProcessedUpdateAction' (Maybe Text) (Maybe Text) (Maybe UpdateActionStatus) (Maybe Text) |
Instances
newProcessedUpdateAction :: ProcessedUpdateAction Source #
Create a value of ProcessedUpdateAction 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:cacheClusterId:ProcessedUpdateAction', processedUpdateAction_cacheClusterId - The ID of the cache cluster
$sel:serviceUpdateName:ProcessedUpdateAction', processedUpdateAction_serviceUpdateName - The unique ID of the service update
$sel:updateActionStatus:ProcessedUpdateAction', processedUpdateAction_updateActionStatus - The status of the update action on the Redis cluster
$sel:replicationGroupId:ProcessedUpdateAction', processedUpdateAction_replicationGroupId - The ID of the replication group
RecurringCharge
data RecurringCharge Source #
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
See: newRecurringCharge smart constructor.
Constructors
| RecurringCharge' (Maybe Text) (Maybe Double) |
Instances
newRecurringCharge :: RecurringCharge Source #
Create a value of RecurringCharge 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:recurringChargeFrequency:RecurringCharge', recurringCharge_recurringChargeFrequency - The frequency of the recurring charge.
$sel:recurringChargeAmount:RecurringCharge', recurringCharge_recurringChargeAmount - The monetary amount of the recurring charge.
RegionalConfiguration
data RegionalConfiguration Source #
A list of the replication groups
See: newRegionalConfiguration smart constructor.
Constructors
| RegionalConfiguration' Text Text [ReshardingConfiguration] |
Instances
newRegionalConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> RegionalConfiguration |
Create a value of RegionalConfiguration 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:replicationGroupId:RegionalConfiguration', regionalConfiguration_replicationGroupId - The name of the secondary cluster
$sel:replicationGroupRegion:RegionalConfiguration', regionalConfiguration_replicationGroupRegion - The Amazon region where the cluster is stored
$sel:reshardingConfiguration:RegionalConfiguration', regionalConfiguration_reshardingConfiguration - A list of PreferredAvailabilityZones objects that specifies the
configuration of a node group in the resharded cluster.
ReplicationGroup
data ReplicationGroup Source #
Contains all of the attributes of a specific Redis replication group.
See: newReplicationGroup smart constructor.
Constructors
| ReplicationGroup' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe [NodeGroup]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe [LogDeliveryConfiguration]) (Maybe Endpoint) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe MultiAZStatus) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe ReplicationGroupPendingModifiedValues) (Maybe GlobalReplicationGroupInfo) (Maybe [Text]) (Maybe AutomaticFailoverStatus) |
Instances
newReplicationGroup :: ReplicationGroup Source #
Create a value of ReplicationGroup 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:authTokenLastModifiedDate:ReplicationGroup', replicationGroup_authTokenLastModifiedDate - The date the auth token was last modified
$sel:status:ReplicationGroup', replicationGroup_status - The current state of this replication group - creating, available,
modifying, deleting, create-failed, snapshotting.
$sel:cacheNodeType:ReplicationGroup', replicationGroup_cacheNodeType - The name of the compute and memory capacity node type for each node in
the replication group.
$sel:nodeGroups:ReplicationGroup', replicationGroup_nodeGroups - A list of node groups in this replication group. For Redis (cluster mode
disabled) replication groups, this is a single-element list. For Redis
(cluster mode enabled) replication groups, the list contains an entry
for each node group (shard).
$sel:snapshottingClusterId:ReplicationGroup', replicationGroup_snapshottingClusterId - The cluster ID that is used as the daily snapshot source for the
replication group.
$sel:clusterEnabled:ReplicationGroup', replicationGroup_clusterEnabled - A flag indicating whether or not this replication group is cluster
enabled; i.e., whether its data can be partitioned across multiple
shards (API/CLI: node groups).
Valid values: true | false
$sel:atRestEncryptionEnabled:ReplicationGroup', replicationGroup_atRestEncryptionEnabled - A flag that enables encryption at-rest when set to true.
You cannot modify the value of AtRestEncryptionEnabled after the
cluster is created. To enable encryption at-rest on a cluster you must
set AtRestEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an
Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
$sel:replicationGroupCreateTime:ReplicationGroup', replicationGroup_replicationGroupCreateTime - The date and time when the cluster was created.
$sel:arn:ReplicationGroup', replicationGroup_arn - The ARN (Amazon Resource Name) of the replication group.
$sel:transitEncryptionEnabled:ReplicationGroup', replicationGroup_transitEncryptionEnabled - A flag that enables in-transit encryption when set to true.
You cannot modify the value of TransitEncryptionEnabled after the
cluster is created. To enable in-transit encryption on a cluster you
must set TransitEncryptionEnabled to true when you create a cluster.
Required: Only available when creating a replication group in an
Amazon VPC using redis version 3.2.6, 4.x or later.
Default: false
$sel:userGroupIds:ReplicationGroup', replicationGroup_userGroupIds - The ID of the user group associated to the replication group.
$sel:snapshotWindow:ReplicationGroup', replicationGroup_snapshotWindow - The daily time range (in UTC) during which ElastiCache begins taking a
daily snapshot of your node group (shard).
Example: 05:00-09:00
If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
This parameter is only valid if the Engine parameter is redis.
$sel:logDeliveryConfigurations:ReplicationGroup', replicationGroup_logDeliveryConfigurations - Returns the destination, format and type of the logs.
$sel:configurationEndpoint:ReplicationGroup', replicationGroup_configurationEndpoint - The configuration endpoint for this replication group. Use the
configuration endpoint to connect to this replication group.
$sel:authTokenEnabled:ReplicationGroup', replicationGroup_authTokenEnabled - A flag that enables using an AuthToken (password) when issuing Redis
commands.
Default: false
$sel:memberClusters:ReplicationGroup', replicationGroup_memberClusters - The names of all the cache clusters that are part of this replication
group.
$sel:kmsKeyId:ReplicationGroup', replicationGroup_kmsKeyId - The ID of the KMS key used to encrypt the disk in the cluster.
$sel:multiAZ:ReplicationGroup', replicationGroup_multiAZ - A flag indicating if you have Multi-AZ enabled to enhance fault
tolerance. For more information, see
Minimizing Downtime: Multi-AZ
$sel:snapshotRetentionLimit:ReplicationGroup', replicationGroup_snapshotRetentionLimit - The number of days for which ElastiCache retains automatic cluster
snapshots before deleting them. For example, if you set
SnapshotRetentionLimit to 5, a snapshot that was taken today is
retained for 5 days before being deleted.
If the value of SnapshotRetentionLimit is set to zero (0), backups are
turned off.
$sel:description:ReplicationGroup', replicationGroup_description - The user supplied description of the replication group.
$sel:replicationGroupId:ReplicationGroup', replicationGroup_replicationGroupId - The identifier for the replication group.
$sel:pendingModifiedValues:ReplicationGroup', replicationGroup_pendingModifiedValues - A group of settings to be applied to the replication group, either
immediately or during the next maintenance window.
$sel:globalReplicationGroupInfo:ReplicationGroup', replicationGroup_globalReplicationGroupInfo - The name of the Global datastore and role of this replication group in
the Global datastore.
$sel:memberClustersOutpostArns:ReplicationGroup', replicationGroup_memberClustersOutpostArns - The outpost ARNs of the replication group's member clusters.
$sel:automaticFailover:ReplicationGroup', replicationGroup_automaticFailover - Indicates the status of automatic failover for this Redis replication
group.
ReplicationGroupPendingModifiedValues
data ReplicationGroupPendingModifiedValues Source #
The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.
See: newReplicationGroupPendingModifiedValues smart constructor.
Constructors
Instances
newReplicationGroupPendingModifiedValues :: ReplicationGroupPendingModifiedValues Source #
Create a value of ReplicationGroupPendingModifiedValues 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:authTokenStatus:ReplicationGroupPendingModifiedValues', replicationGroupPendingModifiedValues_authTokenStatus - The auth token status
$sel:userGroups:ReplicationGroupPendingModifiedValues', replicationGroupPendingModifiedValues_userGroups - The user group being modified.
$sel:logDeliveryConfigurations:ReplicationGroupPendingModifiedValues', replicationGroupPendingModifiedValues_logDeliveryConfigurations - The log delivery configurations being modified
$sel:resharding:ReplicationGroupPendingModifiedValues', replicationGroupPendingModifiedValues_resharding - The status of an online resharding operation.
$sel:primaryClusterId:ReplicationGroupPendingModifiedValues', replicationGroupPendingModifiedValues_primaryClusterId - The primary cluster ID that is applied immediately (if
--apply-immediately was specified), or during the next maintenance
window.
$sel:automaticFailoverStatus:ReplicationGroupPendingModifiedValues', replicationGroupPendingModifiedValues_automaticFailoverStatus - Indicates the status of automatic failover for this Redis replication
group.
ReservedCacheNode
data ReservedCacheNode Source #
Represents the output of a PurchaseReservedCacheNodesOffering
operation.
See: newReservedCacheNode smart constructor.
Constructors
| ReservedCacheNode' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Int) (Maybe Text) |
Instances
newReservedCacheNode :: ReservedCacheNode Source #
Create a value of ReservedCacheNode 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:cacheNodeType:ReservedCacheNode', reservedCacheNode_cacheNodeType - The cache node type for the reserved cache nodes.
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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
$sel:state:ReservedCacheNode', reservedCacheNode_state - The state of the reserved cache node.
$sel:startTime:ReservedCacheNode', reservedCacheNode_startTime - The time the reservation started.
$sel:productDescription:ReservedCacheNode', reservedCacheNode_productDescription - The description of the reserved cache node.
$sel:reservationARN:ReservedCacheNode', reservedCacheNode_reservationARN - The Amazon Resource Name (ARN) of the reserved cache node.
Example:
arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
$sel:cacheNodeCount:ReservedCacheNode', reservedCacheNode_cacheNodeCount - The number of cache nodes that have been reserved.
$sel:reservedCacheNodeId:ReservedCacheNode', reservedCacheNode_reservedCacheNodeId - The unique identifier for the reservation.
$sel:recurringCharges:ReservedCacheNode', reservedCacheNode_recurringCharges - The recurring price charged to run this reserved cache node.
$sel:offeringType:ReservedCacheNode', reservedCacheNode_offeringType - The offering type of this reserved cache node.
$sel:usagePrice:ReservedCacheNode', reservedCacheNode_usagePrice - The hourly price charged for this reserved cache node.
$sel:fixedPrice:ReservedCacheNode', reservedCacheNode_fixedPrice - The fixed price charged for this reserved cache node.
$sel:duration:ReservedCacheNode', reservedCacheNode_duration - The duration of the reservation in seconds.
$sel:reservedCacheNodesOfferingId:ReservedCacheNode', reservedCacheNode_reservedCacheNodesOfferingId - The offering identifier.
ReservedCacheNodesOffering
data ReservedCacheNodesOffering Source #
Describes all of the attributes of a reserved cache node offering.
See: newReservedCacheNodesOffering smart constructor.
Constructors
| ReservedCacheNodesOffering' (Maybe Text) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Int) (Maybe Text) |
Instances
newReservedCacheNodesOffering :: ReservedCacheNodesOffering Source #
Create a value of ReservedCacheNodesOffering 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:cacheNodeType:ReservedCacheNodesOffering', 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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
$sel:productDescription:ReservedCacheNodesOffering', reservedCacheNodesOffering_productDescription - The cache engine used by the offering.
$sel:recurringCharges:ReservedCacheNodesOffering', reservedCacheNodesOffering_recurringCharges - The recurring price charged to run this reserved cache node.
$sel:offeringType:ReservedCacheNodesOffering', reservedCacheNodesOffering_offeringType - The offering type.
$sel:usagePrice:ReservedCacheNodesOffering', reservedCacheNodesOffering_usagePrice - The hourly price charged for this offering.
$sel:fixedPrice:ReservedCacheNodesOffering', reservedCacheNodesOffering_fixedPrice - The fixed price charged for this offering.
$sel:duration:ReservedCacheNodesOffering', reservedCacheNodesOffering_duration - The duration of the offering. in seconds.
$sel:reservedCacheNodesOfferingId:ReservedCacheNodesOffering', reservedCacheNodesOffering_reservedCacheNodesOfferingId - A unique identifier for the reserved cache node offering.
ReshardingConfiguration
data ReshardingConfiguration Source #
A list of PreferredAvailabilityZones objects that specifies the
configuration of a node group in the resharded cluster.
See: newReshardingConfiguration smart constructor.
Constructors
| ReshardingConfiguration' (Maybe [Text]) (Maybe Text) |
Instances
newReshardingConfiguration :: ReshardingConfiguration Source #
Create a value of ReshardingConfiguration 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:preferredAvailabilityZones:ReshardingConfiguration', reshardingConfiguration_preferredAvailabilityZones - A list of preferred availability zones for the nodes in this cluster.
$sel:nodeGroupId:ReshardingConfiguration', reshardingConfiguration_nodeGroupId - Either the ElastiCache for Redis supplied 4-digit id or a user supplied
id for the node group these configuration values apply to.
ReshardingStatus
data ReshardingStatus Source #
The status of an online resharding operation.
See: newReshardingStatus smart constructor.
Constructors
| ReshardingStatus' (Maybe SlotMigration) |
Instances
newReshardingStatus :: ReshardingStatus Source #
Create a value of ReshardingStatus 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:slotMigration:ReshardingStatus', reshardingStatus_slotMigration - Represents the progress of an online resharding operation.
SecurityGroupMembership
data SecurityGroupMembership Source #
Represents a single cache security group and its status.
See: newSecurityGroupMembership smart constructor.
Constructors
| SecurityGroupMembership' (Maybe Text) (Maybe Text) |
Instances
newSecurityGroupMembership :: SecurityGroupMembership Source #
Create a value of SecurityGroupMembership 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:status:SecurityGroupMembership', securityGroupMembership_status - The status of the cache security group membership. The status changes
whenever a cache security group is modified, or when the cache security
groups assigned to a cluster are modified.
$sel:securityGroupId:SecurityGroupMembership', securityGroupMembership_securityGroupId - The identifier of the cache security group.
ServiceUpdate
data ServiceUpdate Source #
An update that you can apply to your Redis clusters.
See: newServiceUpdate smart constructor.
Constructors
| ServiceUpdate' (Maybe Text) (Maybe ServiceUpdateType) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Bool) (Maybe ServiceUpdateSeverity) (Maybe ISO8601) (Maybe Text) (Maybe ISO8601) (Maybe ServiceUpdateStatus) (Maybe Text) |
Instances
newServiceUpdate :: ServiceUpdate Source #
Create a value of ServiceUpdate 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:engineVersion:ServiceUpdate', serviceUpdate_engineVersion - The Elasticache engine version to which the update applies. Either Redis
or Memcached engine version
$sel:serviceUpdateType:ServiceUpdate', serviceUpdate_serviceUpdateType - Reflects the nature of the service update
$sel:serviceUpdateName:ServiceUpdate', serviceUpdate_serviceUpdateName - The unique ID of the service update
$sel:engine:ServiceUpdate', serviceUpdate_engine - The Elasticache engine to which the update applies. Either Redis or
Memcached
$sel:serviceUpdateReleaseDate:ServiceUpdate', serviceUpdate_serviceUpdateReleaseDate - The date when the service update is initially available
$sel:autoUpdateAfterRecommendedApplyByDate:ServiceUpdate', serviceUpdate_autoUpdateAfterRecommendedApplyByDate - Indicates whether the service update will be automatically applied once
the recommended apply-by date has expired.
$sel:serviceUpdateSeverity:ServiceUpdate', serviceUpdate_serviceUpdateSeverity - The severity of the service update
$sel:serviceUpdateEndDate:ServiceUpdate', serviceUpdate_serviceUpdateEndDate - The date after which the service update is no longer available
$sel:serviceUpdateDescription:ServiceUpdate', serviceUpdate_serviceUpdateDescription - Provides details of the service update
$sel:serviceUpdateRecommendedApplyByDate:ServiceUpdate', serviceUpdate_serviceUpdateRecommendedApplyByDate - The recommendend date to apply the service update in order to ensure
compliance. For information on compliance, see
Self-Service Security Updates for Compliance.
$sel:serviceUpdateStatus:ServiceUpdate', serviceUpdate_serviceUpdateStatus - The status of the service update
$sel:estimatedUpdateTime:ServiceUpdate', serviceUpdate_estimatedUpdateTime - The estimated length of time the service update will take
SlotMigration
data SlotMigration Source #
Represents the progress of an online resharding operation.
See: newSlotMigration smart constructor.
Constructors
| SlotMigration' (Maybe Double) |
Instances
newSlotMigration :: SlotMigration Source #
Create a value of SlotMigration 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:progressPercentage:SlotMigration', slotMigration_progressPercentage - The percentage of the slot migration that is complete.
Snapshot
Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.
See: newSnapshot smart constructor.
Constructors
| Snapshot' (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [NodeSnapshot]) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe AutomaticFailoverStatus) (Maybe Text) |
Instances
newSnapshot :: Snapshot Source #
Create a value of Snapshot 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:engineVersion:Snapshot', snapshot_engineVersion - The version of the cache engine version that is used by the source
cluster.
$sel:cacheNodeType:Snapshot', snapshot_cacheNodeType - The name of the compute and memory capacity node type for the source
cluster.
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.16xlargeFor region availability, see Supported Node Types
M5 node types:
cache.m5.large,cache.m5.xlarge,cache.m5.2xlarge,cache.m5.4xlarge,cache.m5.12xlarge,cache.m5.24xlargeM4 node types:
cache.m4.large,cache.m4.xlarge,cache.m4.2xlarge,cache.m4.4xlarge,cache.m4.10xlargeT3 node types:
cache.t3.micro,cache.t3.small,cache.t3.mediumT2 node types:
cache.t2.micro,cache.t2.small,cache.t2.mediumPrevious generation: (not recommended)
T1 node types:
cache.t1.microM1 node types:
cache.m1.small,cache.m1.medium,cache.m1.large,cache.m1.xlargeM3 node types:
cache.m3.medium,cache.m3.large,cache.m3.xlarge,cache.m3.2xlarge
Compute optimized:
Previous generation: (not recommended)
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.16xlargeFor region availability, see Supported Node Types
R5 node types:
cache.r5.large,cache.r5.xlarge,cache.r5.2xlarge,cache.r5.4xlarge,cache.r5.12xlarge,cache.r5.24xlargeR4 node types:
cache.r4.large,cache.r4.xlarge,cache.r4.2xlarge,cache.r4.4xlarge,cache.r4.8xlarge,cache.r4.16xlargePrevious generation: (not recommended)
M2 node types:
cache.m2.xlarge,cache.m2.2xlarge,cache.m2.4xlargeR3 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
appendonlyandappendfsyncare not supported on Redis version 2.8.22 and later.
$sel:cacheClusterCreateTime:Snapshot', snapshot_cacheClusterCreateTime - The date and time when the source cluster was created.
$sel:autoMinorVersionUpgrade:Snapshot', snapshot_autoMinorVersionUpgrade - This parameter is currently disabled.
$sel:arn:Snapshot', snapshot_arn - The ARN (Amazon Resource Name) of the snapshot.
$sel:cacheParameterGroupName:Snapshot', snapshot_cacheParameterGroupName - The cache parameter group that is associated with the source cluster.
$sel:replicationGroupDescription:Snapshot', snapshot_replicationGroupDescription - A description of the source replication group.
$sel:vpcId:Snapshot', snapshot_vpcId - The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet
group for the source cluster.
$sel:snapshotStatus:Snapshot', snapshot_snapshotStatus - The status of the snapshot. Valid values: creating | available |
restoring | copying | deleting.
$sel:snapshotWindow:Snapshot', snapshot_snapshotWindow - The daily time range during which ElastiCache takes daily snapshots of
the source cluster.
$sel:cacheClusterId:Snapshot', snapshot_cacheClusterId - The user-supplied identifier of the source cluster.
$sel:engine:Snapshot', snapshot_engine - The name of the cache engine (memcached or redis) used by the source
cluster.
$sel:preferredMaintenanceWindow:Snapshot', snapshot_preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the cluster
is performed. It is specified as a range in the format
ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window
is a 60 minute period.
Valid values for ddd are:
sun
mon
tue
wed
thu
fri
sat
Example: sun:23:00-mon:01:30
$sel:topicArn:Snapshot', snapshot_topicArn - The Amazon Resource Name (ARN) for the topic used by the source cluster
for publishing notifications.
$sel:kmsKeyId:Snapshot', snapshot_kmsKeyId - The ID of the KMS key used to encrypt the snapshot.
$sel:nodeSnapshots:Snapshot', snapshot_nodeSnapshots - A list of the cache nodes in the source cluster.
$sel:cacheSubnetGroupName:Snapshot', snapshot_cacheSubnetGroupName - The name of the cache subnet group associated with the source cluster.
$sel:preferredAvailabilityZone:Snapshot', snapshot_preferredAvailabilityZone - The name of the Availability Zone in which the source cluster is
located.
$sel:numNodeGroups:Snapshot', snapshot_numNodeGroups - The number of node groups (shards) in this snapshot. When restoring from
a snapshot, the number of node groups (shards) in the snapshot and in
the restored replication group must be the same.
$sel:snapshotRetentionLimit:Snapshot', snapshot_snapshotRetentionLimit - For an automatic snapshot, the number of days for which ElastiCache
retains the snapshot before deleting it.
For manual snapshots, this field reflects the SnapshotRetentionLimit
for the source cluster when the snapshot was created. This field is
otherwise ignored: Manual snapshots do not expire, and can only be
deleted using the DeleteSnapshot operation.
Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
$sel:snapshotName:Snapshot', snapshot_snapshotName - The name of a snapshot. For an automatic snapshot, the name is
system-generated. For a manual snapshot, this is the user-provided name.
$sel:preferredOutpostArn:Snapshot', snapshot_preferredOutpostArn - The ARN (Amazon Resource Name) of the preferred outpost.
$sel:replicationGroupId:Snapshot', snapshot_replicationGroupId - The unique identifier of the source replication group.
$sel:numCacheNodes:Snapshot', snapshot_numCacheNodes - The number of cache nodes in the source cluster.
For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.
$sel:port:Snapshot', snapshot_port - The port number used by each cache nodes in the source cluster.
$sel:automaticFailover:Snapshot', snapshot_automaticFailover - Indicates the status of automatic failover for the source Redis
replication group.
$sel:snapshotSource:Snapshot', snapshot_snapshotSource - Indicates whether the snapshot is from an automatic backup (automated)
or was created manually (manual).
Subnet
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
See: newSubnet smart constructor.
Constructors
| Subnet' (Maybe Text) (Maybe AvailabilityZone) (Maybe SubnetOutpost) |
Instances
| Eq Subnet Source # | |
| Read Subnet Source # | |
| Show Subnet Source # | |
| Generic Subnet Source # | |
| NFData Subnet Source # | |
Defined in Amazonka.ElastiCache.Types.Subnet | |
| Hashable Subnet Source # | |
Defined in Amazonka.ElastiCache.Types.Subnet | |
| FromXML Subnet Source # | |
| type Rep Subnet Source # | |
Defined in Amazonka.ElastiCache.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.ElastiCache.Types.Subnet" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "subnetAvailabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailabilityZone)) :*: S1 ('MetaSel ('Just "subnetOutpost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SubnetOutpost))))) | |
Create a value of Subnet 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:subnetIdentifier:Subnet', subnet_subnetIdentifier - The unique identifier for the subnet.
$sel:subnetAvailabilityZone:Subnet', subnet_subnetAvailabilityZone - The Availability Zone associated with the subnet.
$sel:subnetOutpost:Subnet', subnet_subnetOutpost - The outpost ARN of the subnet.
SubnetOutpost
data SubnetOutpost Source #
The ID of the outpost subnet.
See: newSubnetOutpost smart constructor.
Constructors
| SubnetOutpost' (Maybe Text) |
Instances
newSubnetOutpost :: SubnetOutpost Source #
Create a value of SubnetOutpost 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:subnetOutpostArn:SubnetOutpost', subnetOutpost_subnetOutpostArn - The outpost ARN of the subnet.
Tag
A tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.
See: newTag smart constructor.
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.ElastiCache.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.ElastiCache.Types.Tag | |
| ToQuery Tag Source # | |
Defined in Amazonka.ElastiCache.Types.Tag Methods toQuery :: Tag -> QueryString # | |
| FromXML Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.ElastiCache.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.ElastiCache.Types.Tag" "libZSservicesZSamazonka-elasticacheZSamazonka-elasticache" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
Create a value of Tag 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:value:Tag', tag_value - The tag's value. May be null.
$sel:key:Tag', tag_key - The key for the tag. May not be null.
TagListMessage
data TagListMessage Source #
Represents the output from the AddTagsToResource,
ListTagsForResource, and RemoveTagsFromResource operations.
See: newTagListMessage smart constructor.
Constructors
| TagListMessage' (Maybe [Tag]) |
Instances
newTagListMessage :: TagListMessage Source #
Create a value of TagListMessage 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:tagList:TagListMessage', tagListMessage_tagList - A list of tags as key-value pairs.
TimeRangeFilter
data TimeRangeFilter Source #
Filters update actions from the service updates that are in available status during the time range.
See: newTimeRangeFilter smart constructor.
Constructors
| TimeRangeFilter' (Maybe ISO8601) (Maybe ISO8601) |
Instances
newTimeRangeFilter :: TimeRangeFilter Source #
Create a value of TimeRangeFilter 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:startTime:TimeRangeFilter', timeRangeFilter_startTime - The start time of the time range filter
$sel:endTime:TimeRangeFilter', timeRangeFilter_endTime - The end time of the time range filter
UnprocessedUpdateAction
data UnprocessedUpdateAction Source #
Update action that has failed to be processed for the corresponding apply/stop request
See: newUnprocessedUpdateAction smart constructor.
Constructors
| UnprocessedUpdateAction' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newUnprocessedUpdateAction :: UnprocessedUpdateAction Source #
Create a value of UnprocessedUpdateAction 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:cacheClusterId:UnprocessedUpdateAction', unprocessedUpdateAction_cacheClusterId - The ID of the cache cluster
$sel:serviceUpdateName:UnprocessedUpdateAction', unprocessedUpdateAction_serviceUpdateName - The unique ID of the service update
$sel:errorType:UnprocessedUpdateAction', unprocessedUpdateAction_errorType - The error type for requests that are not processed
$sel:errorMessage:UnprocessedUpdateAction', unprocessedUpdateAction_errorMessage - The error message that describes the reason the request was not
processed
$sel:replicationGroupId:UnprocessedUpdateAction', unprocessedUpdateAction_replicationGroupId - The replication group ID
UpdateAction
data UpdateAction Source #
The status of the service update for a specific replication group
See: newUpdateAction smart constructor.
Constructors
| UpdateAction' (Maybe ServiceUpdateType) (Maybe SlaMet) (Maybe Text) (Maybe Text) (Maybe UpdateActionStatus) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe ISO8601) (Maybe [CacheNodeUpdateStatus]) (Maybe ServiceUpdateSeverity) (Maybe [NodeGroupUpdateStatus]) (Maybe ISO8601) (Maybe ISO8601) (Maybe ServiceUpdateStatus) (Maybe Text) (Maybe Text) |
Instances
newUpdateAction :: UpdateAction Source #
Create a value of UpdateAction 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:serviceUpdateType:UpdateAction', updateAction_serviceUpdateType - Reflects the nature of the service update
$sel:slaMet:UpdateAction', updateAction_slaMet - If yes, all nodes in the replication group have been updated by the
recommended apply-by date. If no, at least one node in the replication
group have not been updated by the recommended apply-by date. If N/A,
the replication group was created after the recommended apply-by date.
$sel:cacheClusterId:UpdateAction', updateAction_cacheClusterId - The ID of the cache cluster
$sel:serviceUpdateName:UpdateAction', updateAction_serviceUpdateName - The unique ID of the service update
$sel:updateActionStatus:UpdateAction', updateAction_updateActionStatus - The status of the update action
$sel:engine:UpdateAction', updateAction_engine - The Elasticache engine to which the update applies. Either Redis or
Memcached
$sel:nodesUpdated:UpdateAction', updateAction_nodesUpdated - The progress of the service update on the replication group
$sel:updateActionStatusModifiedDate:UpdateAction', updateAction_updateActionStatusModifiedDate - The date when the UpdateActionStatus was last modified
$sel:serviceUpdateReleaseDate:UpdateAction', updateAction_serviceUpdateReleaseDate - The date the update is first available
$sel:cacheNodeUpdateStatus:UpdateAction', updateAction_cacheNodeUpdateStatus - The status of the service update on the cache node
$sel:serviceUpdateSeverity:UpdateAction', updateAction_serviceUpdateSeverity - The severity of the service update
$sel:nodeGroupUpdateStatus:UpdateAction', updateAction_nodeGroupUpdateStatus - The status of the service update on the node group
$sel:serviceUpdateRecommendedApplyByDate:UpdateAction', updateAction_serviceUpdateRecommendedApplyByDate - The recommended date to apply the service update to ensure compliance.
For information on compliance, see
Self-Service Security Updates for Compliance.
$sel:updateActionAvailableDate:UpdateAction', updateAction_updateActionAvailableDate - The date that the service update is available to a replication group
$sel:serviceUpdateStatus:UpdateAction', updateAction_serviceUpdateStatus - The status of the service update
$sel:estimatedUpdateTime:UpdateAction', updateAction_estimatedUpdateTime - The estimated length of time for the update to complete
$sel:replicationGroupId:UpdateAction', updateAction_replicationGroupId - The ID of the replication group
UpdateActionResultsMessage
data UpdateActionResultsMessage Source #
See: newUpdateActionResultsMessage smart constructor.
Constructors
| UpdateActionResultsMessage' (Maybe [UnprocessedUpdateAction]) (Maybe [ProcessedUpdateAction]) |
Instances
newUpdateActionResultsMessage :: UpdateActionResultsMessage Source #
Create a value of UpdateActionResultsMessage 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:unprocessedUpdateActions:UpdateActionResultsMessage', updateActionResultsMessage_unprocessedUpdateActions - Update actions that haven't been processed successfully
$sel:processedUpdateActions:UpdateActionResultsMessage', updateActionResultsMessage_processedUpdateActions - Update actions that have been processed successfully
User
See: newUser smart constructor.
Constructors
| User' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
Create a value of User 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:status:User', user_status - Indicates the user status. Can be "active", "modifying" or
"deleting".
$sel:arn:User', user_arn - The Amazon Resource Name (ARN) of the user.
$sel:userGroupIds:User', user_userGroupIds - Returns a list of the user group IDs the user belongs to.
$sel:authentication:User', user_authentication - Denotes whether the user requires a password to authenticate.
$sel:engine:User', user_engine - The current supported value is Redis.
$sel:userName:User', user_userName - The username of the user.
$sel:accessString:User', user_accessString - Access permissions string used for this user.
$sel:userId:User', user_userId - The ID of the user.
UserGroup
See: newUserGroup smart constructor.
Constructors
| UserGroup' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe UserGroupPendingChanges) (Maybe [Text]) |
Instances
newUserGroup :: UserGroup Source #
Create a value of UserGroup 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:status:UserGroup', userGroup_status - Indicates user group status. Can be "creating", "active",
"modifying", "deleting".
$sel:userIds:UserGroup', userGroup_userIds - The list of user IDs that belong to the user group.
$sel:arn:UserGroup', userGroup_arn - The Amazon Resource Name (ARN) of the user group.
$sel:userGroupId:UserGroup', userGroup_userGroupId - The ID of the user group.
$sel:engine:UserGroup', userGroup_engine - The current supported value is Redis.
$sel:pendingChanges:UserGroup', userGroup_pendingChanges - A list of updates being applied to the user group.
$sel:replicationGroups:UserGroup', userGroup_replicationGroups - A list of replication groups that the user group can access.
UserGroupPendingChanges
data UserGroupPendingChanges Source #
Returns the updates being applied to the user group.
See: newUserGroupPendingChanges smart constructor.
Constructors
| UserGroupPendingChanges' (Maybe [Text]) (Maybe [Text]) |
Instances
newUserGroupPendingChanges :: UserGroupPendingChanges Source #
Create a value of UserGroupPendingChanges 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:userIdsToAdd:UserGroupPendingChanges', userGroupPendingChanges_userIdsToAdd - The list of user IDs to add.
$sel:userIdsToRemove:UserGroupPendingChanges', userGroupPendingChanges_userIdsToRemove - The list of user IDs to remove.
UserGroupsUpdateStatus
data UserGroupsUpdateStatus Source #
The status of the user group update.
See: newUserGroupsUpdateStatus smart constructor.
Constructors
| UserGroupsUpdateStatus' (Maybe [Text]) (Maybe [Text]) |
Instances
newUserGroupsUpdateStatus :: UserGroupsUpdateStatus Source #
Create a value of UserGroupsUpdateStatus 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:userGroupIdsToAdd:UserGroupsUpdateStatus', userGroupsUpdateStatus_userGroupIdsToAdd - The ID of the user group to add.
$sel:userGroupIdsToRemove:UserGroupsUpdateStatus', userGroupsUpdateStatus_userGroupIdsToRemove - The ID of the user group to remove.