# Packages
Package elasticacheiface provides an interface to enable mocking the Amazon ElastiCache service client for testing your code.
# Functions
AuthenticationType_Values returns all elements of the AuthenticationType enum.
AuthTokenUpdateStatus_Values returns all elements of the AuthTokenUpdateStatus enum.
AuthTokenUpdateStrategyType_Values returns all elements of the AuthTokenUpdateStrategyType enum.
AutomaticFailoverStatus_Values returns all elements of the AutomaticFailoverStatus enum.
AZMode_Values returns all elements of the AZMode enum.
ChangeType_Values returns all elements of the ChangeType enum.
ClusterMode_Values returns all elements of the ClusterMode enum.
DataStorageUnit_Values returns all elements of the DataStorageUnit enum.
DataTieringStatus_Values returns all elements of the DataTieringStatus enum.
DestinationType_Values returns all elements of the DestinationType enum.
InputAuthenticationType_Values returns all elements of the InputAuthenticationType enum.
IpDiscovery_Values returns all elements of the IpDiscovery enum.
LogDeliveryConfigurationStatus_Values returns all elements of the LogDeliveryConfigurationStatus enum.
LogFormat_Values returns all elements of the LogFormat enum.
LogType_Values returns all elements of the LogType enum.
MultiAZStatus_Values returns all elements of the MultiAZStatus enum.
NetworkType_Values returns all elements of the NetworkType enum.
New creates a new instance of the ElastiCache client with a session.
NodeUpdateInitiatedBy_Values returns all elements of the NodeUpdateInitiatedBy enum.
NodeUpdateStatus_Values returns all elements of the NodeUpdateStatus enum.
OutpostMode_Values returns all elements of the OutpostMode enum.
PendingAutomaticFailoverStatus_Values returns all elements of the PendingAutomaticFailoverStatus enum.
ServiceUpdateSeverity_Values returns all elements of the ServiceUpdateSeverity enum.
ServiceUpdateStatus_Values returns all elements of the ServiceUpdateStatus enum.
ServiceUpdateType_Values returns all elements of the ServiceUpdateType enum.
SlaMet_Values returns all elements of the SlaMet enum.
SourceType_Values returns all elements of the SourceType enum.
TransitEncryptionMode_Values returns all elements of the TransitEncryptionMode enum.
UpdateActionStatus_Values returns all elements of the UpdateActionStatus enum.
# Constants
AuthenticationTypeIam is a AuthenticationType enum value.
AuthenticationTypeNoPassword is a AuthenticationType enum value.
AuthenticationTypePassword is a AuthenticationType enum value.
AuthTokenUpdateStatusRotating is a AuthTokenUpdateStatus enum value.
AuthTokenUpdateStatusSetting is a AuthTokenUpdateStatus enum value.
AuthTokenUpdateStrategyTypeDelete is a AuthTokenUpdateStrategyType enum value.
AuthTokenUpdateStrategyTypeRotate is a AuthTokenUpdateStrategyType enum value.
AuthTokenUpdateStrategyTypeSet is a AuthTokenUpdateStrategyType enum value.
AutomaticFailoverStatusDisabled is a AutomaticFailoverStatus enum value.
AutomaticFailoverStatusDisabling is a AutomaticFailoverStatus enum value.
AutomaticFailoverStatusEnabled is a AutomaticFailoverStatus enum value.
AutomaticFailoverStatusEnabling is a AutomaticFailoverStatus enum value.
AZModeCrossAz is a AZMode enum value.
AZModeSingleAz is a AZMode enum value.
ChangeTypeImmediate is a ChangeType enum value.
ChangeTypeRequiresReboot is a ChangeType enum value.
ClusterModeCompatible is a ClusterMode enum value.
ClusterModeDisabled is a ClusterMode enum value.
ClusterModeEnabled is a ClusterMode enum value.
DataStorageUnitGb is a DataStorageUnit enum value.
DataTieringStatusDisabled is a DataTieringStatus enum value.
DataTieringStatusEnabled is a DataTieringStatus enum value.
DestinationTypeCloudwatchLogs is a DestinationType enum value.
DestinationTypeKinesisFirehose is a DestinationType enum value.
ID to lookup a service endpoint with.
ErrCodeAPICallRateForCustomerExceededFault for service response error code "APICallRateForCustomerExceeded".
ErrCodeAuthorizationAlreadyExistsFault for service response error code "AuthorizationAlreadyExists".
ErrCodeAuthorizationNotFoundFault for service response error code "AuthorizationNotFound".
ErrCodeCacheClusterAlreadyExistsFault for service response error code "CacheClusterAlreadyExists".
ErrCodeCacheClusterNotFoundFault for service response error code "CacheClusterNotFound".
ErrCodeCacheParameterGroupAlreadyExistsFault for service response error code "CacheParameterGroupAlreadyExists".
ErrCodeCacheParameterGroupNotFoundFault for service response error code "CacheParameterGroupNotFound".
ErrCodeCacheParameterGroupQuotaExceededFault for service response error code "CacheParameterGroupQuotaExceeded".
ErrCodeCacheSecurityGroupAlreadyExistsFault for service response error code "CacheSecurityGroupAlreadyExists".
ErrCodeCacheSecurityGroupNotFoundFault for service response error code "CacheSecurityGroupNotFound".
ErrCodeCacheSecurityGroupQuotaExceededFault for service response error code "QuotaExceeded.CacheSecurityGroup".
ErrCodeCacheSubnetGroupAlreadyExistsFault for service response error code "CacheSubnetGroupAlreadyExists".
ErrCodeCacheSubnetGroupInUse for service response error code "CacheSubnetGroupInUse".
ErrCodeCacheSubnetGroupNotFoundFault for service response error code "CacheSubnetGroupNotFoundFault".
ErrCodeCacheSubnetGroupQuotaExceededFault for service response error code "CacheSubnetGroupQuotaExceeded".
ErrCodeCacheSubnetQuotaExceededFault for service response error code "CacheSubnetQuotaExceededFault".
ErrCodeClusterQuotaForCustomerExceededFault for service response error code "ClusterQuotaForCustomerExceeded".
ErrCodeDefaultUserAssociatedToUserGroupFault for service response error code "DefaultUserAssociatedToUserGroup".
ErrCodeDefaultUserRequired for service response error code "DefaultUserRequired".
ErrCodeDuplicateUserNameFault for service response error code "DuplicateUserName".
ErrCodeGlobalReplicationGroupAlreadyExistsFault for service response error code "GlobalReplicationGroupAlreadyExistsFault".
ErrCodeGlobalReplicationGroupNotFoundFault for service response error code "GlobalReplicationGroupNotFoundFault".
ErrCodeInsufficientCacheClusterCapacityFault for service response error code "InsufficientCacheClusterCapacity".
ErrCodeInvalidARNFault for service response error code "InvalidARN".
ErrCodeInvalidCacheClusterStateFault for service response error code "InvalidCacheClusterState".
ErrCodeInvalidCacheParameterGroupStateFault for service response error code "InvalidCacheParameterGroupState".
ErrCodeInvalidCacheSecurityGroupStateFault for service response error code "InvalidCacheSecurityGroupState".
ErrCodeInvalidCredentialsException for service response error code "InvalidCredentialsException".
ErrCodeInvalidGlobalReplicationGroupStateFault for service response error code "InvalidGlobalReplicationGroupState".
ErrCodeInvalidKMSKeyFault for service response error code "InvalidKMSKeyFault".
ErrCodeInvalidParameterCombinationException for service response error code "InvalidParameterCombination".
ErrCodeInvalidParameterValueException for service response error code "InvalidParameterValue".
ErrCodeInvalidReplicationGroupStateFault for service response error code "InvalidReplicationGroupState".
ErrCodeInvalidServerlessCacheSnapshotStateFault for service response error code "InvalidServerlessCacheSnapshotStateFault".
ErrCodeInvalidServerlessCacheStateFault for service response error code "InvalidServerlessCacheStateFault".
ErrCodeInvalidSnapshotStateFault for service response error code "InvalidSnapshotState".
ErrCodeInvalidSubnet for service response error code "InvalidSubnet".
ErrCodeInvalidUserGroupStateFault for service response error code "InvalidUserGroupState".
ErrCodeInvalidUserStateFault for service response error code "InvalidUserState".
ErrCodeInvalidVPCNetworkStateFault for service response error code "InvalidVPCNetworkStateFault".
ErrCodeNodeGroupNotFoundFault for service response error code "NodeGroupNotFoundFault".
ErrCodeNodeGroupsPerReplicationGroupQuotaExceededFault for service response error code "NodeGroupsPerReplicationGroupQuotaExceeded".
ErrCodeNodeQuotaForClusterExceededFault for service response error code "NodeQuotaForClusterExceeded".
ErrCodeNodeQuotaForCustomerExceededFault for service response error code "NodeQuotaForCustomerExceeded".
ErrCodeNoOperationFault for service response error code "NoOperationFault".
ErrCodeReplicationGroupAlreadyExistsFault for service response error code "ReplicationGroupAlreadyExists".
ErrCodeReplicationGroupAlreadyUnderMigrationFault for service response error code "ReplicationGroupAlreadyUnderMigrationFault".
ErrCodeReplicationGroupNotFoundFault for service response error code "ReplicationGroupNotFoundFault".
ErrCodeReplicationGroupNotUnderMigrationFault for service response error code "ReplicationGroupNotUnderMigrationFault".
ErrCodeReservedCacheNodeAlreadyExistsFault for service response error code "ReservedCacheNodeAlreadyExists".
ErrCodeReservedCacheNodeNotFoundFault for service response error code "ReservedCacheNodeNotFound".
ErrCodeReservedCacheNodeQuotaExceededFault for service response error code "ReservedCacheNodeQuotaExceeded".
ErrCodeReservedCacheNodesOfferingNotFoundFault for service response error code "ReservedCacheNodesOfferingNotFound".
ErrCodeServerlessCacheAlreadyExistsFault for service response error code "ServerlessCacheAlreadyExistsFault".
ErrCodeServerlessCacheNotFoundFault for service response error code "ServerlessCacheNotFoundFault".
ErrCodeServerlessCacheQuotaForCustomerExceededFault for service response error code "ServerlessCacheQuotaForCustomerExceededFault".
ErrCodeServerlessCacheSnapshotAlreadyExistsFault for service response error code "ServerlessCacheSnapshotAlreadyExistsFault".
ErrCodeServerlessCacheSnapshotNotFoundFault for service response error code "ServerlessCacheSnapshotNotFoundFault".
ErrCodeServerlessCacheSnapshotQuotaExceededFault for service response error code "ServerlessCacheSnapshotQuotaExceededFault".
ErrCodeServiceLinkedRoleNotFoundFault for service response error code "ServiceLinkedRoleNotFoundFault".
ErrCodeServiceUpdateNotFoundFault for service response error code "ServiceUpdateNotFoundFault".
ErrCodeSnapshotAlreadyExistsFault for service response error code "SnapshotAlreadyExistsFault".
ErrCodeSnapshotFeatureNotSupportedFault for service response error code "SnapshotFeatureNotSupportedFault".
ErrCodeSnapshotNotFoundFault for service response error code "SnapshotNotFoundFault".
ErrCodeSnapshotQuotaExceededFault for service response error code "SnapshotQuotaExceededFault".
ErrCodeSubnetInUse for service response error code "SubnetInUse".
ErrCodeSubnetNotAllowedFault for service response error code "SubnetNotAllowedFault".
ErrCodeTagNotFoundFault for service response error code "TagNotFound".
ErrCodeTagQuotaPerResourceExceeded for service response error code "TagQuotaPerResourceExceeded".
ErrCodeTestFailoverNotAvailableFault for service response error code "TestFailoverNotAvailableFault".
ErrCodeUserAlreadyExistsFault for service response error code "UserAlreadyExists".
ErrCodeUserGroupAlreadyExistsFault for service response error code "UserGroupAlreadyExists".
ErrCodeUserGroupNotFoundFault for service response error code "UserGroupNotFound".
ErrCodeUserGroupQuotaExceededFault for service response error code "UserGroupQuotaExceeded".
ErrCodeUserNotFoundFault for service response error code "UserNotFound".
ErrCodeUserQuotaExceededFault for service response error code "UserQuotaExceeded".
InputAuthenticationTypeIam is a InputAuthenticationType enum value.
InputAuthenticationTypeNoPasswordRequired is a InputAuthenticationType enum value.
InputAuthenticationTypePassword is a InputAuthenticationType enum value.
IpDiscoveryIpv4 is a IpDiscovery enum value.
IpDiscoveryIpv6 is a IpDiscovery enum value.
LogDeliveryConfigurationStatusActive is a LogDeliveryConfigurationStatus enum value.
LogDeliveryConfigurationStatusDisabling is a LogDeliveryConfigurationStatus enum value.
LogDeliveryConfigurationStatusEnabling is a LogDeliveryConfigurationStatus enum value.
LogDeliveryConfigurationStatusError is a LogDeliveryConfigurationStatus enum value.
LogDeliveryConfigurationStatusModifying is a LogDeliveryConfigurationStatus enum value.
LogFormatJson is a LogFormat enum value.
LogFormatText is a LogFormat enum value.
LogTypeEngineLog is a LogType enum value.
LogTypeSlowLog is a LogType enum value.
MultiAZStatusDisabled is a MultiAZStatus enum value.
MultiAZStatusEnabled is a MultiAZStatus enum value.
NetworkTypeDualStack is a NetworkType enum value.
NetworkTypeIpv4 is a NetworkType enum value.
NetworkTypeIpv6 is a NetworkType enum value.
NodeUpdateInitiatedByCustomer is a NodeUpdateInitiatedBy enum value.
NodeUpdateInitiatedBySystem is a NodeUpdateInitiatedBy enum value.
NodeUpdateStatusComplete is a NodeUpdateStatus enum value.
NodeUpdateStatusInProgress is a NodeUpdateStatus enum value.
NodeUpdateStatusNotApplied is a NodeUpdateStatus enum value.
NodeUpdateStatusStopped is a NodeUpdateStatus enum value.
NodeUpdateStatusStopping is a NodeUpdateStatus enum value.
NodeUpdateStatusWaitingToStart is a NodeUpdateStatus enum value.
OutpostModeCrossOutpost is a OutpostMode enum value.
OutpostModeSingleOutpost is a OutpostMode enum value.
PendingAutomaticFailoverStatusDisabled is a PendingAutomaticFailoverStatus enum value.
PendingAutomaticFailoverStatusEnabled is a PendingAutomaticFailoverStatus enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
ServiceUpdateSeverityCritical is a ServiceUpdateSeverity enum value.
ServiceUpdateSeverityImportant is a ServiceUpdateSeverity enum value.
ServiceUpdateSeverityLow is a ServiceUpdateSeverity enum value.
ServiceUpdateSeverityMedium is a ServiceUpdateSeverity enum value.
ServiceUpdateStatusAvailable is a ServiceUpdateStatus enum value.
ServiceUpdateStatusCancelled is a ServiceUpdateStatus enum value.
ServiceUpdateStatusExpired is a ServiceUpdateStatus enum value.
ServiceUpdateTypeSecurityUpdate is a ServiceUpdateType enum value.
SlaMetNA is a SlaMet enum value.
SlaMetNo is a SlaMet enum value.
SlaMetYes is a SlaMet enum value.
SourceTypeCacheCluster is a SourceType enum value.
SourceTypeCacheParameterGroup is a SourceType enum value.
SourceTypeCacheSecurityGroup is a SourceType enum value.
SourceTypeCacheSubnetGroup is a SourceType enum value.
SourceTypeReplicationGroup is a SourceType enum value.
SourceTypeServerlessCache is a SourceType enum value.
SourceTypeServerlessCacheSnapshot is a SourceType enum value.
SourceTypeUser is a SourceType enum value.
SourceTypeUserGroup is a SourceType enum value.
TransitEncryptionModePreferred is a TransitEncryptionMode enum value.
TransitEncryptionModeRequired is a TransitEncryptionMode enum value.
UpdateActionStatusComplete is a UpdateActionStatus enum value.
UpdateActionStatusInProgress is a UpdateActionStatus enum value.
UpdateActionStatusNotApplicable is a UpdateActionStatus enum value.
UpdateActionStatusNotApplied is a UpdateActionStatus enum value.
UpdateActionStatusScheduled is a UpdateActionStatus enum value.
UpdateActionStatusScheduling is a UpdateActionStatus enum value.
UpdateActionStatusStopped is a UpdateActionStatus enum value.
UpdateActionStatusStopping is a UpdateActionStatus enum value.
UpdateActionStatusWaitingToStart is a UpdateActionStatus enum value.
# Structs
Represents the input of an AddTagsToResource operation.
Indicates whether the user requires a password to authenticate.
Specifies the authentication mode to use.
Represents the input of an AuthorizeCacheSecurityGroupIngress operation.
Describes an Availability Zone in which the cluster is launched.
Contains all of the attributes of a specific cluster.
Provides all of the details about a particular cache engine version.
Represents an individual cache node within a cluster.
A parameter that has a different value for each cache node type it is applied to.
A value that applies only to a certain cache node type.
The status of the service update on the cache node.
Represents the output of a CreateCacheParameterGroup operation.
Represents the output of one of the following operations:
- ModifyCacheParameterGroup
- ResetCacheParameterGroup.
Status of the cache parameter group.
Represents the output of one of the following operations:
- AuthorizeCacheSecurityGroupIngress
- CreateCacheSecurityGroup
- RevokeCacheSecurityGroupIngress.
Represents a cluster's status within a particular cache security group.
Represents the output of one of the following operations:
- CreateCacheSubnetGroup
- ModifyCacheSubnetGroup.
The usage limits for storage and ElastiCache Processing Units for the cache.
The configuration details of the CloudWatch Logs destination.
Node group (shard) configuration options when adding or removing replicas.
Represents the input of a CopySnapshotMessage operation.
Represents the input of a CreateCacheCluster operation.
Represents the input of a CreateCacheParameterGroup operation.
Represents the input of a CreateCacheSecurityGroup operation.
Represents the input of a CreateCacheSubnetGroup operation.
Represents the input of a CreateReplicationGroup operation.
Represents the input of a CreateSnapshot operation.
The endpoint from which data should be migrated.
The data storage limit.
Represents the input of a DeleteCacheCluster operation.
Represents the input of a DeleteCacheParameterGroup operation.
Represents the input of a DeleteCacheSecurityGroup operation.
Represents the input of a DeleteCacheSubnetGroup operation.
Represents the input of a DeleteReplicationGroup operation.
Represents the input of a DeleteSnapshot operation.
Represents the input of a DescribeCacheClusters operation.
Represents the output of a DescribeCacheClusters operation.
Represents the input of a DescribeCacheEngineVersions operation.
Represents the output of a DescribeCacheEngineVersions operation.
Represents the input of a DescribeCacheParameterGroups operation.
Represents the output of a DescribeCacheParameterGroups operation.
Represents the input of a DescribeCacheParameters operation.
Represents the output of a DescribeCacheParameters operation.
Represents the input of a DescribeCacheSecurityGroups operation.
Represents the output of a DescribeCacheSecurityGroups operation.
Represents the input of a DescribeCacheSubnetGroups operation.
Represents the output of a DescribeCacheSubnetGroups operation.
Represents the input of a DescribeEngineDefaultParameters operation.
Represents the input of a DescribeEvents operation.
Represents the output of a DescribeEvents operation.
Represents the input of a DescribeReplicationGroups operation.
Represents the output of a DescribeReplicationGroups operation.
Represents the input of a DescribeReservedCacheNodes operation.
Represents the input of a DescribeReservedCacheNodesOfferings operation.
Represents the output of a DescribeReservedCacheNodesOfferings operation.
Represents the output of a DescribeReservedCacheNodes operation.
Represents the input of a DescribeSnapshotsMessage operation.
Represents the output of a DescribeSnapshots operation.
Configuration details of either a CloudWatch Logs destination or Kinesis Data Firehose destination.
Provides ownership and status information for an Amazon EC2 security group.
The configuration for the number of ElastiCache Processing Units (ECPU) the cache can consume per second.
ElastiCache provides the API operation methods for making requests to Amazon ElastiCache.
Represents the information required for client programs to connect to a cache node.
Represents the output of a DescribeEngineDefaultParameters operation.
Represents a single occurrence of something interesting within the system.
Used to streamline results of a search based on the property being filtered.
Indicates the slot configuration and global identifier for a slice group.
Consists of a primary cluster that accepts writes and an associated secondary cluster that resides in a different Amazon region.
The name of the Global datastore and role of this replication group in the Global datastore.
A member of a Global datastore.
The configuration details of the Kinesis Data Firehose destination.
The input parameters for the ListAllowedNodeTypeModifications operation.
Represents the allowed node types you can use to modify your cluster or replication group.
The input parameters for the ListTagsForResource operation.
Returns the destination, format and type of the logs.
Specifies the destination, format and type of the logs.
Represents the input of a ModifyCacheCluster operation.
Represents the input of a ModifyCacheParameterGroup operation.
Represents the input of a ModifyCacheSubnetGroup operation.
Represents the input of a ModifyReplicationGroups operation.
Represents the input for a ModifyReplicationGroupShardConfiguration operation.
Represents a collection of cache nodes in a replication group.
Node group (shard) configuration options.
Represents a single node within a node group (shard).
The status of the service update on the node group member.
The status of the service update on the node group.
Represents an individual cache node in a snapshot of a cluster.
Describes a notification topic and its status.
Describes an individual setting that controls some aspect of ElastiCache behavior.
Describes a name-value pair that is used to update the value of a parameter.
The log delivery configurations being modified.
A group of settings that are applied to the cluster in the future, or that are currently being applied.
Update action that has been processed for the corresponding apply/stop request.
Represents the input of a PurchaseReservedCacheNodesOffering operation.
Represents the input of a RebootCacheCluster operation.
Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.
A list of the replication groups.
Represents the input of a RemoveTagsFromResource operation.
Contains all of the attributes of a specific Redis OSS replication group.
The settings to be applied to the Redis OSS replication group, either immediately or during the next maintenance window.
Represents the output of a PurchaseReservedCacheNodesOffering operation.
Describes all of the attributes of a reserved cache node offering.
Represents the input of a ResetCacheParameterGroup operation.
A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.
The status of an online resharding operation.
Represents the input of a RevokeCacheSecurityGroupIngress operation.
Represents a single cache security group and its status.
The resource representing a serverless cache.
The configuration settings for a specific serverless cache.
The resource representing a serverless cache snapshot.
An update that you can apply to your Redis OSS clusters.
Represents the progress of an online resharding operation.
Represents a copy of an entire Redis OSS cluster as of the time when the snapshot was taken.
Represents the subnet associated with a cluster.
The ID of the outpost subnet.
A tag that can be added to an ElastiCache cluster or replication group.
Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.
Filters update actions from the service updates that are in available status during the time range.
Update action that has failed to be processed for the corresponding apply/stop request.
The status of the service update for a specific replication group.
Returns the updates being applied to the user group.
The status of the user group update.