Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- ACLAlreadyExistsFault
- ACLNotFoundFault
- ACLQuotaExceededFault
- APICallRateForCustomerExceededFault
- ClusterAlreadyExistsFault
- ClusterNotFoundFault
- ClusterQuotaForCustomerExceededFault
- DefaultUserRequired
- DuplicateUserNameFault
- InsufficientClusterCapacityFault
- InvalidACLStateFault
- InvalidARNFault
- InvalidClusterStateFault
- InvalidCredentialsException
- InvalidKMSKeyFault
- InvalidNodeStateFault
- InvalidParameterCombinationException
- InvalidParameterGroupStateFault
- InvalidParameterValueException
- InvalidSnapshotStateFault
- InvalidSubnet
- InvalidUserStateFault
- InvalidVPCNetworkStateFault
- NoOperationFault
- NodeQuotaForClusterExceededFault
- NodeQuotaForCustomerExceededFault
- ParameterGroupAlreadyExistsFault
- ParameterGroupNotFoundFault
- ParameterGroupQuotaExceededFault
- ReservedNodeAlreadyExistsFault
- ReservedNodeNotFoundFault
- ReservedNodeQuotaExceededFault
- ReservedNodesOfferingNotFoundFault
- ServiceLinkedRoleNotFoundFault
- ServiceUpdateNotFoundFault
- ShardNotFoundFault
- ShardsPerClusterQuotaExceededFault
- SnapshotAlreadyExistsFault
- SnapshotNotFoundFault
- SnapshotQuotaExceededFault
- SubnetGroupAlreadyExistsFault
- SubnetGroupInUseFault
- SubnetGroupNotFoundFault
- SubnetGroupQuotaExceededFault
- SubnetInUse
- SubnetNotAllowedFault
- SubnetQuotaExceededFault
- TagNotFoundFault
- TagQuotaPerResourceExceeded
- TestFailoverNotAvailableFault
- UserAlreadyExistsFault
- UserNotFoundFault
- UserQuotaExceededFault
- Waiters
- Operations
- BatchUpdateCluster
- CopySnapshot
- CreateACL
- CreateCluster
- CreateParameterGroup
- CreateSnapshot
- CreateSubnetGroup
- CreateUser
- DeleteACL
- DeleteCluster
- DeleteParameterGroup
- DeleteSnapshot
- DeleteSubnetGroup
- DeleteUser
- DescribeACLs (Paginated)
- DescribeClusters (Paginated)
- DescribeEngineVersions (Paginated)
- DescribeEvents (Paginated)
- DescribeParameterGroups (Paginated)
- DescribeParameters (Paginated)
- DescribeReservedNodes (Paginated)
- DescribeReservedNodesOfferings (Paginated)
- DescribeServiceUpdates (Paginated)
- DescribeSnapshots (Paginated)
- DescribeSubnetGroups (Paginated)
- DescribeUsers (Paginated)
- FailoverShard
- ListAllowedNodeTypeUpdates
- ListTags
- PurchaseReservedNodesOffering
- ResetParameterGroup
- TagResource
- UntagResource
- UpdateACL
- UpdateCluster
- UpdateParameterGroup
- UpdateSubnetGroup
- UpdateUser
- Types
- AZStatus
- AuthenticationType
- DataTieringStatus
- InputAuthenticationType
- ServiceUpdateStatus
- ServiceUpdateType
- SourceType
- ACL
- ACLPendingChanges
- ACLsUpdateStatus
- Authentication
- AuthenticationMode
- AvailabilityZone
- Cluster
- ClusterConfiguration
- ClusterPendingUpdates
- Endpoint
- EngineVersionInfo
- Event
- Filter
- Node
- Parameter
- ParameterGroup
- ParameterNameValue
- PendingModifiedServiceUpdate
- RecurringCharge
- ReplicaConfigurationRequest
- ReservedNode
- ReservedNodesOffering
- ReshardingStatus
- SecurityGroupMembership
- ServiceUpdate
- ServiceUpdateRequest
- Shard
- ShardConfiguration
- ShardConfigurationRequest
- ShardDetail
- SlotMigration
- Snapshot
- Subnet
- SubnetGroup
- Tag
- UnprocessedCluster
- User
Derived from API version 2021-01-01
of the AWS service descriptions, licensed under Apache 2.0.
MemoryDB for Redis is a fully managed, Redis-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis, a popular open source data store, enabling you to leverage Redis’ flexible and friendly data structures, APIs, and commands.
Synopsis
- defaultService :: Service
- _ACLAlreadyExistsFault :: AsError a => Fold a ServiceError
- _ACLNotFoundFault :: AsError a => Fold a ServiceError
- _ACLQuotaExceededFault :: AsError a => Fold a ServiceError
- _APICallRateForCustomerExceededFault :: AsError a => Fold a ServiceError
- _ClusterAlreadyExistsFault :: AsError a => Fold a ServiceError
- _ClusterNotFoundFault :: AsError a => Fold a ServiceError
- _ClusterQuotaForCustomerExceededFault :: AsError a => Fold a ServiceError
- _DefaultUserRequired :: AsError a => Fold a ServiceError
- _DuplicateUserNameFault :: AsError a => Fold a ServiceError
- _InsufficientClusterCapacityFault :: AsError a => Fold a ServiceError
- _InvalidACLStateFault :: AsError a => Fold a ServiceError
- _InvalidARNFault :: AsError a => Fold a ServiceError
- _InvalidClusterStateFault :: AsError a => Fold a ServiceError
- _InvalidCredentialsException :: AsError a => Fold a ServiceError
- _InvalidKMSKeyFault :: AsError a => Fold a ServiceError
- _InvalidNodeStateFault :: AsError a => Fold a ServiceError
- _InvalidParameterCombinationException :: AsError a => Fold a ServiceError
- _InvalidParameterGroupStateFault :: AsError a => Fold a ServiceError
- _InvalidParameterValueException :: AsError a => Fold a ServiceError
- _InvalidSnapshotStateFault :: AsError a => Fold a ServiceError
- _InvalidSubnet :: AsError a => Fold a ServiceError
- _InvalidUserStateFault :: AsError a => Fold a ServiceError
- _InvalidVPCNetworkStateFault :: AsError a => Fold a ServiceError
- _NoOperationFault :: AsError a => Fold a ServiceError
- _NodeQuotaForClusterExceededFault :: AsError a => Fold a ServiceError
- _NodeQuotaForCustomerExceededFault :: AsError a => Fold a ServiceError
- _ParameterGroupAlreadyExistsFault :: AsError a => Fold a ServiceError
- _ParameterGroupNotFoundFault :: AsError a => Fold a ServiceError
- _ParameterGroupQuotaExceededFault :: AsError a => Fold a ServiceError
- _ReservedNodeAlreadyExistsFault :: AsError a => Fold a ServiceError
- _ReservedNodeNotFoundFault :: AsError a => Fold a ServiceError
- _ReservedNodeQuotaExceededFault :: AsError a => Fold a ServiceError
- _ReservedNodesOfferingNotFoundFault :: AsError a => Fold a ServiceError
- _ServiceLinkedRoleNotFoundFault :: AsError a => Fold a ServiceError
- _ServiceUpdateNotFoundFault :: AsError a => Fold a ServiceError
- _ShardNotFoundFault :: AsError a => Fold a ServiceError
- _ShardsPerClusterQuotaExceededFault :: AsError a => Fold a ServiceError
- _SnapshotAlreadyExistsFault :: AsError a => Fold a ServiceError
- _SnapshotNotFoundFault :: AsError a => Fold a ServiceError
- _SnapshotQuotaExceededFault :: AsError a => Fold a ServiceError
- _SubnetGroupAlreadyExistsFault :: AsError a => Fold a ServiceError
- _SubnetGroupInUseFault :: AsError a => Fold a ServiceError
- _SubnetGroupNotFoundFault :: AsError a => Fold a ServiceError
- _SubnetGroupQuotaExceededFault :: AsError a => Fold a ServiceError
- _SubnetInUse :: AsError a => Fold a ServiceError
- _SubnetNotAllowedFault :: AsError a => Fold a ServiceError
- _SubnetQuotaExceededFault :: AsError a => Fold a ServiceError
- _TagNotFoundFault :: AsError a => Fold a ServiceError
- _TagQuotaPerResourceExceeded :: AsError a => Fold a ServiceError
- _TestFailoverNotAvailableFault :: AsError a => Fold a ServiceError
- _UserAlreadyExistsFault :: AsError a => Fold a ServiceError
- _UserNotFoundFault :: AsError a => Fold a ServiceError
- _UserQuotaExceededFault :: AsError a => Fold a ServiceError
- data BatchUpdateCluster = BatchUpdateCluster' (Maybe ServiceUpdateRequest) [Text]
- newBatchUpdateCluster :: BatchUpdateCluster
- data BatchUpdateClusterResponse = BatchUpdateClusterResponse' (Maybe [Cluster]) (Maybe [UnprocessedCluster]) Int
- newBatchUpdateClusterResponse :: Int -> BatchUpdateClusterResponse
- data CopySnapshot = CopySnapshot' (Maybe Text) (Maybe [Tag]) (Maybe Text) Text Text
- newCopySnapshot :: Text -> Text -> CopySnapshot
- data CopySnapshotResponse = CopySnapshotResponse' (Maybe Snapshot) Int
- newCopySnapshotResponse :: Int -> CopySnapshotResponse
- data CreateACL = CreateACL' (Maybe [Tag]) (Maybe (NonEmpty Text)) Text
- newCreateACL :: Text -> CreateACL
- data CreateACLResponse = CreateACLResponse' (Maybe ACL) Int
- newCreateACLResponse :: Int -> CreateACLResponse
- data CreateCluster = CreateCluster' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) Text Text Text
- newCreateCluster :: Text -> Text -> Text -> CreateCluster
- data CreateClusterResponse = CreateClusterResponse' (Maybe Cluster) Int
- newCreateClusterResponse :: Int -> CreateClusterResponse
- data CreateParameterGroup = CreateParameterGroup' (Maybe Text) (Maybe [Tag]) Text Text
- newCreateParameterGroup :: Text -> Text -> CreateParameterGroup
- data CreateParameterGroupResponse = CreateParameterGroupResponse' (Maybe ParameterGroup) Int
- newCreateParameterGroupResponse :: Int -> CreateParameterGroupResponse
- data CreateSnapshot = CreateSnapshot' (Maybe Text) (Maybe [Tag]) Text Text
- newCreateSnapshot :: Text -> Text -> CreateSnapshot
- data CreateSnapshotResponse = CreateSnapshotResponse' (Maybe Snapshot) Int
- newCreateSnapshotResponse :: Int -> CreateSnapshotResponse
- data CreateSubnetGroup = CreateSubnetGroup' (Maybe Text) (Maybe [Tag]) Text [Text]
- newCreateSubnetGroup :: Text -> CreateSubnetGroup
- data CreateSubnetGroupResponse = CreateSubnetGroupResponse' (Maybe SubnetGroup) Int
- newCreateSubnetGroupResponse :: Int -> CreateSubnetGroupResponse
- data CreateUser = CreateUser' (Maybe [Tag]) Text AuthenticationMode Text
- newCreateUser :: Text -> AuthenticationMode -> Text -> CreateUser
- data CreateUserResponse = CreateUserResponse' (Maybe User) Int
- newCreateUserResponse :: Int -> CreateUserResponse
- data DeleteACL = DeleteACL' Text
- newDeleteACL :: Text -> DeleteACL
- data DeleteACLResponse = DeleteACLResponse' (Maybe ACL) Int
- newDeleteACLResponse :: Int -> DeleteACLResponse
- data DeleteCluster = DeleteCluster' (Maybe Text) Text
- newDeleteCluster :: Text -> DeleteCluster
- data DeleteClusterResponse = DeleteClusterResponse' (Maybe Cluster) Int
- newDeleteClusterResponse :: Int -> DeleteClusterResponse
- data DeleteParameterGroup = DeleteParameterGroup' Text
- newDeleteParameterGroup :: Text -> DeleteParameterGroup
- data DeleteParameterGroupResponse = DeleteParameterGroupResponse' (Maybe ParameterGroup) Int
- newDeleteParameterGroupResponse :: Int -> DeleteParameterGroupResponse
- data DeleteSnapshot = DeleteSnapshot' Text
- newDeleteSnapshot :: Text -> DeleteSnapshot
- data DeleteSnapshotResponse = DeleteSnapshotResponse' (Maybe Snapshot) Int
- newDeleteSnapshotResponse :: Int -> DeleteSnapshotResponse
- data DeleteSubnetGroup = DeleteSubnetGroup' Text
- newDeleteSubnetGroup :: Text -> DeleteSubnetGroup
- data DeleteSubnetGroupResponse = DeleteSubnetGroupResponse' (Maybe SubnetGroup) Int
- newDeleteSubnetGroupResponse :: Int -> DeleteSubnetGroupResponse
- data DeleteUser = DeleteUser' Text
- newDeleteUser :: Text -> DeleteUser
- data DeleteUserResponse = DeleteUserResponse' (Maybe User) Int
- newDeleteUserResponse :: Int -> DeleteUserResponse
- data DescribeACLs = DescribeACLs' (Maybe Text) (Maybe Int) (Maybe Text)
- newDescribeACLs :: DescribeACLs
- data DescribeACLsResponse = DescribeACLsResponse' (Maybe [ACL]) (Maybe Text) Int
- newDescribeACLsResponse :: Int -> DescribeACLsResponse
- data DescribeClusters = DescribeClusters' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool)
- newDescribeClusters :: DescribeClusters
- data DescribeClustersResponse = DescribeClustersResponse' (Maybe [Cluster]) (Maybe Text) Int
- newDescribeClustersResponse :: Int -> DescribeClustersResponse
- data DescribeEngineVersions = DescribeEngineVersions' (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeEngineVersions :: DescribeEngineVersions
- data DescribeEngineVersionsResponse = DescribeEngineVersionsResponse' (Maybe [EngineVersionInfo]) (Maybe Text) Int
- newDescribeEngineVersionsResponse :: Int -> DescribeEngineVersionsResponse
- data DescribeEvents = DescribeEvents' (Maybe Int) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe SourceType) (Maybe POSIX)
- newDescribeEvents :: DescribeEvents
- data DescribeEventsResponse = DescribeEventsResponse' (Maybe [Event]) (Maybe Text) Int
- newDescribeEventsResponse :: Int -> DescribeEventsResponse
- data DescribeParameterGroups = DescribeParameterGroups' (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeParameterGroups :: DescribeParameterGroups
- data DescribeParameterGroupsResponse = DescribeParameterGroupsResponse' (Maybe Text) (Maybe [ParameterGroup]) Int
- newDescribeParameterGroupsResponse :: Int -> DescribeParameterGroupsResponse
- data DescribeParameters = DescribeParameters' (Maybe Int) (Maybe Text) Text
- newDescribeParameters :: Text -> DescribeParameters
- data DescribeParametersResponse = DescribeParametersResponse' (Maybe Text) (Maybe [Parameter]) Int
- newDescribeParametersResponse :: Int -> DescribeParametersResponse
- data DescribeReservedNodes = DescribeReservedNodes' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeReservedNodes :: DescribeReservedNodes
- data DescribeReservedNodesResponse = DescribeReservedNodesResponse' (Maybe Text) (Maybe [ReservedNode]) Int
- newDescribeReservedNodesResponse :: Int -> DescribeReservedNodesResponse
- data DescribeReservedNodesOfferings = DescribeReservedNodesOfferings' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newDescribeReservedNodesOfferings :: DescribeReservedNodesOfferings
- data DescribeReservedNodesOfferingsResponse = DescribeReservedNodesOfferingsResponse' (Maybe Text) (Maybe [ReservedNodesOffering]) Int
- newDescribeReservedNodesOfferingsResponse :: Int -> DescribeReservedNodesOfferingsResponse
- data DescribeServiceUpdates = DescribeServiceUpdates' (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [ServiceUpdateStatus])
- newDescribeServiceUpdates :: DescribeServiceUpdates
- data DescribeServiceUpdatesResponse = DescribeServiceUpdatesResponse' (Maybe Text) (Maybe [ServiceUpdate]) Int
- newDescribeServiceUpdatesResponse :: Int -> DescribeServiceUpdatesResponse
- data DescribeSnapshots = DescribeSnapshots' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text)
- newDescribeSnapshots :: DescribeSnapshots
- data DescribeSnapshotsResponse = DescribeSnapshotsResponse' (Maybe Text) (Maybe [Snapshot]) Int
- newDescribeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
- data DescribeSubnetGroups = DescribeSubnetGroups' (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeSubnetGroups :: DescribeSubnetGroups
- data DescribeSubnetGroupsResponse = DescribeSubnetGroupsResponse' (Maybe Text) (Maybe [SubnetGroup]) Int
- newDescribeSubnetGroupsResponse :: Int -> DescribeSubnetGroupsResponse
- data DescribeUsers = DescribeUsers' (Maybe [Filter]) (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeUsers :: DescribeUsers
- data DescribeUsersResponse = DescribeUsersResponse' (Maybe Text) (Maybe [User]) Int
- newDescribeUsersResponse :: Int -> DescribeUsersResponse
- data FailoverShard = FailoverShard' Text Text
- newFailoverShard :: Text -> Text -> FailoverShard
- data FailoverShardResponse = FailoverShardResponse' (Maybe Cluster) Int
- newFailoverShardResponse :: Int -> FailoverShardResponse
- data ListAllowedNodeTypeUpdates = ListAllowedNodeTypeUpdates' Text
- newListAllowedNodeTypeUpdates :: Text -> ListAllowedNodeTypeUpdates
- data ListAllowedNodeTypeUpdatesResponse = ListAllowedNodeTypeUpdatesResponse' (Maybe [Text]) (Maybe [Text]) Int
- newListAllowedNodeTypeUpdatesResponse :: Int -> ListAllowedNodeTypeUpdatesResponse
- data ListTags = ListTags' Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe [Tag]) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data PurchaseReservedNodesOffering = PurchaseReservedNodesOffering' (Maybe Int) (Maybe Text) (Maybe [Tag]) Text
- newPurchaseReservedNodesOffering :: Text -> PurchaseReservedNodesOffering
- data PurchaseReservedNodesOfferingResponse = PurchaseReservedNodesOfferingResponse' (Maybe ReservedNode) Int
- newPurchaseReservedNodesOfferingResponse :: Int -> PurchaseReservedNodesOfferingResponse
- data ResetParameterGroup = ResetParameterGroup' (Maybe Bool) (Maybe [Text]) Text
- newResetParameterGroup :: Text -> ResetParameterGroup
- data ResetParameterGroupResponse = ResetParameterGroupResponse' (Maybe ParameterGroup) Int
- newResetParameterGroupResponse :: Int -> ResetParameterGroupResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' (Maybe [Tag]) Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' (Maybe [Tag]) Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateACL = UpdateACL' (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) Text
- newUpdateACL :: Text -> UpdateACL
- data UpdateACLResponse = UpdateACLResponse' (Maybe ACL) Int
- newUpdateACLResponse :: Int -> UpdateACLResponse
- data UpdateCluster = UpdateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReplicaConfigurationRequest) (Maybe [Text]) (Maybe ShardConfigurationRequest) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateCluster :: Text -> UpdateCluster
- data UpdateClusterResponse = UpdateClusterResponse' (Maybe Cluster) Int
- newUpdateClusterResponse :: Int -> UpdateClusterResponse
- data UpdateParameterGroup = UpdateParameterGroup' Text [ParameterNameValue]
- newUpdateParameterGroup :: Text -> UpdateParameterGroup
- data UpdateParameterGroupResponse = UpdateParameterGroupResponse' (Maybe ParameterGroup) Int
- newUpdateParameterGroupResponse :: Int -> UpdateParameterGroupResponse
- data UpdateSubnetGroup = UpdateSubnetGroup' (Maybe Text) (Maybe [Text]) Text
- newUpdateSubnetGroup :: Text -> UpdateSubnetGroup
- data UpdateSubnetGroupResponse = UpdateSubnetGroupResponse' (Maybe SubnetGroup) Int
- newUpdateSubnetGroupResponse :: Int -> UpdateSubnetGroupResponse
- data UpdateUser = UpdateUser' (Maybe Text) (Maybe AuthenticationMode) Text
- newUpdateUser :: Text -> UpdateUser
- data UpdateUserResponse = UpdateUserResponse' (Maybe User) Int
- newUpdateUserResponse :: Int -> UpdateUserResponse
- newtype AZStatus where
- AZStatus' {
- fromAZStatus :: Text
- pattern AZStatus_Multiaz :: AZStatus
- pattern AZStatus_Singleaz :: AZStatus
- AZStatus' {
- newtype AuthenticationType where
- newtype DataTieringStatus where
- DataTieringStatus' { }
- pattern DataTieringStatus_False :: DataTieringStatus
- pattern DataTieringStatus_True :: DataTieringStatus
- newtype InputAuthenticationType where
- newtype ServiceUpdateStatus where
- newtype ServiceUpdateType where
- newtype SourceType where
- SourceType' { }
- pattern SourceType_Acl :: SourceType
- pattern SourceType_Cluster :: SourceType
- pattern SourceType_Node :: SourceType
- pattern SourceType_Parameter_group :: SourceType
- pattern SourceType_Subnet_group :: SourceType
- pattern SourceType_User :: SourceType
- data ACL = ACL' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ACLPendingChanges) (Maybe Text) (Maybe [Text])
- newACL :: ACL
- data ACLPendingChanges = ACLPendingChanges' (Maybe [Text]) (Maybe [Text])
- newACLPendingChanges :: ACLPendingChanges
- data ACLsUpdateStatus = ACLsUpdateStatus' (Maybe Text)
- newACLsUpdateStatus :: ACLsUpdateStatus
- data Authentication = Authentication' (Maybe Int) (Maybe AuthenticationType)
- newAuthentication :: Authentication
- data AuthenticationMode = AuthenticationMode' (Maybe (NonEmpty Text)) (Maybe InputAuthenticationType)
- newAuthenticationMode :: AuthenticationMode
- data AvailabilityZone = AvailabilityZone' (Maybe Text)
- newAvailabilityZone :: AvailabilityZone
- data Cluster = Cluster' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe AZStatus) (Maybe Endpoint) (Maybe DataTieringStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe ClusterPendingUpdates) (Maybe [SecurityGroupMembership]) (Maybe [Shard]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool)
- newCluster :: Cluster
- data ClusterConfiguration = ClusterConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe [ShardDetail]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newClusterConfiguration :: ClusterConfiguration
- data ClusterPendingUpdates = ClusterPendingUpdates' (Maybe ACLsUpdateStatus) (Maybe ReshardingStatus) (Maybe [PendingModifiedServiceUpdate])
- newClusterPendingUpdates :: ClusterPendingUpdates
- data Endpoint = Endpoint' (Maybe Text) (Maybe Int)
- newEndpoint :: Endpoint
- data EngineVersionInfo = EngineVersionInfo' (Maybe Text) (Maybe Text) (Maybe Text)
- newEngineVersionInfo :: EngineVersionInfo
- data Event = Event' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe SourceType)
- newEvent :: Event
- data Filter = Filter' Text (NonEmpty Text)
- newFilter :: Text -> NonEmpty Text -> Filter
- data Node = Node' (Maybe Text) (Maybe POSIX) (Maybe Endpoint) (Maybe Text) (Maybe Text)
- newNode :: Node
- data Parameter = Parameter' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newParameter :: Parameter
- data ParameterGroup = ParameterGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newParameterGroup :: ParameterGroup
- data ParameterNameValue = ParameterNameValue' (Maybe Text) (Maybe Text)
- newParameterNameValue :: ParameterNameValue
- data PendingModifiedServiceUpdate = PendingModifiedServiceUpdate' (Maybe Text) (Maybe ServiceUpdateStatus)
- newPendingModifiedServiceUpdate :: PendingModifiedServiceUpdate
- data RecurringCharge = RecurringCharge' (Maybe Double) (Maybe Text)
- newRecurringCharge :: RecurringCharge
- data ReplicaConfigurationRequest = ReplicaConfigurationRequest' (Maybe Int)
- newReplicaConfigurationRequest :: ReplicaConfigurationRequest
- data ReservedNode = ReservedNode' (Maybe Text) (Maybe Int) (Maybe Double) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text)
- newReservedNode :: ReservedNode
- data ReservedNodesOffering = ReservedNodesOffering' (Maybe Int) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text)
- newReservedNodesOffering :: ReservedNodesOffering
- data ReshardingStatus = ReshardingStatus' (Maybe SlotMigration)
- newReshardingStatus :: ReshardingStatus
- data SecurityGroupMembership = SecurityGroupMembership' (Maybe Text) (Maybe Text)
- newSecurityGroupMembership :: SecurityGroupMembership
- data ServiceUpdate = ServiceUpdate' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ServiceUpdateStatus) (Maybe ServiceUpdateType)
- newServiceUpdate :: ServiceUpdate
- data ServiceUpdateRequest = ServiceUpdateRequest' (Maybe Text)
- newServiceUpdateRequest :: ServiceUpdateRequest
- data Shard = Shard' (Maybe Text) (Maybe [Node]) (Maybe Int) (Maybe Text) (Maybe Text)
- newShard :: Shard
- data ShardConfiguration = ShardConfiguration' (Maybe Int) (Maybe Text)
- newShardConfiguration :: ShardConfiguration
- data ShardConfigurationRequest = ShardConfigurationRequest' (Maybe Int)
- newShardConfigurationRequest :: ShardConfigurationRequest
- data ShardDetail = ShardDetail' (Maybe ShardConfiguration) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newShardDetail :: ShardDetail
- data SlotMigration = SlotMigration' (Maybe Double)
- newSlotMigration :: SlotMigration
- data Snapshot = Snapshot' (Maybe Text) (Maybe ClusterConfiguration) (Maybe DataTieringStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSnapshot :: Snapshot
- data Subnet = Subnet' (Maybe AvailabilityZone) (Maybe Text)
- newSubnet :: Subnet
- data SubnetGroup = SubnetGroup' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Subnet]) (Maybe Text)
- newSubnetGroup :: SubnetGroup
- data Tag = Tag' (Maybe Text) (Maybe Text)
- newTag :: Tag
- data UnprocessedCluster = UnprocessedCluster' (Maybe Text) (Maybe Text) (Maybe Text)
- newUnprocessedCluster :: UnprocessedCluster
- data User = User' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Authentication) (Maybe Text) (Maybe Text) (Maybe Text)
- newUser :: User
Service Configuration
defaultService :: Service Source #
API version 2021-01-01
of the Amazon MemoryDB 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 MemoryDb
.
ACLAlreadyExistsFault
_ACLAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
ACLNotFoundFault
_ACLNotFoundFault :: AsError a => Fold a ServiceError Source #
ACLQuotaExceededFault
_ACLQuotaExceededFault :: AsError a => Fold a ServiceError Source #
APICallRateForCustomerExceededFault
ClusterAlreadyExistsFault
_ClusterAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
ClusterNotFoundFault
_ClusterNotFoundFault :: AsError a => Fold a ServiceError Source #
ClusterQuotaForCustomerExceededFault
DefaultUserRequired
_DefaultUserRequired :: AsError a => Fold a ServiceError Source #
DuplicateUserNameFault
_DuplicateUserNameFault :: AsError a => Fold a ServiceError Source #
InsufficientClusterCapacityFault
InvalidACLStateFault
_InvalidACLStateFault :: AsError a => Fold a ServiceError Source #
InvalidARNFault
_InvalidARNFault :: AsError a => Fold a ServiceError Source #
InvalidClusterStateFault
_InvalidClusterStateFault :: AsError a => Fold a ServiceError Source #
InvalidCredentialsException
_InvalidCredentialsException :: AsError a => Fold a ServiceError Source #
InvalidKMSKeyFault
_InvalidKMSKeyFault :: AsError a => Fold a ServiceError Source #
InvalidNodeStateFault
_InvalidNodeStateFault :: AsError a => Fold a ServiceError Source #
InvalidParameterCombinationException
InvalidParameterGroupStateFault
InvalidParameterValueException
InvalidSnapshotStateFault
_InvalidSnapshotStateFault :: AsError a => Fold a ServiceError Source #
InvalidSubnet
_InvalidSubnet :: AsError a => Fold a ServiceError Source #
InvalidUserStateFault
_InvalidUserStateFault :: AsError a => Fold a ServiceError Source #
InvalidVPCNetworkStateFault
_InvalidVPCNetworkStateFault :: AsError a => Fold a ServiceError Source #
NoOperationFault
_NoOperationFault :: AsError a => Fold a ServiceError Source #
NodeQuotaForClusterExceededFault
NodeQuotaForCustomerExceededFault
ParameterGroupAlreadyExistsFault
ParameterGroupNotFoundFault
_ParameterGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
ParameterGroupQuotaExceededFault
ReservedNodeAlreadyExistsFault
_ReservedNodeAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
You already have a reservation with the given identifier.
ReservedNodeNotFoundFault
_ReservedNodeNotFoundFault :: AsError a => Fold a ServiceError Source #
The requested node does not exist.
ReservedNodeQuotaExceededFault
_ReservedNodeQuotaExceededFault :: AsError a => Fold a ServiceError Source #
The request cannot be processed because it would exceed the user's node quota.
ReservedNodesOfferingNotFoundFault
_ReservedNodesOfferingNotFoundFault :: AsError a => Fold a ServiceError Source #
The requested node offering does not exist.
ServiceLinkedRoleNotFoundFault
ServiceUpdateNotFoundFault
_ServiceUpdateNotFoundFault :: AsError a => Fold a ServiceError Source #
ShardNotFoundFault
_ShardNotFoundFault :: AsError a => Fold a ServiceError Source #
ShardsPerClusterQuotaExceededFault
SnapshotAlreadyExistsFault
_SnapshotAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
SnapshotNotFoundFault
_SnapshotNotFoundFault :: AsError a => Fold a ServiceError Source #
SnapshotQuotaExceededFault
_SnapshotQuotaExceededFault :: AsError a => Fold a ServiceError Source #
SubnetGroupAlreadyExistsFault
_SubnetGroupAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
SubnetGroupInUseFault
_SubnetGroupInUseFault :: AsError a => Fold a ServiceError Source #
SubnetGroupNotFoundFault
_SubnetGroupNotFoundFault :: AsError a => Fold a ServiceError Source #
SubnetGroupQuotaExceededFault
_SubnetGroupQuotaExceededFault :: AsError a => Fold a ServiceError Source #
SubnetInUse
_SubnetInUse :: AsError a => Fold a ServiceError Source #
SubnetNotAllowedFault
_SubnetNotAllowedFault :: AsError a => Fold a ServiceError Source #
SubnetQuotaExceededFault
_SubnetQuotaExceededFault :: AsError a => Fold a ServiceError Source #
TagNotFoundFault
_TagNotFoundFault :: AsError a => Fold a ServiceError Source #
TagQuotaPerResourceExceeded
_TagQuotaPerResourceExceeded :: AsError a => Fold a ServiceError Source #
TestFailoverNotAvailableFault
_TestFailoverNotAvailableFault :: AsError a => Fold a ServiceError Source #
UserAlreadyExistsFault
_UserAlreadyExistsFault :: AsError a => Fold a ServiceError Source #
UserNotFoundFault
_UserNotFoundFault :: AsError a => Fold a ServiceError Source #
UserQuotaExceededFault
_UserQuotaExceededFault :: AsError a => Fold a ServiceError Source #
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
BatchUpdateCluster
data BatchUpdateCluster Source #
See: newBatchUpdateCluster
smart constructor.
Instances
newBatchUpdateCluster :: BatchUpdateCluster Source #
Create a value of BatchUpdateCluster
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:serviceUpdate:BatchUpdateCluster'
, batchUpdateCluster_serviceUpdate
- The unique ID of the service update
$sel:clusterNames:BatchUpdateCluster'
, batchUpdateCluster_clusterNames
- The cluster names to apply the updates.
data BatchUpdateClusterResponse Source #
See: newBatchUpdateClusterResponse
smart constructor.
Instances
newBatchUpdateClusterResponse Source #
Create a value of BatchUpdateClusterResponse
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:processedClusters:BatchUpdateClusterResponse'
, batchUpdateClusterResponse_processedClusters
- The list of clusters that have been updated.
$sel:unprocessedClusters:BatchUpdateClusterResponse'
, batchUpdateClusterResponse_unprocessedClusters
- The list of clusters where updates have not been applied.
$sel:httpStatus:BatchUpdateClusterResponse'
, batchUpdateClusterResponse_httpStatus
- The response's http status code.
CopySnapshot
data CopySnapshot Source #
See: newCopySnapshot
smart constructor.
Instances
:: 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:
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: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 MemoryDB has the needed
permissions to this S3 bucket. For more information, see
Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket.
$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. MemoryDB does not permit overwriting a
snapshot, therefore this name must be unique within its context -
MemoryDB or an Amazon S3 bucket if exporting.
data CopySnapshotResponse Source #
See: newCopySnapshotResponse
smart constructor.
Instances
newCopySnapshotResponse Source #
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
- Represents a copy of an entire cluster as of the time when the snapshot
was taken.
$sel:httpStatus:CopySnapshotResponse'
, copySnapshotResponse_httpStatus
- The response's http status code.
CreateACL
See: newCreateACL
smart constructor.
Instances
Create a value of CreateACL
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:CreateACL'
, createACL_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.
CreateACL
, createACL_userNames
- The list of users that belong to the Access Control List.
CreateACL
, createACL_aCLName
- The name of the Access Control List.
data CreateACLResponse Source #
See: newCreateACLResponse
smart constructor.
Instances
Create a value of CreateACLResponse
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:acl:CreateACLResponse'
, createACLResponse_acl
- The newly-created Access Control List.
$sel:httpStatus:CreateACLResponse'
, createACLResponse_httpStatus
- The response's http status code.
CreateCluster
data CreateCluster Source #
See: newCreateCluster
smart constructor.
CreateCluster' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe [Text]) (Maybe [Text]) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe [Tag]) Text Text Text |
Instances
Create a value of CreateCluster
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:
CreateCluster
, createCluster_autoMinorVersionUpgrade
- When set to true, the cluster will automatically receive minor engine
version upgrades after launch.
CreateCluster
, createCluster_dataTiering
- Enables data tiering. Data tiering is only supported for clusters using
the r6gd node type. This parameter must be set when using r6gd nodes.
For more information, see
Data tiering.
CreateCluster
, createCluster_description
- An optional description of the cluster.
CreateCluster
, createCluster_engineVersion
- The version number of the Redis engine to be used for the cluster.
CreateCluster
, createCluster_kmsKeyId
- The ID of the KMS key used to encrypt the cluster.
CreateCluster
, createCluster_maintenanceWindow
- 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:numReplicasPerShard:CreateCluster'
, createCluster_numReplicasPerShard
- The number of replicas to apply to each shard. The default value is 1.
The maximum is 5.
CreateCluster
, createCluster_numShards
- The number of shards the cluster will contain. The default value is 1.
CreateCluster
, createCluster_parameterGroupName
- The name of the parameter group associated with the cluster.
CreateCluster
, createCluster_port
- The port number on which each of the nodes accepts connections.
$sel:securityGroupIds:CreateCluster'
, createCluster_securityGroupIds
- A list of security group names to associate with this cluster.
$sel:snapshotArns:CreateCluster'
, createCluster_snapshotArns
- A list of Amazon Resource Names (ARN) that uniquely identify the RDB
snapshot files stored in Amazon S3. The snapshot files are used to
populate the new cluster. The Amazon S3 object name in the ARN cannot
contain any commas.
$sel:snapshotName:CreateCluster'
, createCluster_snapshotName
- The name of a snapshot from which to restore data into the new cluster.
The snapshot status changes to restoring while the new cluster is being
created.
CreateCluster
, createCluster_snapshotRetentionLimit
- The number of days for which MemoryDB 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.
CreateCluster
, createCluster_snapshotWindow
- The daily time range (in UTC) during which MemoryDB begins taking a
daily snapshot of your shard.
Example: 05:00-09:00
If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
CreateCluster
, createCluster_snsTopicArn
- The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
(SNS) topic to which notifications are sent.
CreateCluster
, createCluster_subnetGroupName
- The name of the subnet group to be used for the cluster.
CreateCluster
, createCluster_tLSEnabled
- A flag to enable in-transit encryption on the cluster.
$sel:tags:CreateCluster'
, createCluster_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.
CreateCluster
, createCluster_clusterName
- The name of the cluster. This value must be unique as it also serves as
the cluster identifier.
CreateCluster
, createCluster_nodeType
- The compute and memory capacity of the nodes in the cluster.
CreateCluster
, createCluster_aCLName
- The name of the Access Control List to associate with the cluster.
data CreateClusterResponse Source #
See: newCreateClusterResponse
smart constructor.
Instances
newCreateClusterResponse Source #
Create a value of CreateClusterResponse
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:cluster:CreateClusterResponse'
, createClusterResponse_cluster
- The newly-created cluster.
$sel:httpStatus:CreateClusterResponse'
, createClusterResponse_httpStatus
- The response's http status code.
CreateParameterGroup
data CreateParameterGroup Source #
See: newCreateParameterGroup
smart constructor.
Instances
newCreateParameterGroup Source #
Create a value of CreateParameterGroup
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:
CreateParameterGroup
, createParameterGroup_description
- An optional description of the parameter group.
$sel:tags:CreateParameterGroup'
, createParameterGroup_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.
CreateParameterGroup
, createParameterGroup_parameterGroupName
- The name of the parameter group.
CreateParameterGroup
, createParameterGroup_family
- The name of the parameter group family that the parameter group can be
used with.
data CreateParameterGroupResponse Source #
See: newCreateParameterGroupResponse
smart constructor.
Instances
newCreateParameterGroupResponse Source #
Create a value of CreateParameterGroupResponse
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:parameterGroup:CreateParameterGroupResponse'
, createParameterGroupResponse_parameterGroup
- The newly-created parameter group.
$sel:httpStatus:CreateParameterGroupResponse'
, createParameterGroupResponse_httpStatus
- The response's http status code.
CreateSnapshot
data CreateSnapshot Source #
See: newCreateSnapshot
smart constructor.
Instances
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:
CreateSnapshot
, createSnapshot_kmsKeyId
- The ID of the KMS key used to encrypt the snapshot.
$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.
CreateSnapshot
, createSnapshot_clusterName
- The snapshot is created from this cluster.
$sel:snapshotName:CreateSnapshot'
, createSnapshot_snapshotName
- A name for the snapshot being created.
data CreateSnapshotResponse Source #
See: newCreateSnapshotResponse
smart constructor.
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
- The newly-created snapshot.
$sel:httpStatus:CreateSnapshotResponse'
, createSnapshotResponse_httpStatus
- The response's http status code.
CreateSubnetGroup
data CreateSubnetGroup Source #
See: newCreateSubnetGroup
smart constructor.
Instances
Create a value of CreateSubnetGroup
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:
CreateSubnetGroup
, createSubnetGroup_description
- A description for the subnet group.
$sel:tags:CreateSubnetGroup'
, createSubnetGroup_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.
CreateSubnetGroup
, createSubnetGroup_subnetGroupName
- The name of the subnet group.
$sel:subnetIds:CreateSubnetGroup'
, createSubnetGroup_subnetIds
- A list of VPC subnet IDs for the subnet group.
data CreateSubnetGroupResponse Source #
See: newCreateSubnetGroupResponse
smart constructor.
Instances
newCreateSubnetGroupResponse Source #
Create a value of CreateSubnetGroupResponse
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:subnetGroup:CreateSubnetGroupResponse'
, createSubnetGroupResponse_subnetGroup
- The newly-created subnet group
$sel:httpStatus:CreateSubnetGroupResponse'
, createSubnetGroupResponse_httpStatus
- The response's http status code.
CreateUser
data CreateUser Source #
See: newCreateUser
smart constructor.
Instances
:: Text | |
-> AuthenticationMode | |
-> 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: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:userName:CreateUser'
, createUser_userName
- The name of the user. This value must be unique as it also serves as the
user identifier.
$sel:authenticationMode:CreateUser'
, createUser_authenticationMode
- Denotes the user's authentication properties, such as whether it
requires a password to authenticate.
CreateUser
, createUser_accessString
- Access permissions string used for this user.
data CreateUserResponse Source #
See: newCreateUserResponse
smart constructor.
Instances
newCreateUserResponse Source #
Create a value of CreateUserResponse
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:user:CreateUserResponse'
, createUserResponse_user
- The newly-created user.
$sel:httpStatus:CreateUserResponse'
, createUserResponse_httpStatus
- The response's http status code.
DeleteACL
See: newDeleteACL
smart constructor.
Instances
Create a value of DeleteACL
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:
DeleteACL
, deleteACL_aCLName
- The name of the Access Control List to delete
data DeleteACLResponse Source #
See: newDeleteACLResponse
smart constructor.
Instances
Create a value of DeleteACLResponse
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:acl:DeleteACLResponse'
, deleteACLResponse_acl
- The Access Control List object that has been deleted.
$sel:httpStatus:DeleteACLResponse'
, deleteACLResponse_httpStatus
- The response's http status code.
DeleteCluster
data DeleteCluster Source #
See: newDeleteCluster
smart constructor.
Instances
Create a value of DeleteCluster
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:finalSnapshotName:DeleteCluster'
, deleteCluster_finalSnapshotName
- The user-supplied name of a final cluster snapshot. This is the unique
name that identifies the snapshot. MemoryDB creates the snapshot, and
then deletes the cluster immediately afterward.
DeleteCluster
, deleteCluster_clusterName
- The name of the cluster to be deleted
data DeleteClusterResponse Source #
See: newDeleteClusterResponse
smart constructor.
Instances
newDeleteClusterResponse Source #
Create a value of DeleteClusterResponse
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:cluster:DeleteClusterResponse'
, deleteClusterResponse_cluster
- The cluster object that has been deleted
$sel:httpStatus:DeleteClusterResponse'
, deleteClusterResponse_httpStatus
- The response's http status code.
DeleteParameterGroup
data DeleteParameterGroup Source #
See: newDeleteParameterGroup
smart constructor.
Instances
newDeleteParameterGroup Source #
Create a value of DeleteParameterGroup
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:
DeleteParameterGroup
, deleteParameterGroup_parameterGroupName
- The name of the parameter group to delete.
data DeleteParameterGroupResponse Source #
See: newDeleteParameterGroupResponse
smart constructor.
Instances
newDeleteParameterGroupResponse Source #
Create a value of DeleteParameterGroupResponse
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:parameterGroup:DeleteParameterGroupResponse'
, deleteParameterGroupResponse_parameterGroup
- The parameter group that has been deleted.
$sel:httpStatus:DeleteParameterGroupResponse'
, deleteParameterGroupResponse_httpStatus
- The response's http status code.
DeleteSnapshot
data DeleteSnapshot Source #
See: newDeleteSnapshot
smart constructor.
Instances
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 delete
data DeleteSnapshotResponse Source #
See: newDeleteSnapshotResponse
smart constructor.
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
- The snapshot object that has been deleted.
$sel:httpStatus:DeleteSnapshotResponse'
, deleteSnapshotResponse_httpStatus
- The response's http status code.
DeleteSubnetGroup
data DeleteSubnetGroup Source #
See: newDeleteSubnetGroup
smart constructor.
Instances
Create a value of DeleteSubnetGroup
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:
DeleteSubnetGroup
, deleteSubnetGroup_subnetGroupName
- The name of the subnet group to delete
data DeleteSubnetGroupResponse Source #
See: newDeleteSubnetGroupResponse
smart constructor.
Instances
newDeleteSubnetGroupResponse Source #
Create a value of DeleteSubnetGroupResponse
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:subnetGroup:DeleteSubnetGroupResponse'
, deleteSubnetGroupResponse_subnetGroup
- The subnet group object that has been deleted.
$sel:httpStatus:DeleteSubnetGroupResponse'
, deleteSubnetGroupResponse_httpStatus
- The response's http status code.
DeleteUser
data DeleteUser Source #
See: newDeleteUser
smart constructor.
Instances
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:userName:DeleteUser'
, deleteUser_userName
- The name of the user to delete
data DeleteUserResponse Source #
See: newDeleteUserResponse
smart constructor.
Instances
newDeleteUserResponse Source #
Create a value of DeleteUserResponse
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:user:DeleteUserResponse'
, deleteUserResponse_user
- The user object that has been deleted.
$sel:httpStatus:DeleteUserResponse'
, deleteUserResponse_httpStatus
- The response's http status code.
DescribeACLs (Paginated)
data DescribeACLs Source #
See: newDescribeACLs
smart constructor.
Instances
newDescribeACLs :: DescribeACLs Source #
Create a value of DescribeACLs
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:
DescribeACLs
, describeACLs_aCLName
- The name of the ACL
$sel:maxResults:DescribeACLs'
, describeACLs_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeACLs
, describeACLs_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
data DescribeACLsResponse Source #
See: newDescribeACLsResponse
smart constructor.
Instances
newDescribeACLsResponse Source #
Create a value of DescribeACLsResponse
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:
DescribeACLsResponse
, describeACLsResponse_aCLs
- The list of ACLs
DescribeACLs
, describeACLsResponse_nextToken
- If nextToken is returned, there are more results available. The value of
nextToken is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged.
$sel:httpStatus:DescribeACLsResponse'
, describeACLsResponse_httpStatus
- The response's http status code.
DescribeClusters (Paginated)
data DescribeClusters Source #
See: newDescribeClusters
smart constructor.
Instances
newDescribeClusters :: DescribeClusters Source #
Create a value of DescribeClusters
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:
DescribeClusters
, describeClusters_clusterName
- The name of the cluster
$sel:maxResults:DescribeClusters'
, describeClusters_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeClusters
, describeClusters_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:showShardDetails:DescribeClusters'
, describeClusters_showShardDetails
- An optional flag that can be included in the request to retrieve
information about the individual shard(s).
data DescribeClustersResponse Source #
See: newDescribeClustersResponse
smart constructor.
Instances
newDescribeClustersResponse Source #
Create a value of DescribeClustersResponse
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:
DescribeClustersResponse
, describeClustersResponse_clusters
- A list of clusters
DescribeClusters
, describeClustersResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:httpStatus:DescribeClustersResponse'
, describeClustersResponse_httpStatus
- The response's http status code.
DescribeEngineVersions (Paginated)
data DescribeEngineVersions Source #
See: newDescribeEngineVersions
smart constructor.
Instances
newDescribeEngineVersions :: DescribeEngineVersions Source #
Create a value of DescribeEngineVersions
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:defaultOnly:DescribeEngineVersions'
, describeEngineVersions_defaultOnly
- If true, specifies that only the default version of the specified engine
or engine and major version combination is to be returned.
DescribeEngineVersions
, describeEngineVersions_engineVersion
- The Redis engine version
$sel:maxResults:DescribeEngineVersions'
, describeEngineVersions_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeEngineVersions
, describeEngineVersions_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
DescribeEngineVersions
, describeEngineVersions_parameterGroupFamily
- The name of a specific parameter group family to return details for.
data DescribeEngineVersionsResponse Source #
See: newDescribeEngineVersionsResponse
smart constructor.
Instances
newDescribeEngineVersionsResponse Source #
Create a value of DescribeEngineVersionsResponse
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:engineVersions:DescribeEngineVersionsResponse'
, describeEngineVersionsResponse_engineVersions
- A list of engine version details. Each element in the list contains
detailed information about one engine version.
DescribeEngineVersions
, describeEngineVersionsResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:httpStatus:DescribeEngineVersionsResponse'
, describeEngineVersionsResponse_httpStatus
- The response's http status code.
DescribeEvents (Paginated)
data DescribeEvents Source #
See: newDescribeEvents
smart constructor.
DescribeEvents' (Maybe Int) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe SourceType) (Maybe POSIX) |
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:
DescribeEvents
, describeEvents_duration
- The number of minutes worth of events to retrieve.
$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:maxResults:DescribeEvents'
, describeEvents_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeEvents
, describeEvents_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
DescribeEvents
, describeEvents_sourceName
- The identifier of the event source for which events are returned. If not
specified, all sources are included in the response.
DescribeEvents
, describeEvents_sourceType
- The event source to retrieve events for. If no value is specified, all
events are returned.
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
data DescribeEventsResponse Source #
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.
DescribeEvents
, describeEventsResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:httpStatus:DescribeEventsResponse'
, describeEventsResponse_httpStatus
- The response's http status code.
DescribeParameterGroups (Paginated)
data DescribeParameterGroups Source #
See: newDescribeParameterGroups
smart constructor.
Instances
newDescribeParameterGroups :: DescribeParameterGroups Source #
Create a value of DescribeParameterGroups
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:maxResults:DescribeParameterGroups'
, describeParameterGroups_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeParameterGroups
, describeParameterGroups_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
DescribeParameterGroups
, describeParameterGroups_parameterGroupName
- The name of a specific parameter group to return details for.
data DescribeParameterGroupsResponse Source #
See: newDescribeParameterGroupsResponse
smart constructor.
Instances
newDescribeParameterGroupsResponse Source #
Create a value of DescribeParameterGroupsResponse
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:
DescribeParameterGroups
, describeParameterGroupsResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:parameterGroups:DescribeParameterGroupsResponse'
, describeParameterGroupsResponse_parameterGroups
- A list of parameter groups. Each element in the list contains detailed
information about one parameter group.
$sel:httpStatus:DescribeParameterGroupsResponse'
, describeParameterGroupsResponse_httpStatus
- The response's http status code.
DescribeParameters (Paginated)
data DescribeParameters Source #
See: newDescribeParameters
smart constructor.
Instances
newDescribeParameters Source #
Create a value of DescribeParameters
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:maxResults:DescribeParameters'
, describeParameters_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeParameters
, describeParameters_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
DescribeParameters
, describeParameters_parameterGroupName
- he name of a specific parameter group to return details for.
data DescribeParametersResponse Source #
See: newDescribeParametersResponse
smart constructor.
Instances
newDescribeParametersResponse Source #
Create a value of DescribeParametersResponse
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:
DescribeParameters
, describeParametersResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:parameters:DescribeParametersResponse'
, describeParametersResponse_parameters
- A list of parameters specific to a particular parameter group. Each
element in the list contains detailed information about one parameter.
$sel:httpStatus:DescribeParametersResponse'
, describeParametersResponse_httpStatus
- The response's http status code.
DescribeReservedNodes (Paginated)
data DescribeReservedNodes Source #
See: newDescribeReservedNodes
smart constructor.
DescribeReservedNodes' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDescribeReservedNodes :: DescribeReservedNodes Source #
Create a value of DescribeReservedNodes
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:
DescribeReservedNodes
, describeReservedNodes_duration
- The duration filter value, specified in years or seconds. Use this
parameter to show only reservations for this duration.
$sel:maxResults:DescribeReservedNodes'
, describeReservedNodes_maxResults
- 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.
DescribeReservedNodes
, describeReservedNodes_nextToken
- 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.
DescribeReservedNodes
, describeReservedNodes_nodeType
- The node type filter value. Use this parameter to show only those
reservations matching the specified node type. For more information, see
Supported node types.
DescribeReservedNodes
, describeReservedNodes_offeringType
- The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type. Valid values:
"All Upfront"|"Partial Upfront"| "No Upfront"
DescribeReservedNodes
, describeReservedNodes_reservationId
- The reserved node identifier filter value. Use this parameter to show
only the reservation that matches the specified reservation ID.
DescribeReservedNodes
, describeReservedNodes_reservedNodesOfferingId
- The offering identifier filter value. Use this parameter to show only
purchased reservations matching the specified offering identifier.
data DescribeReservedNodesResponse Source #
See: newDescribeReservedNodesResponse
smart constructor.
Instances
newDescribeReservedNodesResponse Source #
Create a value of DescribeReservedNodesResponse
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:
DescribeReservedNodes
, describeReservedNodesResponse_nextToken
- 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:reservedNodes:DescribeReservedNodesResponse'
, describeReservedNodesResponse_reservedNodes
- Returns information about reserved nodes for this account, or about a
specified reserved node.
$sel:httpStatus:DescribeReservedNodesResponse'
, describeReservedNodesResponse_httpStatus
- The response's http status code.
DescribeReservedNodesOfferings (Paginated)
data DescribeReservedNodesOfferings Source #
See: newDescribeReservedNodesOfferings
smart constructor.
DescribeReservedNodesOfferings' (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newDescribeReservedNodesOfferings :: DescribeReservedNodesOfferings Source #
Create a value of DescribeReservedNodesOfferings
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:
DescribeReservedNodesOfferings
, describeReservedNodesOfferings_duration
- Duration filter value, specified in years or seconds. Use this parameter
to show only reservations for a given duration.
$sel:maxResults:DescribeReservedNodesOfferings'
, describeReservedNodesOfferings_maxResults
- 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.
DescribeReservedNodesOfferings
, describeReservedNodesOfferings_nextToken
- 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.
DescribeReservedNodesOfferings
, describeReservedNodesOfferings_nodeType
- The node type for the reserved nodes. For more information, see
Supported node types.
DescribeReservedNodesOfferings
, describeReservedNodesOfferings_offeringType
- The offering type filter value. Use this parameter to show only the
available offerings matching the specified offering type. Valid values:
"All Upfront"|"Partial Upfront"| "No Upfront"
DescribeReservedNodesOfferings
, describeReservedNodesOfferings_reservedNodesOfferingId
- The offering identifier filter value. Use this parameter to show only
the available offering that matches the specified reservation
identifier.
data DescribeReservedNodesOfferingsResponse Source #
See: newDescribeReservedNodesOfferingsResponse
smart constructor.
Instances
newDescribeReservedNodesOfferingsResponse Source #
Create a value of DescribeReservedNodesOfferingsResponse
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:
DescribeReservedNodesOfferings
, describeReservedNodesOfferingsResponse_nextToken
- 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:reservedNodesOfferings:DescribeReservedNodesOfferingsResponse'
, describeReservedNodesOfferingsResponse_reservedNodesOfferings
- Lists available reserved node offerings.
$sel:httpStatus:DescribeReservedNodesOfferingsResponse'
, describeReservedNodesOfferingsResponse_httpStatus
- The response's http status code.
DescribeServiceUpdates (Paginated)
data DescribeServiceUpdates Source #
See: newDescribeServiceUpdates
smart constructor.
DescribeServiceUpdates' (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe Text) (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:clusterNames:DescribeServiceUpdates'
, describeServiceUpdates_clusterNames
- The list of cluster names to identify service updates to apply
$sel:maxResults:DescribeServiceUpdates'
, describeServiceUpdates_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeServiceUpdates
, describeServiceUpdates_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
DescribeServiceUpdates
, describeServiceUpdates_serviceUpdateName
- The unique ID of the service update to describe.
DescribeServiceUpdates
, describeServiceUpdates_status
- The status(es) of the service updates to filter on
data DescribeServiceUpdatesResponse Source #
See: newDescribeServiceUpdatesResponse
smart constructor.
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:
DescribeServiceUpdates
, describeServiceUpdatesResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
DescribeServiceUpdatesResponse
, describeServiceUpdatesResponse_serviceUpdates
- A list of service updates
$sel:httpStatus:DescribeServiceUpdatesResponse'
, describeServiceUpdatesResponse_httpStatus
- The response's http status code.
DescribeSnapshots (Paginated)
data DescribeSnapshots Source #
See: newDescribeSnapshots
smart constructor.
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:
DescribeSnapshots
, describeSnapshots_clusterName
- A user-supplied cluster identifier. If this parameter is specified, only
snapshots associated with that specific cluster are described.
$sel:maxResults:DescribeSnapshots'
, describeSnapshots_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeSnapshots
, describeSnapshots_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:showDetail:DescribeSnapshots'
, describeSnapshots_showDetail
- A Boolean value which if true, the shard configuration is included in
the snapshot description.
$sel:snapshotName:DescribeSnapshots'
, describeSnapshots_snapshotName
- A user-supplied name of the snapshot. If this parameter is specified,
only this named snapshot is described.
DescribeSnapshots
, describeSnapshots_source
- If set to system, the output shows snapshots that were automatically
created by MemoryDB. 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 #
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:
DescribeSnapshots
, describeSnapshotsResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:snapshots:DescribeSnapshotsResponse'
, describeSnapshotsResponse_snapshots
- A list of snapshots. Each item in the list contains detailed information
about one snapshot.
$sel:httpStatus:DescribeSnapshotsResponse'
, describeSnapshotsResponse_httpStatus
- The response's http status code.
DescribeSubnetGroups (Paginated)
data DescribeSubnetGroups Source #
See: newDescribeSubnetGroups
smart constructor.
Instances
newDescribeSubnetGroups :: DescribeSubnetGroups Source #
Create a value of DescribeSubnetGroups
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:maxResults:DescribeSubnetGroups'
, describeSubnetGroups_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeSubnetGroups
, describeSubnetGroups_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
DescribeSubnetGroups
, describeSubnetGroups_subnetGroupName
- The name of the subnet group to return details for.
data DescribeSubnetGroupsResponse Source #
See: newDescribeSubnetGroupsResponse
smart constructor.
Instances
newDescribeSubnetGroupsResponse Source #
Create a value of DescribeSubnetGroupsResponse
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:
DescribeSubnetGroups
, describeSubnetGroupsResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:subnetGroups:DescribeSubnetGroupsResponse'
, describeSubnetGroupsResponse_subnetGroups
- A list of subnet groups. Each element in the list contains detailed
information about one group.
$sel:httpStatus:DescribeSubnetGroupsResponse'
, describeSubnetGroupsResponse_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 users to return.
$sel:maxResults:DescribeUsers'
, describeUsers_maxResults
- The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeUsers
, describeUsers_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:userName:DescribeUsers'
, describeUsers_userName
- The name of the user
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:
DescribeUsers
, describeUsersResponse_nextToken
- An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:users:DescribeUsersResponse'
, describeUsersResponse_users
- A list of users.
$sel:httpStatus:DescribeUsersResponse'
, describeUsersResponse_httpStatus
- The response's http status code.
FailoverShard
data FailoverShard Source #
See: newFailoverShard
smart constructor.
Instances
Create a value of FailoverShard
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:
FailoverShard
, failoverShard_clusterName
- The cluster being failed over
$sel:shardName:FailoverShard'
, failoverShard_shardName
- The name of the shard
data FailoverShardResponse Source #
See: newFailoverShardResponse
smart constructor.
Instances
newFailoverShardResponse Source #
Create a value of FailoverShardResponse
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:cluster:FailoverShardResponse'
, failoverShardResponse_cluster
- The cluster being failed over
$sel:httpStatus:FailoverShardResponse'
, failoverShardResponse_httpStatus
- The response's http status code.
ListAllowedNodeTypeUpdates
data ListAllowedNodeTypeUpdates Source #
See: newListAllowedNodeTypeUpdates
smart constructor.
Instances
newListAllowedNodeTypeUpdates Source #
Create a value of ListAllowedNodeTypeUpdates
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:
ListAllowedNodeTypeUpdates
, listAllowedNodeTypeUpdates_clusterName
- The name of the cluster you want to scale. MemoryDB uses the cluster
name to identify the current node type being used by this cluster, and
from that to create a list of node types you can scale up to.
data ListAllowedNodeTypeUpdatesResponse Source #
See: newListAllowedNodeTypeUpdatesResponse
smart constructor.
Instances
newListAllowedNodeTypeUpdatesResponse Source #
Create a value of ListAllowedNodeTypeUpdatesResponse
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:scaleDownNodeTypes:ListAllowedNodeTypeUpdatesResponse'
, listAllowedNodeTypeUpdatesResponse_scaleDownNodeTypes
- A list node types which you can use to scale down your cluster.
$sel:scaleUpNodeTypes:ListAllowedNodeTypeUpdatesResponse'
, listAllowedNodeTypeUpdatesResponse_scaleUpNodeTypes
- A list node types which you can use to scale up your cluster.
$sel:httpStatus:ListAllowedNodeTypeUpdatesResponse'
, listAllowedNodeTypeUpdatesResponse_httpStatus
- The response's http status code.
ListTags
See: newListTags
smart constructor.
Instances
Create a value of ListTags
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:resourceArn:ListTags'
, listTags_resourceArn
- The Amazon Resource Name (ARN) of the resource for which you want the
list of tags
data ListTagsResponse Source #
See: newListTagsResponse
smart constructor.
ListTagsResponse' (Maybe [Tag]) Int |
Instances
Create a value of ListTagsResponse
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:ListTagsResponse'
, listTagsResponse_tagList
- A list of tags as key-value pairs.
$sel:httpStatus:ListTagsResponse'
, listTagsResponse_httpStatus
- The response's http status code.
PurchaseReservedNodesOffering
data PurchaseReservedNodesOffering Source #
See: newPurchaseReservedNodesOffering
smart constructor.
Instances
newPurchaseReservedNodesOffering Source #
Create a value of PurchaseReservedNodesOffering
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:
PurchaseReservedNodesOffering
, purchaseReservedNodesOffering_nodeCount
- The number of node instances to reserve.
PurchaseReservedNodesOffering
, purchaseReservedNodesOffering_reservationId
- A customer-specified identifier to track this reservation.
$sel:tags:PurchaseReservedNodesOffering'
, purchaseReservedNodesOffering_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.
PurchaseReservedNodesOffering
, purchaseReservedNodesOffering_reservedNodesOfferingId
- The ID of the reserved node offering to purchase.
data PurchaseReservedNodesOfferingResponse Source #
See: newPurchaseReservedNodesOfferingResponse
smart constructor.
Instances
newPurchaseReservedNodesOfferingResponse Source #
Create a value of PurchaseReservedNodesOfferingResponse
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:reservedNode:PurchaseReservedNodesOfferingResponse'
, purchaseReservedNodesOfferingResponse_reservedNode
- Represents the output of a PurchaseReservedNodesOffering
operation.
$sel:httpStatus:PurchaseReservedNodesOfferingResponse'
, purchaseReservedNodesOfferingResponse_httpStatus
- The response's http status code.
ResetParameterGroup
data ResetParameterGroup Source #
See: newResetParameterGroup
smart constructor.
Instances
newResetParameterGroup Source #
Create a value of ResetParameterGroup
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:allParameters:ResetParameterGroup'
, resetParameterGroup_allParameters
- If true, all parameters in the parameter group are reset to their
default values. If false, only the parameters listed by ParameterNames
are reset to their default values.
$sel:parameterNames:ResetParameterGroup'
, resetParameterGroup_parameterNames
- An array of parameter names to reset to their default values. If
AllParameters is true, do not use ParameterNames. If AllParameters is
false, you must specify the name of at least one parameter to reset.
ResetParameterGroup
, resetParameterGroup_parameterGroupName
- The name of the parameter group to reset.
data ResetParameterGroupResponse Source #
See: newResetParameterGroupResponse
smart constructor.
Instances
newResetParameterGroupResponse Source #
Create a value of ResetParameterGroupResponse
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:parameterGroup:ResetParameterGroupResponse'
, resetParameterGroupResponse_parameterGroup
- The parameter group being reset.
$sel:httpStatus:ResetParameterGroupResponse'
, resetParameterGroupResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource to which the tags are to
be added
$sel:tags:TagResource'
, tagResource_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 TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:TagResourceResponse'
, tagResourceResponse_tagList
- A list of tags as key-value pairs.
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) of the resource to which the tags are to
be removed
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The list of keys of the tags that are to be removed
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:UntagResourceResponse'
, untagResourceResponse_tagList
- The list of tags removed
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateACL
See: newUpdateACL
smart constructor.
Instances
Create a value of UpdateACL
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:
UpdateACL
, updateACL_userNamesToAdd
- The list of users to add to the Access Control List
UpdateACL
, updateACL_userNamesToRemove
- The list of users to remove from the Access Control List
UpdateACL
, updateACL_aCLName
- The name of the Access Control List
data UpdateACLResponse Source #
See: newUpdateACLResponse
smart constructor.
Instances
Create a value of UpdateACLResponse
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:acl:UpdateACLResponse'
, updateACLResponse_acl
- The updated Access Control List
$sel:httpStatus:UpdateACLResponse'
, updateACLResponse_httpStatus
- The response's http status code.
UpdateCluster
data UpdateCluster Source #
See: newUpdateCluster
smart constructor.
UpdateCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReplicaConfigurationRequest) (Maybe [Text]) (Maybe ShardConfigurationRequest) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of UpdateCluster
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:
UpdateCluster
, updateCluster_aCLName
- The Access Control List that is associated with the cluster
UpdateCluster
, updateCluster_description
- The description of the cluster to update
UpdateCluster
, updateCluster_engineVersion
- The upgraded version of the engine to be run on the nodes. You can
upgrade to a newer engine 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.
UpdateCluster
, updateCluster_maintenanceWindow
- 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
UpdateCluster
, updateCluster_nodeType
- A valid node type that you want to scale this cluster up or down to.
UpdateCluster
, updateCluster_parameterGroupName
- The name of the parameter group to update
$sel:replicaConfiguration:UpdateCluster'
, updateCluster_replicaConfiguration
- The number of replicas that will reside in each shard
$sel:securityGroupIds:UpdateCluster'
, updateCluster_securityGroupIds
- The SecurityGroupIds to update
$sel:shardConfiguration:UpdateCluster'
, updateCluster_shardConfiguration
- The number of shards in the cluster
UpdateCluster
, updateCluster_snapshotRetentionLimit
- The number of days for which MemoryDB 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.
UpdateCluster
, updateCluster_snapshotWindow
- The daily time range (in UTC) during which MemoryDB begins taking a
daily snapshot of your cluster.
UpdateCluster
, updateCluster_snsTopicArn
- The SNS topic ARN to update
UpdateCluster
, updateCluster_snsTopicStatus
- The status of the Amazon SNS notification topic. Notifications are sent
only if the status is active.
UpdateCluster
, updateCluster_clusterName
- The name of the cluster to update
data UpdateClusterResponse Source #
See: newUpdateClusterResponse
smart constructor.
Instances
newUpdateClusterResponse Source #
Create a value of UpdateClusterResponse
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:cluster:UpdateClusterResponse'
, updateClusterResponse_cluster
- The updated cluster
$sel:httpStatus:UpdateClusterResponse'
, updateClusterResponse_httpStatus
- The response's http status code.
UpdateParameterGroup
data UpdateParameterGroup Source #
See: newUpdateParameterGroup
smart constructor.
Instances
newUpdateParameterGroup Source #
Create a value of UpdateParameterGroup
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:
UpdateParameterGroup
, updateParameterGroup_parameterGroupName
- The name of the parameter group to update.
$sel:parameterNameValues:UpdateParameterGroup'
, updateParameterGroup_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 updated per request.
data UpdateParameterGroupResponse Source #
See: newUpdateParameterGroupResponse
smart constructor.
Instances
newUpdateParameterGroupResponse Source #
Create a value of UpdateParameterGroupResponse
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:parameterGroup:UpdateParameterGroupResponse'
, updateParameterGroupResponse_parameterGroup
- The updated parameter group
$sel:httpStatus:UpdateParameterGroupResponse'
, updateParameterGroupResponse_httpStatus
- The response's http status code.
UpdateSubnetGroup
data UpdateSubnetGroup Source #
See: newUpdateSubnetGroup
smart constructor.
Instances
Create a value of UpdateSubnetGroup
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:
UpdateSubnetGroup
, updateSubnetGroup_description
- A description of the subnet group
$sel:subnetIds:UpdateSubnetGroup'
, updateSubnetGroup_subnetIds
- The EC2 subnet IDs for the subnet group.
UpdateSubnetGroup
, updateSubnetGroup_subnetGroupName
- The name of the subnet group
data UpdateSubnetGroupResponse Source #
See: newUpdateSubnetGroupResponse
smart constructor.
Instances
newUpdateSubnetGroupResponse Source #
Create a value of UpdateSubnetGroupResponse
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:subnetGroup:UpdateSubnetGroupResponse'
, updateSubnetGroupResponse_subnetGroup
- The updated subnet group
$sel:httpStatus:UpdateSubnetGroupResponse'
, updateSubnetGroupResponse_httpStatus
- The response's http status code.
UpdateUser
data UpdateUser Source #
See: newUpdateUser
smart constructor.
Instances
Create a value of UpdateUser
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:
UpdateUser
, updateUser_accessString
- Access permissions string used for this user.
$sel:authenticationMode:UpdateUser'
, updateUser_authenticationMode
- Denotes the user's authentication properties, such as whether it
requires a password to authenticate.
$sel:userName:UpdateUser'
, updateUser_userName
- The name of the user
data UpdateUserResponse Source #
See: newUpdateUserResponse
smart constructor.
Instances
newUpdateUserResponse Source #
Create a value of UpdateUserResponse
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:user:UpdateUserResponse'
, updateUserResponse_user
- The updated user
$sel:httpStatus:UpdateUserResponse'
, updateUserResponse_httpStatus
- The response's http status code.
Types
AZStatus
pattern AZStatus_Multiaz :: AZStatus | |
pattern AZStatus_Singleaz :: AZStatus |
Instances
AuthenticationType
newtype AuthenticationType Source #
pattern AuthenticationType_No_password :: AuthenticationType | |
pattern AuthenticationType_Password :: AuthenticationType |
Instances
DataTieringStatus
newtype DataTieringStatus Source #
pattern DataTieringStatus_False :: DataTieringStatus | |
pattern DataTieringStatus_True :: DataTieringStatus |
Instances
InputAuthenticationType
newtype InputAuthenticationType Source #
Instances
ServiceUpdateStatus
newtype ServiceUpdateStatus Source #
pattern ServiceUpdateStatus_Available :: ServiceUpdateStatus | |
pattern ServiceUpdateStatus_Complete :: ServiceUpdateStatus | |
pattern ServiceUpdateStatus_In_progress :: ServiceUpdateStatus | |
pattern ServiceUpdateStatus_Scheduled :: ServiceUpdateStatus |
Instances
ServiceUpdateType
newtype ServiceUpdateType Source #
Instances
SourceType
newtype SourceType Source #
pattern SourceType_Acl :: SourceType | |
pattern SourceType_Cluster :: SourceType | |
pattern SourceType_Node :: SourceType | |
pattern SourceType_Parameter_group :: SourceType | |
pattern SourceType_Subnet_group :: SourceType | |
pattern SourceType_User :: SourceType |
Instances
ACL
An Access Control List. You can authenticate users with Access Contol Lists. ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.
See: newACL
smart constructor.
ACL' (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ACLPendingChanges) (Maybe Text) (Maybe [Text]) |
Instances
Create a value of ACL
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:ACL'
, acl_arn
- The Amazon Resource Name (ARN) of the ACL
$sel:clusters:ACL'
, acl_clusters
- A list of clusters associated with the ACL.
$sel:minimumEngineVersion:ACL'
, acl_minimumEngineVersion
- The minimum engine version supported for the ACL
$sel:name:ACL'
, acl_name
- The name of the Access Control List
$sel:pendingChanges:ACL'
, acl_pendingChanges
- A list of updates being applied to the ACL.
$sel:status:ACL'
, acl_status
- Indicates ACL status. Can be "creating", "active", "modifying",
"deleting".
$sel:userNames:ACL'
, acl_userNames
- The list of user names that belong to the ACL.
ACLPendingChanges
data ACLPendingChanges Source #
Returns the updates being applied to the ACL.
See: newACLPendingChanges
smart constructor.
ACLPendingChanges' (Maybe [Text]) (Maybe [Text]) |
Instances
newACLPendingChanges :: ACLPendingChanges Source #
Create a value of ACLPendingChanges
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:userNamesToAdd:ACLPendingChanges'
, aCLPendingChanges_userNamesToAdd
- A list of users being added to the ACL
$sel:userNamesToRemove:ACLPendingChanges'
, aCLPendingChanges_userNamesToRemove
- A list of user names being removed from the ACL
ACLsUpdateStatus
data ACLsUpdateStatus Source #
The status of the ACL update
See: newACLsUpdateStatus
smart constructor.
Instances
newACLsUpdateStatus :: ACLsUpdateStatus Source #
Create a value of ACLsUpdateStatus
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:aCLToApply:ACLsUpdateStatus'
, aCLsUpdateStatus_aCLToApply
- A list of ACLs pending to be applied.
Authentication
data Authentication Source #
Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.
See: newAuthentication
smart constructor.
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.
AuthenticationMode
data AuthenticationMode Source #
Denotes the user's authentication properties, such as whether it requires a password to authenticate. Used in output responses.
See: newAuthenticationMode
smart constructor.
Instances
newAuthenticationMode :: AuthenticationMode Source #
Create a value of AuthenticationMode
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:AuthenticationMode'
, authenticationMode_passwords
- The password(s) used for authentication
$sel:type':AuthenticationMode'
, authenticationMode_type
- Indicates whether the user requires a password to authenticate. All
newly-created users require a password.
AvailabilityZone
data AvailabilityZone Source #
Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).
See: newAvailabilityZone
smart constructor.
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.
Cluster
Contains all of the attributes of a specific cluster.
See: newCluster
smart constructor.
Cluster' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe AZStatus) (Maybe Endpoint) (Maybe DataTieringStatus) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe ClusterPendingUpdates) (Maybe [SecurityGroupMembership]) (Maybe [Shard]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) |
Instances
newCluster :: Cluster Source #
Create a value of Cluster
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:aCLName:Cluster'
, cluster_aCLName
- The name of the Access Control List associated with this cluster.
$sel:arn:Cluster'
, cluster_arn
- The Amazon Resource Name (ARN) of the cluster.
$sel:autoMinorVersionUpgrade:Cluster'
, cluster_autoMinorVersionUpgrade
- When set to true, the cluster will automatically receive minor engine
version upgrades after launch.
$sel:availabilityMode:Cluster'
, cluster_availabilityMode
- Indicates if the cluster has a Multi-AZ configuration (multiaz) or not
(singleaz).
$sel:clusterEndpoint:Cluster'
, cluster_clusterEndpoint
- The cluster's configuration endpoint
$sel:dataTiering:Cluster'
, cluster_dataTiering
- Enables data tiering. Data tiering is only supported for clusters using
the r6gd node type. This parameter must be set when using r6gd nodes.
For more information, see
Data tiering.
$sel:description:Cluster'
, cluster_description
- A description of the cluster
$sel:enginePatchVersion:Cluster'
, cluster_enginePatchVersion
- The Redis engine patch version used by the cluster
$sel:engineVersion:Cluster'
, cluster_engineVersion
- The Redis engine version used by the cluster
$sel:kmsKeyId:Cluster'
, cluster_kmsKeyId
- The ID of the KMS key used to encrypt the cluster
$sel:maintenanceWindow:Cluster'
, cluster_maintenanceWindow
- 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.
Cluster
, cluster_name
- The user-supplied name of the cluster. This identifier is a unique key
that identifies a cluster.
$sel:nodeType:Cluster'
, cluster_nodeType
- The cluster's node type
$sel:numberOfShards:Cluster'
, cluster_numberOfShards
- The number of shards in the cluster
$sel:parameterGroupName:Cluster'
, cluster_parameterGroupName
- The name of the parameter group used by the cluster
$sel:parameterGroupStatus:Cluster'
, cluster_parameterGroupStatus
- The status of the parameter group used by the cluster, for example
'active' or 'applying'.
$sel:pendingUpdates:Cluster'
, cluster_pendingUpdates
- A group of settings that are currently being applied.
$sel:securityGroups:Cluster'
, cluster_securityGroups
- A list of security groups used by the cluster
$sel:shards:Cluster'
, cluster_shards
- A list of shards that are members of the cluster.
$sel:snapshotRetentionLimit:Cluster'
, cluster_snapshotRetentionLimit
- The number of days for which MemoryDB 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.
$sel:snapshotWindow:Cluster'
, cluster_snapshotWindow
- The daily time range (in UTC) during which MemoryDB begins taking a
daily snapshot of your shard. Example: 05:00-09:00 If you do not specify
this parameter, MemoryDB automatically chooses an appropriate time
range.
$sel:snsTopicArn:Cluster'
, cluster_snsTopicArn
- The Amazon Resource Name (ARN) of the SNS notification topic
$sel:snsTopicStatus:Cluster'
, cluster_snsTopicStatus
- The SNS topic must be in Active status to receive notifications
Cluster
, cluster_status
- The status of the cluster. For example, Available, Updating, Creating.
$sel:subnetGroupName:Cluster'
, cluster_subnetGroupName
- The name of the subnet group used by the cluster
$sel:tLSEnabled:Cluster'
, cluster_tLSEnabled
- A flag to indicate if In-transit encryption is enabled
ClusterConfiguration
data ClusterConfiguration Source #
A list of cluster configuration options.
See: newClusterConfiguration
smart constructor.
ClusterConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe [ShardDetail]) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newClusterConfiguration :: ClusterConfiguration Source #
Create a value of ClusterConfiguration
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:description:ClusterConfiguration'
, clusterConfiguration_description
- The description of the cluster configuration
$sel:engineVersion:ClusterConfiguration'
, clusterConfiguration_engineVersion
- The Redis engine version used by the cluster
$sel:maintenanceWindow:ClusterConfiguration'
, clusterConfiguration_maintenanceWindow
- The specified maintenance window for the cluster
ClusterConfiguration
, clusterConfiguration_name
- The name of the cluster
$sel:nodeType:ClusterConfiguration'
, clusterConfiguration_nodeType
- The node type used for the cluster
$sel:numShards:ClusterConfiguration'
, clusterConfiguration_numShards
- The number of shards in the cluster
$sel:parameterGroupName:ClusterConfiguration'
, clusterConfiguration_parameterGroupName
- The name of parameter group used by the cluster
$sel:port:ClusterConfiguration'
, clusterConfiguration_port
- The port used by the cluster
$sel:shards:ClusterConfiguration'
, clusterConfiguration_shards
- The list of shards in the cluster
$sel:snapshotRetentionLimit:ClusterConfiguration'
, clusterConfiguration_snapshotRetentionLimit
- The snapshot retention limit set by the cluster
$sel:snapshotWindow:ClusterConfiguration'
, clusterConfiguration_snapshotWindow
- The snapshot window set by the cluster
$sel:subnetGroupName:ClusterConfiguration'
, clusterConfiguration_subnetGroupName
- The name of the subnet group used by the cluster
$sel:topicArn:ClusterConfiguration'
, clusterConfiguration_topicArn
- The Amazon Resource Name (ARN) of the SNS notification topic for the
cluster
$sel:vpcId:ClusterConfiguration'
, clusterConfiguration_vpcId
- The ID of the VPC the cluster belongs to
ClusterPendingUpdates
data ClusterPendingUpdates Source #
A list of updates being applied to the cluster
See: newClusterPendingUpdates
smart constructor.
ClusterPendingUpdates' (Maybe ACLsUpdateStatus) (Maybe ReshardingStatus) (Maybe [PendingModifiedServiceUpdate]) |
Instances
newClusterPendingUpdates :: ClusterPendingUpdates Source #
Create a value of ClusterPendingUpdates
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:aCLs:ClusterPendingUpdates'
, clusterPendingUpdates_aCLs
- A list of ACLs associated with the cluster that are being updated
$sel:resharding:ClusterPendingUpdates'
, clusterPendingUpdates_resharding
- The status of an online resharding operation.
$sel:serviceUpdates:ClusterPendingUpdates'
, clusterPendingUpdates_serviceUpdates
- A list of service updates being applied to the cluster
Endpoint
Represents the information required for client programs to connect to the cluster and its nodes.
See: newEndpoint
smart constructor.
Instances
FromJSON Endpoint Source # | |
Generic Endpoint Source # | |
Read Endpoint Source # | |
Show Endpoint Source # | |
NFData Endpoint Source # | |
Defined in Amazonka.MemoryDb.Types.Endpoint | |
Eq Endpoint Source # | |
Hashable Endpoint Source # | |
Defined in Amazonka.MemoryDb.Types.Endpoint | |
type Rep Endpoint Source # | |
Defined in Amazonka.MemoryDb.Types.Endpoint type Rep Endpoint = D1 ('MetaData "Endpoint" "Amazonka.MemoryDb.Types.Endpoint" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" '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 node.
$sel:port:Endpoint'
, endpoint_port
- The port number that the engine is listening on.
EngineVersionInfo
data EngineVersionInfo Source #
Provides details of the Redis engine version
See: newEngineVersionInfo
smart constructor.
Instances
newEngineVersionInfo :: EngineVersionInfo Source #
Create a value of EngineVersionInfo
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:enginePatchVersion:EngineVersionInfo'
, engineVersionInfo_enginePatchVersion
- The patched engine version
$sel:engineVersion:EngineVersionInfo'
, engineVersionInfo_engineVersion
- The engine version
$sel:parameterGroupFamily:EngineVersionInfo'
, engineVersionInfo_parameterGroupFamily
- Specifies the name of the parameter group family to which the engine
default parameters apply.
Event
Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.
See: newEvent
smart constructor.
Instances
FromJSON Event Source # | |
Generic Event Source # | |
Read Event Source # | |
Show Event Source # | |
NFData Event Source # | |
Defined in Amazonka.MemoryDb.Types.Event | |
Eq Event Source # | |
Hashable Event Source # | |
Defined in Amazonka.MemoryDb.Types.Event | |
type Rep Event Source # | |
Defined in Amazonka.MemoryDb.Types.Event type Rep Event = D1 ('MetaData "Event" "Amazonka.MemoryDb.Types.Event" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "date") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceType))))) |
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:date:Event'
, event_date
- The date and time when the event occurred.
$sel:message:Event'
, event_message
- The text of the event.
$sel:sourceName:Event'
, event_sourceName
- The name 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:sourceType:Event'
, event_sourceType
- Specifies the origin of this event - a cluster, a parameter group, a
security group, etc.
Filter
Used to streamline results of a search based on the property being filtered.
See: newFilter
smart constructor.
Instances
ToJSON Filter Source # | |
Defined in Amazonka.MemoryDb.Types.Filter | |
Generic Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.MemoryDb.Types.Filter | |
Eq Filter Source # | |
Hashable Filter Source # | |
Defined in Amazonka.MemoryDb.Types.Filter | |
type Rep Filter Source # | |
Defined in Amazonka.MemoryDb.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.MemoryDb.Types.Filter" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" '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, UserName.
$sel:values:Filter'
, filter_values
- The property values to filter on. For example, "user-123".
Node
Represents an individual node within a cluster. Each node runs its own instance of the cluster's protocol-compliant caching software.
See: newNode
smart constructor.
Instances
Create a value of Node
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:availabilityZone:Node'
, node_availabilityZone
- The Availability Zone in which the node resides
$sel:createTime:Node'
, node_createTime
- The date and time when the node was created.
$sel:endpoint:Node'
, node_endpoint
- The hostname for connecting to this node.
$sel:name:Node'
, node_name
- The node identifier. A node name is a numeric identifier (0001, 0002,
etc.). The combination of cluster name, shard name and node name
uniquely identifies every node used in a customer's Amazon account.
$sel:status:Node'
, node_status
- The status of the service update on the node
Parameter
Describes an individual setting that controls some aspect of MemoryDB behavior.
See: newParameter
smart constructor.
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:allowedValues:Parameter'
, parameter_allowedValues
- The valid range of values for the parameter.
$sel:dataType:Parameter'
, parameter_dataType
- The parameter's data type
$sel:description:Parameter'
, parameter_description
- A description of the parameter
$sel:minimumEngineVersion:Parameter'
, parameter_minimumEngineVersion
- The earliest engine version to which the parameter can apply.
$sel:name:Parameter'
, parameter_name
- The name of the parameter
$sel:value:Parameter'
, parameter_value
- The value of the parameter
ParameterGroup
data ParameterGroup Source #
Represents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.
See: newParameterGroup
smart constructor.
Instances
newParameterGroup :: ParameterGroup Source #
Create a value of ParameterGroup
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:ParameterGroup'
, parameterGroup_arn
- The Amazon Resource Name (ARN) of the parameter group
$sel:description:ParameterGroup'
, parameterGroup_description
- A description of the parameter group
$sel:family:ParameterGroup'
, parameterGroup_family
- The name of the parameter group family that this parameter group is
compatible with.
$sel:name:ParameterGroup'
, parameterGroup_name
- The name of the parameter group
ParameterNameValue
data ParameterNameValue Source #
Describes a name-value pair that is used to update the value of a parameter.
See: newParameterNameValue
smart constructor.
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:parameterName:ParameterNameValue'
, parameterNameValue_parameterName
- The name of the parameter
$sel:parameterValue:ParameterNameValue'
, parameterNameValue_parameterValue
- The value of the parameter
PendingModifiedServiceUpdate
data PendingModifiedServiceUpdate Source #
Update action that has yet to be processed for the corresponding apply/stop request
See: newPendingModifiedServiceUpdate
smart constructor.
Instances
newPendingModifiedServiceUpdate :: PendingModifiedServiceUpdate Source #
Create a value of PendingModifiedServiceUpdate
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:PendingModifiedServiceUpdate'
, pendingModifiedServiceUpdate_serviceUpdateName
- The unique ID of the service update
$sel:status:PendingModifiedServiceUpdate'
, pendingModifiedServiceUpdate_status
- The status of the service update
RecurringCharge
data RecurringCharge Source #
The recurring charge to run this reserved node.
See: newRecurringCharge
smart constructor.
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:recurringChargeAmount:RecurringCharge'
, recurringCharge_recurringChargeAmount
- The amount of the recurring charge to run this reserved node.
$sel:recurringChargeFrequency:RecurringCharge'
, recurringCharge_recurringChargeFrequency
- The frequency of the recurring price charged to run this reserved node.
ReplicaConfigurationRequest
data ReplicaConfigurationRequest Source #
A request to configure the number of replicas in a shard
See: newReplicaConfigurationRequest
smart constructor.
Instances
newReplicaConfigurationRequest :: ReplicaConfigurationRequest Source #
Create a value of ReplicaConfigurationRequest
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:replicaCount:ReplicaConfigurationRequest'
, replicaConfigurationRequest_replicaCount
- The number of replicas to scale up or down to
ReservedNode
data ReservedNode Source #
Represents the output of a PurchaseReservedNodesOffering
operation.
See: newReservedNode
smart constructor.
ReservedNode' (Maybe Text) (Maybe Int) (Maybe Double) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) |
Instances
newReservedNode :: ReservedNode Source #
Create a value of ReservedNode
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:ReservedNode'
, reservedNode_arn
- The Amazon Resource Name (ARN) of the reserved node.
$sel:duration:ReservedNode'
, reservedNode_duration
- The duration of the reservation in seconds.
$sel:fixedPrice:ReservedNode'
, reservedNode_fixedPrice
- The fixed price charged for this reserved node.
$sel:nodeCount:ReservedNode'
, reservedNode_nodeCount
- The number of nodes that have been reserved.
$sel:nodeType:ReservedNode'
, reservedNode_nodeType
- The node type for the reserved nodes.
$sel:offeringType:ReservedNode'
, reservedNode_offeringType
- The offering type of this reserved node.
$sel:recurringCharges:ReservedNode'
, reservedNode_recurringCharges
- The recurring price charged to run this reserved node.
$sel:reservationId:ReservedNode'
, reservedNode_reservationId
- A customer-specified identifier to track this reservation.
$sel:reservedNodesOfferingId:ReservedNode'
, reservedNode_reservedNodesOfferingId
- The ID of the reserved node offering to purchase.
$sel:startTime:ReservedNode'
, reservedNode_startTime
- The time the reservation started.
$sel:state:ReservedNode'
, reservedNode_state
- The state of the reserved node.
ReservedNodesOffering
data ReservedNodesOffering Source #
The offering type of this node.
See: newReservedNodesOffering
smart constructor.
ReservedNodesOffering' (Maybe Int) (Maybe Double) (Maybe Text) (Maybe Text) (Maybe [RecurringCharge]) (Maybe Text) |
Instances
newReservedNodesOffering :: ReservedNodesOffering Source #
Create a value of ReservedNodesOffering
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:duration:ReservedNodesOffering'
, reservedNodesOffering_duration
- The duration of the reservation in seconds.
$sel:fixedPrice:ReservedNodesOffering'
, reservedNodesOffering_fixedPrice
- The fixed price charged for this reserved node.
$sel:nodeType:ReservedNodesOffering'
, reservedNodesOffering_nodeType
- The node type for the reserved nodes. For more information, see
Supported node types.
$sel:offeringType:ReservedNodesOffering'
, reservedNodesOffering_offeringType
- The offering type of this reserved node.
$sel:recurringCharges:ReservedNodesOffering'
, reservedNodesOffering_recurringCharges
- The recurring price charged to run this reserved node.
$sel:reservedNodesOfferingId:ReservedNodesOffering'
, reservedNodesOffering_reservedNodesOfferingId
- The offering identifier.
ReshardingStatus
data ReshardingStatus Source #
The status of the online resharding
See: newReshardingStatus
smart constructor.
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
- The status of the online resharding slot migration
SecurityGroupMembership
data SecurityGroupMembership Source #
Represents a single security group and its status.
See: newSecurityGroupMembership
smart constructor.
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:securityGroupId:SecurityGroupMembership'
, securityGroupMembership_securityGroupId
- The identifier of the security group.
$sel:status:SecurityGroupMembership'
, securityGroupMembership_status
- The status of the security group membership. The status changes whenever
a security group is modified, or when the security groups assigned to a
cluster are modified.
ServiceUpdate
data ServiceUpdate Source #
An update that you can apply to your MemoryDB clusters.
See: newServiceUpdate
smart constructor.
ServiceUpdate' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe ServiceUpdateStatus) (Maybe ServiceUpdateType) |
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:autoUpdateStartDate:ServiceUpdate'
, serviceUpdate_autoUpdateStartDate
- The date at which the service update will be automatically applied
$sel:clusterName:ServiceUpdate'
, serviceUpdate_clusterName
- The name of the cluster to which the service update applies
$sel:description:ServiceUpdate'
, serviceUpdate_description
- Provides details of the service update
$sel:nodesUpdated:ServiceUpdate'
, serviceUpdate_nodesUpdated
- A list of nodes updated by the service update
$sel:releaseDate:ServiceUpdate'
, serviceUpdate_releaseDate
- The date when the service update is initially available
$sel:serviceUpdateName:ServiceUpdate'
, serviceUpdate_serviceUpdateName
- The unique ID of the service update
$sel:status:ServiceUpdate'
, serviceUpdate_status
- The status of the service update
$sel:type':ServiceUpdate'
, serviceUpdate_type
- Reflects the nature of the service update
ServiceUpdateRequest
data ServiceUpdateRequest Source #
A request to apply a service update
See: newServiceUpdateRequest
smart constructor.
Instances
newServiceUpdateRequest :: ServiceUpdateRequest Source #
Create a value of ServiceUpdateRequest
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:serviceUpdateNameToApply:ServiceUpdateRequest'
, serviceUpdateRequest_serviceUpdateNameToApply
- The unique ID of the service update
Shard
Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.
See: newShard
smart constructor.
Instances
Create a value of Shard
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:
Shard
, shard_name
- The name of the shard
$sel:nodes:Shard'
, shard_nodes
- A list containing information about individual nodes within the shard
$sel:numberOfNodes:Shard'
, shard_numberOfNodes
- The number of nodes in the shard
$sel:slots:Shard'
, shard_slots
- The keyspace for this shard.
Shard
, shard_status
- The current state of this replication group - creating, available,
modifying, deleting.
ShardConfiguration
data ShardConfiguration Source #
Shard configuration options. Each shard configuration has the following: Slots and ReplicaCount.
See: newShardConfiguration
smart constructor.
Instances
newShardConfiguration :: ShardConfiguration Source #
Create a value of ShardConfiguration
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:replicaCount:ShardConfiguration'
, shardConfiguration_replicaCount
- The number of read replica nodes in this shard.
$sel:slots:ShardConfiguration'
, shardConfiguration_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.
ShardConfigurationRequest
data ShardConfigurationRequest Source #
A request to configure the sharding properties of a cluster
See: newShardConfigurationRequest
smart constructor.
Instances
newShardConfigurationRequest :: ShardConfigurationRequest Source #
Create a value of ShardConfigurationRequest
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:shardCount:ShardConfigurationRequest'
, shardConfigurationRequest_shardCount
- The number of shards in the cluster
ShardDetail
data ShardDetail Source #
Provides details of a shard in a snapshot
See: newShardDetail
smart constructor.
ShardDetail' (Maybe ShardConfiguration) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newShardDetail :: ShardDetail Source #
Create a value of ShardDetail
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:configuration:ShardDetail'
, shardDetail_configuration
- The configuration details of the shard
$sel:name:ShardDetail'
, shardDetail_name
- The name of the shard
$sel:size:ShardDetail'
, shardDetail_size
- The size of the shard's snapshot
$sel:snapshotCreationTime:ShardDetail'
, shardDetail_snapshotCreationTime
- The date and time that the shard's snapshot was created
SlotMigration
data SlotMigration Source #
Represents the progress of an online resharding operation.
See: newSlotMigration
smart constructor.
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 cluster as of the time when the snapshot was taken.
See: newSnapshot
smart constructor.
Snapshot' (Maybe Text) (Maybe ClusterConfiguration) (Maybe DataTieringStatus) (Maybe Text) (Maybe Text) (Maybe Text) (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:arn:Snapshot'
, snapshot_arn
- The ARN (Amazon Resource Name) of the snapshot.
$sel:clusterConfiguration:Snapshot'
, snapshot_clusterConfiguration
- The configuration of the cluster from which the snapshot was taken
$sel:dataTiering:Snapshot'
, snapshot_dataTiering
- Enables data tiering. Data tiering is only supported for clusters using
the r6gd node type. This parameter must be set when using r6gd nodes.
For more information, see
Data tiering.
$sel:kmsKeyId:Snapshot'
, snapshot_kmsKeyId
- The ID of the KMS key used to encrypt the snapshot.
Snapshot
, snapshot_name
- The name of the snapshot
$sel:source:Snapshot'
, snapshot_source
- Indicates whether the snapshot is from an automatic backup (automated)
or was created manually (manual).
$sel:status:Snapshot'
, snapshot_status
- The status of the snapshot. Valid values: creating | available |
restoring | copying | deleting.
Subnet
Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.
See: newSubnet
smart constructor.
Instances
FromJSON Subnet Source # | |
Generic Subnet Source # | |
Read Subnet Source # | |
Show Subnet Source # | |
NFData Subnet Source # | |
Defined in Amazonka.MemoryDb.Types.Subnet | |
Eq Subnet Source # | |
Hashable Subnet Source # | |
Defined in Amazonka.MemoryDb.Types.Subnet | |
type Rep Subnet Source # | |
Defined in Amazonka.MemoryDb.Types.Subnet type Rep Subnet = D1 ('MetaData "Subnet" "Amazonka.MemoryDb.Types.Subnet" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "Subnet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailabilityZone)) :*: S1 ('MetaSel ('Just "identifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
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:availabilityZone:Subnet'
, subnet_availabilityZone
- The Availability Zone where the subnet resides
$sel:identifier:Subnet'
, subnet_identifier
- The unique identifier for the subnet.
SubnetGroup
data SubnetGroup Source #
Represents the output of one of the following operations:
- CreateSubnetGroup
- UpdateSubnetGroup
A subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.
See: newSubnetGroup
smart constructor.
Instances
newSubnetGroup :: SubnetGroup Source #
Create a value of SubnetGroup
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:SubnetGroup'
, subnetGroup_arn
- The ARN (Amazon Resource Name) of the subnet group.
$sel:description:SubnetGroup'
, subnetGroup_description
- A description of the subnet group
$sel:name:SubnetGroup'
, subnetGroup_name
- The name of the subnet group
$sel:subnets:SubnetGroup'
, subnetGroup_subnets
- A list of subnets associated with the subnet group.
$sel:vpcId:SubnetGroup'
, subnetGroup_vpcId
- The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet
group.
Tag
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.MemoryDb.Types.Tag | |
Generic Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.MemoryDb.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.MemoryDb.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.MemoryDb.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.MemoryDb.Types.Tag" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") '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:key:Tag'
, tag_key
- The key for the tag. May not be null.
$sel:value:Tag'
, tag_value
- The tag's value. May be null.
UnprocessedCluster
data UnprocessedCluster Source #
A cluster whose updates have failed
See: newUnprocessedCluster
smart constructor.
Instances
newUnprocessedCluster :: UnprocessedCluster Source #
Create a value of UnprocessedCluster
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:clusterName:UnprocessedCluster'
, unprocessedCluster_clusterName
- The name of the cluster
$sel:errorMessage:UnprocessedCluster'
, unprocessedCluster_errorMessage
- The error message associated with the update failure
$sel:errorType:UnprocessedCluster'
, unprocessedCluster_errorType
- The error type associated with the update failure
User
You create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.
See: newUser
smart constructor.
User' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Authentication) (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:aCLNames:User'
, user_aCLNames
- The names of the Access Control Lists to which the user belongs
$sel:arn:User'
, user_arn
- The Amazon Resource Name (ARN) of the user.
$sel:accessString:User'
, user_accessString
- Access permissions string used for this user.
$sel:authentication:User'
, user_authentication
- Denotes whether the user requires a password to authenticate.
$sel:minimumEngineVersion:User'
, user_minimumEngineVersion
- The minimum engine version supported for the user
$sel:name:User'
, user_name
- The name of the user
$sel:status:User'
, user_status
- Indicates the user status. Can be "active", "modifying" or
"deleting".