Skip to content

Type definitions#

Index > ElastiCache > Type definitions

Auto-generated documentation for ElastiCache type annotations stubs module mypy-boto3-elasticache.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AuthenticationModeTypeDef#

# AuthenticationModeTypeDef definition

class AuthenticationModeTypeDef(TypedDict):
    Type: NotRequired[InputAuthenticationTypeType],  # (1)
    Passwords: NotRequired[Sequence[str]],
  1. See InputAuthenticationTypeType

AuthenticationTypeDef#

# AuthenticationTypeDef definition

class AuthenticationTypeDef(TypedDict):
    Type: NotRequired[AuthenticationTypeType],  # (1)
    PasswordCount: NotRequired[int],
  1. See AuthenticationTypeType

AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef#

# AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef definition

class AuthorizeCacheSecurityGroupIngressMessageRequestTypeDef(TypedDict):
    CacheSecurityGroupName: str,
    EC2SecurityGroupName: str,
    EC2SecurityGroupOwnerId: str,

AvailabilityZoneTypeDef#

# AvailabilityZoneTypeDef definition

class AvailabilityZoneTypeDef(TypedDict):
    Name: NotRequired[str],

BatchApplyUpdateActionMessageRequestTypeDef#

# BatchApplyUpdateActionMessageRequestTypeDef definition

class BatchApplyUpdateActionMessageRequestTypeDef(TypedDict):
    ServiceUpdateName: str,
    ReplicationGroupIds: NotRequired[Sequence[str]],
    CacheClusterIds: NotRequired[Sequence[str]],

BatchStopUpdateActionMessageRequestTypeDef#

# BatchStopUpdateActionMessageRequestTypeDef definition

class BatchStopUpdateActionMessageRequestTypeDef(TypedDict):
    ServiceUpdateName: str,
    ReplicationGroupIds: NotRequired[Sequence[str]],
    CacheClusterIds: NotRequired[Sequence[str]],

CacheParameterGroupStatusTypeDef#

# CacheParameterGroupStatusTypeDef definition

class CacheParameterGroupStatusTypeDef(TypedDict):
    CacheParameterGroupName: NotRequired[str],
    ParameterApplyStatus: NotRequired[str],
    CacheNodeIdsToReboot: NotRequired[List[str]],

CacheSecurityGroupMembershipTypeDef#

# CacheSecurityGroupMembershipTypeDef definition

class CacheSecurityGroupMembershipTypeDef(TypedDict):
    CacheSecurityGroupName: NotRequired[str],
    Status: NotRequired[str],

EndpointTypeDef#

# EndpointTypeDef definition

class EndpointTypeDef(TypedDict):
    Address: NotRequired[str],
    Port: NotRequired[int],

NotificationConfigurationTypeDef#

# NotificationConfigurationTypeDef definition

class NotificationConfigurationTypeDef(TypedDict):
    TopicArn: NotRequired[str],
    TopicStatus: NotRequired[str],

SecurityGroupMembershipTypeDef#

# SecurityGroupMembershipTypeDef definition

class SecurityGroupMembershipTypeDef(TypedDict):
    SecurityGroupId: NotRequired[str],
    Status: NotRequired[str],

CacheEngineVersionTypeDef#

# CacheEngineVersionTypeDef definition

class CacheEngineVersionTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    CacheParameterGroupFamily: NotRequired[str],
    CacheEngineDescription: NotRequired[str],
    CacheEngineVersionDescription: NotRequired[str],

CacheNodeTypeSpecificValueTypeDef#

# CacheNodeTypeSpecificValueTypeDef definition

class CacheNodeTypeSpecificValueTypeDef(TypedDict):
    CacheNodeType: NotRequired[str],
    Value: NotRequired[str],

CacheNodeUpdateStatusTypeDef#

# CacheNodeUpdateStatusTypeDef definition

class CacheNodeUpdateStatusTypeDef(TypedDict):
    CacheNodeId: NotRequired[str],
    NodeUpdateStatus: NotRequired[NodeUpdateStatusType],  # (1)
    NodeDeletionDate: NotRequired[datetime],
    NodeUpdateStartDate: NotRequired[datetime],
    NodeUpdateEndDate: NotRequired[datetime],
    NodeUpdateInitiatedBy: NotRequired[NodeUpdateInitiatedByType],  # (2)
    NodeUpdateInitiatedDate: NotRequired[datetime],
    NodeUpdateStatusModifiedDate: NotRequired[datetime],
  1. See NodeUpdateStatusType
  2. See NodeUpdateInitiatedByType

ParameterTypeDef#

# ParameterTypeDef definition

class ParameterTypeDef(TypedDict):
    ParameterName: NotRequired[str],
    ParameterValue: NotRequired[str],
    Description: NotRequired[str],
    Source: NotRequired[str],
    DataType: NotRequired[str],
    AllowedValues: NotRequired[str],
    IsModifiable: NotRequired[bool],
    MinimumEngineVersion: NotRequired[str],
    ChangeType: NotRequired[ChangeTypeType],  # (1)
  1. See ChangeTypeType

CacheParameterGroupTypeDef#

# CacheParameterGroupTypeDef definition

class CacheParameterGroupTypeDef(TypedDict):
    CacheParameterGroupName: NotRequired[str],
    CacheParameterGroupFamily: NotRequired[str],
    Description: NotRequired[str],
    IsGlobal: NotRequired[bool],
    ARN: NotRequired[str],

EC2SecurityGroupTypeDef#

# EC2SecurityGroupTypeDef definition

class EC2SecurityGroupTypeDef(TypedDict):
    Status: NotRequired[str],
    EC2SecurityGroupName: NotRequired[str],
    EC2SecurityGroupOwnerId: NotRequired[str],

DataStorageTypeDef#

# DataStorageTypeDef definition

class DataStorageTypeDef(TypedDict):
    Maximum: int,
    Unit: DataStorageUnitType,  # (1)
  1. See DataStorageUnitType

ECPUPerSecondTypeDef#

# ECPUPerSecondTypeDef definition

class ECPUPerSecondTypeDef(TypedDict):
    Maximum: int,

CloudWatchLogsDestinationDetailsTypeDef#

# CloudWatchLogsDestinationDetailsTypeDef definition

class CloudWatchLogsDestinationDetailsTypeDef(TypedDict):
    LogGroup: NotRequired[str],

CompleteMigrationMessageRequestTypeDef#

# CompleteMigrationMessageRequestTypeDef definition

class CompleteMigrationMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    Force: NotRequired[bool],

ConfigureShardTypeDef#

# ConfigureShardTypeDef definition

class ConfigureShardTypeDef(TypedDict):
    NodeGroupId: str,
    NewReplicaCount: int,
    PreferredAvailabilityZones: NotRequired[Sequence[str]],
    PreferredOutpostArns: NotRequired[Sequence[str]],

CreateGlobalReplicationGroupMessageRequestTypeDef#

# CreateGlobalReplicationGroupMessageRequestTypeDef definition

class CreateGlobalReplicationGroupMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupIdSuffix: str,
    PrimaryReplicationGroupId: str,
    GlobalReplicationGroupDescription: NotRequired[str],

NodeGroupConfigurationTypeDef#

# NodeGroupConfigurationTypeDef definition

class NodeGroupConfigurationTypeDef(TypedDict):
    NodeGroupId: NotRequired[str],
    Slots: NotRequired[str],
    ReplicaCount: NotRequired[int],
    PrimaryAvailabilityZone: NotRequired[str],
    ReplicaAvailabilityZones: NotRequired[List[str]],
    PrimaryOutpostArn: NotRequired[str],
    ReplicaOutpostArns: NotRequired[List[str]],

CustomerNodeEndpointTypeDef#

# CustomerNodeEndpointTypeDef definition

class CustomerNodeEndpointTypeDef(TypedDict):
    Address: NotRequired[str],
    Port: NotRequired[int],

DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef#

# DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef definition

class DecreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupId: str,
    NodeGroupCount: int,
    ApplyImmediately: bool,
    GlobalNodeGroupsToRemove: NotRequired[Sequence[str]],
    GlobalNodeGroupsToRetain: NotRequired[Sequence[str]],

DeleteCacheClusterMessageRequestTypeDef#

# DeleteCacheClusterMessageRequestTypeDef definition

class DeleteCacheClusterMessageRequestTypeDef(TypedDict):
    CacheClusterId: str,
    FinalSnapshotIdentifier: NotRequired[str],

DeleteCacheParameterGroupMessageRequestTypeDef#

# DeleteCacheParameterGroupMessageRequestTypeDef definition

class DeleteCacheParameterGroupMessageRequestTypeDef(TypedDict):
    CacheParameterGroupName: str,

DeleteCacheSecurityGroupMessageRequestTypeDef#

# DeleteCacheSecurityGroupMessageRequestTypeDef definition

class DeleteCacheSecurityGroupMessageRequestTypeDef(TypedDict):
    CacheSecurityGroupName: str,

DeleteCacheSubnetGroupMessageRequestTypeDef#

# DeleteCacheSubnetGroupMessageRequestTypeDef definition

class DeleteCacheSubnetGroupMessageRequestTypeDef(TypedDict):
    CacheSubnetGroupName: str,

DeleteGlobalReplicationGroupMessageRequestTypeDef#

# DeleteGlobalReplicationGroupMessageRequestTypeDef definition

class DeleteGlobalReplicationGroupMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupId: str,
    RetainPrimaryReplicationGroup: bool,

DeleteReplicationGroupMessageRequestTypeDef#

# DeleteReplicationGroupMessageRequestTypeDef definition

class DeleteReplicationGroupMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    RetainPrimaryCluster: NotRequired[bool],
    FinalSnapshotIdentifier: NotRequired[str],

DeleteServerlessCacheRequestRequestTypeDef#

# DeleteServerlessCacheRequestRequestTypeDef definition

class DeleteServerlessCacheRequestRequestTypeDef(TypedDict):
    ServerlessCacheName: str,
    FinalSnapshotName: NotRequired[str],

DeleteServerlessCacheSnapshotRequestRequestTypeDef#

# DeleteServerlessCacheSnapshotRequestRequestTypeDef definition

class DeleteServerlessCacheSnapshotRequestRequestTypeDef(TypedDict):
    ServerlessCacheSnapshotName: str,

DeleteSnapshotMessageRequestTypeDef#

# DeleteSnapshotMessageRequestTypeDef definition

class DeleteSnapshotMessageRequestTypeDef(TypedDict):
    SnapshotName: str,

DeleteUserGroupMessageRequestTypeDef#

# DeleteUserGroupMessageRequestTypeDef definition

class DeleteUserGroupMessageRequestTypeDef(TypedDict):
    UserGroupId: str,

DeleteUserMessageRequestTypeDef#

# DeleteUserMessageRequestTypeDef definition

class DeleteUserMessageRequestTypeDef(TypedDict):
    UserId: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeCacheClustersMessageRequestTypeDef#

# DescribeCacheClustersMessageRequestTypeDef definition

class DescribeCacheClustersMessageRequestTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    ShowCacheNodeInfo: NotRequired[bool],
    ShowCacheClustersNotInReplicationGroups: NotRequired[bool],

DescribeCacheEngineVersionsMessageRequestTypeDef#

# DescribeCacheEngineVersionsMessageRequestTypeDef definition

class DescribeCacheEngineVersionsMessageRequestTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    CacheParameterGroupFamily: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    DefaultOnly: NotRequired[bool],

DescribeCacheParameterGroupsMessageRequestTypeDef#

# DescribeCacheParameterGroupsMessageRequestTypeDef definition

class DescribeCacheParameterGroupsMessageRequestTypeDef(TypedDict):
    CacheParameterGroupName: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

DescribeCacheParametersMessageRequestTypeDef#

# DescribeCacheParametersMessageRequestTypeDef definition

class DescribeCacheParametersMessageRequestTypeDef(TypedDict):
    CacheParameterGroupName: str,
    Source: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

DescribeCacheSecurityGroupsMessageRequestTypeDef#

# DescribeCacheSecurityGroupsMessageRequestTypeDef definition

class DescribeCacheSecurityGroupsMessageRequestTypeDef(TypedDict):
    CacheSecurityGroupName: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

DescribeCacheSubnetGroupsMessageRequestTypeDef#

# DescribeCacheSubnetGroupsMessageRequestTypeDef definition

class DescribeCacheSubnetGroupsMessageRequestTypeDef(TypedDict):
    CacheSubnetGroupName: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

DescribeEngineDefaultParametersMessageRequestTypeDef#

# DescribeEngineDefaultParametersMessageRequestTypeDef definition

class DescribeEngineDefaultParametersMessageRequestTypeDef(TypedDict):
    CacheParameterGroupFamily: str,
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

DescribeGlobalReplicationGroupsMessageRequestTypeDef#

# DescribeGlobalReplicationGroupsMessageRequestTypeDef definition

class DescribeGlobalReplicationGroupsMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupId: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    ShowMemberInfo: NotRequired[bool],

DescribeReplicationGroupsMessageRequestTypeDef#

# DescribeReplicationGroupsMessageRequestTypeDef definition

class DescribeReplicationGroupsMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

DescribeReservedCacheNodesMessageRequestTypeDef#

# DescribeReservedCacheNodesMessageRequestTypeDef definition

class DescribeReservedCacheNodesMessageRequestTypeDef(TypedDict):
    ReservedCacheNodeId: NotRequired[str],
    ReservedCacheNodesOfferingId: NotRequired[str],
    CacheNodeType: NotRequired[str],
    Duration: NotRequired[str],
    ProductDescription: NotRequired[str],
    OfferingType: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

DescribeReservedCacheNodesOfferingsMessageRequestTypeDef#

# DescribeReservedCacheNodesOfferingsMessageRequestTypeDef definition

class DescribeReservedCacheNodesOfferingsMessageRequestTypeDef(TypedDict):
    ReservedCacheNodesOfferingId: NotRequired[str],
    CacheNodeType: NotRequired[str],
    Duration: NotRequired[str],
    ProductDescription: NotRequired[str],
    OfferingType: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

DescribeServerlessCacheSnapshotsRequestRequestTypeDef#

# DescribeServerlessCacheSnapshotsRequestRequestTypeDef definition

class DescribeServerlessCacheSnapshotsRequestRequestTypeDef(TypedDict):
    ServerlessCacheName: NotRequired[str],
    ServerlessCacheSnapshotName: NotRequired[str],
    SnapshotType: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

DescribeServerlessCachesRequestRequestTypeDef#

# DescribeServerlessCachesRequestRequestTypeDef definition

class DescribeServerlessCachesRequestRequestTypeDef(TypedDict):
    ServerlessCacheName: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeServiceUpdatesMessageRequestTypeDef#

# DescribeServiceUpdatesMessageRequestTypeDef definition

class DescribeServiceUpdatesMessageRequestTypeDef(TypedDict):
    ServiceUpdateName: NotRequired[str],
    ServiceUpdateStatus: NotRequired[Sequence[ServiceUpdateStatusType]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See ServiceUpdateStatusType

DescribeSnapshotsMessageRequestTypeDef#

# DescribeSnapshotsMessageRequestTypeDef definition

class DescribeSnapshotsMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    CacheClusterId: NotRequired[str],
    SnapshotName: NotRequired[str],
    SnapshotSource: NotRequired[str],
    Marker: NotRequired[str],
    MaxRecords: NotRequired[int],
    ShowNodeGroupConfig: NotRequired[bool],

DescribeUserGroupsMessageRequestTypeDef#

# DescribeUserGroupsMessageRequestTypeDef definition

class DescribeUserGroupsMessageRequestTypeDef(TypedDict):
    UserGroupId: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    Name: str,
    Values: Sequence[str],

KinesisFirehoseDestinationDetailsTypeDef#

# KinesisFirehoseDestinationDetailsTypeDef definition

class KinesisFirehoseDestinationDetailsTypeDef(TypedDict):
    DeliveryStream: NotRequired[str],

DisassociateGlobalReplicationGroupMessageRequestTypeDef#

# DisassociateGlobalReplicationGroupMessageRequestTypeDef definition

class DisassociateGlobalReplicationGroupMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupId: str,
    ReplicationGroupId: str,
    ReplicationGroupRegion: str,

EventTypeDef#

# EventTypeDef definition

class EventTypeDef(TypedDict):
    SourceIdentifier: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    Message: NotRequired[str],
    Date: NotRequired[datetime],
  1. See SourceTypeType

ExportServerlessCacheSnapshotRequestRequestTypeDef#

# ExportServerlessCacheSnapshotRequestRequestTypeDef definition

class ExportServerlessCacheSnapshotRequestRequestTypeDef(TypedDict):
    ServerlessCacheSnapshotName: str,
    S3BucketName: str,

FailoverGlobalReplicationGroupMessageRequestTypeDef#

# FailoverGlobalReplicationGroupMessageRequestTypeDef definition

class FailoverGlobalReplicationGroupMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupId: str,
    PrimaryRegion: str,
    PrimaryReplicationGroupId: str,

GlobalNodeGroupTypeDef#

# GlobalNodeGroupTypeDef definition

class GlobalNodeGroupTypeDef(TypedDict):
    GlobalNodeGroupId: NotRequired[str],
    Slots: NotRequired[str],

GlobalReplicationGroupInfoTypeDef#

# GlobalReplicationGroupInfoTypeDef definition

class GlobalReplicationGroupInfoTypeDef(TypedDict):
    GlobalReplicationGroupId: NotRequired[str],
    GlobalReplicationGroupMemberRole: NotRequired[str],

GlobalReplicationGroupMemberTypeDef#

# GlobalReplicationGroupMemberTypeDef definition

class GlobalReplicationGroupMemberTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    ReplicationGroupRegion: NotRequired[str],
    Role: NotRequired[str],
    AutomaticFailover: NotRequired[AutomaticFailoverStatusType],  # (1)
    Status: NotRequired[str],
  1. See AutomaticFailoverStatusType

ListAllowedNodeTypeModificationsMessageRequestTypeDef#

# ListAllowedNodeTypeModificationsMessageRequestTypeDef definition

class ListAllowedNodeTypeModificationsMessageRequestTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    ReplicationGroupId: NotRequired[str],

ListTagsForResourceMessageRequestTypeDef#

# ListTagsForResourceMessageRequestTypeDef definition

class ListTagsForResourceMessageRequestTypeDef(TypedDict):
    ResourceName: str,

ParameterNameValueTypeDef#

# ParameterNameValueTypeDef definition

class ParameterNameValueTypeDef(TypedDict):
    ParameterName: NotRequired[str],
    ParameterValue: NotRequired[str],

ModifyCacheSubnetGroupMessageRequestTypeDef#

# ModifyCacheSubnetGroupMessageRequestTypeDef definition

class ModifyCacheSubnetGroupMessageRequestTypeDef(TypedDict):
    CacheSubnetGroupName: str,
    CacheSubnetGroupDescription: NotRequired[str],
    SubnetIds: NotRequired[Sequence[str]],

ModifyGlobalReplicationGroupMessageRequestTypeDef#

# ModifyGlobalReplicationGroupMessageRequestTypeDef definition

class ModifyGlobalReplicationGroupMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupId: str,
    ApplyImmediately: bool,
    CacheNodeType: NotRequired[str],
    EngineVersion: NotRequired[str],
    CacheParameterGroupName: NotRequired[str],
    GlobalReplicationGroupDescription: NotRequired[str],
    AutomaticFailoverEnabled: NotRequired[bool],

ReshardingConfigurationTypeDef#

# ReshardingConfigurationTypeDef definition

class ReshardingConfigurationTypeDef(TypedDict):
    NodeGroupId: NotRequired[str],
    PreferredAvailabilityZones: NotRequired[Sequence[str]],

ModifyUserGroupMessageRequestTypeDef#

# ModifyUserGroupMessageRequestTypeDef definition

class ModifyUserGroupMessageRequestTypeDef(TypedDict):
    UserGroupId: str,
    UserIdsToAdd: NotRequired[Sequence[str]],
    UserIdsToRemove: NotRequired[Sequence[str]],

NodeGroupMemberUpdateStatusTypeDef#

# NodeGroupMemberUpdateStatusTypeDef definition

class NodeGroupMemberUpdateStatusTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    CacheNodeId: NotRequired[str],
    NodeUpdateStatus: NotRequired[NodeUpdateStatusType],  # (1)
    NodeDeletionDate: NotRequired[datetime],
    NodeUpdateStartDate: NotRequired[datetime],
    NodeUpdateEndDate: NotRequired[datetime],
    NodeUpdateInitiatedBy: NotRequired[NodeUpdateInitiatedByType],  # (2)
    NodeUpdateInitiatedDate: NotRequired[datetime],
    NodeUpdateStatusModifiedDate: NotRequired[datetime],
  1. See NodeUpdateStatusType
  2. See NodeUpdateInitiatedByType

ProcessedUpdateActionTypeDef#

# ProcessedUpdateActionTypeDef definition

class ProcessedUpdateActionTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    CacheClusterId: NotRequired[str],
    ServiceUpdateName: NotRequired[str],
    UpdateActionStatus: NotRequired[UpdateActionStatusType],  # (1)
  1. See UpdateActionStatusType

RebalanceSlotsInGlobalReplicationGroupMessageRequestTypeDef#

# RebalanceSlotsInGlobalReplicationGroupMessageRequestTypeDef definition

class RebalanceSlotsInGlobalReplicationGroupMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupId: str,
    ApplyImmediately: bool,

RebootCacheClusterMessageRequestTypeDef#

# RebootCacheClusterMessageRequestTypeDef definition

class RebootCacheClusterMessageRequestTypeDef(TypedDict):
    CacheClusterId: str,
    CacheNodeIdsToReboot: Sequence[str],

RecurringChargeTypeDef#

# RecurringChargeTypeDef definition

class RecurringChargeTypeDef(TypedDict):
    RecurringChargeAmount: NotRequired[float],
    RecurringChargeFrequency: NotRequired[str],

RemoveTagsFromResourceMessageRequestTypeDef#

# RemoveTagsFromResourceMessageRequestTypeDef definition

class RemoveTagsFromResourceMessageRequestTypeDef(TypedDict):
    ResourceName: str,
    TagKeys: Sequence[str],

UserGroupsUpdateStatusTypeDef#

# UserGroupsUpdateStatusTypeDef definition

class UserGroupsUpdateStatusTypeDef(TypedDict):
    UserGroupIdsToAdd: NotRequired[List[str]],
    UserGroupIdsToRemove: NotRequired[List[str]],

SlotMigrationTypeDef#

# SlotMigrationTypeDef definition

class SlotMigrationTypeDef(TypedDict):
    ProgressPercentage: NotRequired[float],

RevokeCacheSecurityGroupIngressMessageRequestTypeDef#

# RevokeCacheSecurityGroupIngressMessageRequestTypeDef definition

class RevokeCacheSecurityGroupIngressMessageRequestTypeDef(TypedDict):
    CacheSecurityGroupName: str,
    EC2SecurityGroupName: str,
    EC2SecurityGroupOwnerId: str,

ServerlessCacheConfigurationTypeDef#

# ServerlessCacheConfigurationTypeDef definition

class ServerlessCacheConfigurationTypeDef(TypedDict):
    ServerlessCacheName: NotRequired[str],
    Engine: NotRequired[str],
    MajorEngineVersion: NotRequired[str],

ServiceUpdateTypeDef#

# ServiceUpdateTypeDef definition

class ServiceUpdateTypeDef(TypedDict):
    ServiceUpdateName: NotRequired[str],
    ServiceUpdateReleaseDate: NotRequired[datetime],
    ServiceUpdateEndDate: NotRequired[datetime],
    ServiceUpdateSeverity: NotRequired[ServiceUpdateSeverityType],  # (1)
    ServiceUpdateRecommendedApplyByDate: NotRequired[datetime],
    ServiceUpdateStatus: NotRequired[ServiceUpdateStatusType],  # (2)
    ServiceUpdateDescription: NotRequired[str],
    ServiceUpdateType: NotRequired[ServiceUpdateTypeType],  # (3)
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    AutoUpdateAfterRecommendedApplyByDate: NotRequired[bool],
    EstimatedUpdateTime: NotRequired[str],
  1. See ServiceUpdateSeverityType
  2. See ServiceUpdateStatusType
  3. See ServiceUpdateTypeType

SubnetOutpostTypeDef#

# SubnetOutpostTypeDef definition

class SubnetOutpostTypeDef(TypedDict):
    SubnetOutpostArn: NotRequired[str],

TestFailoverMessageRequestTypeDef#

# TestFailoverMessageRequestTypeDef definition

class TestFailoverMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    NodeGroupId: str,

UnprocessedUpdateActionTypeDef#

# UnprocessedUpdateActionTypeDef definition

class UnprocessedUpdateActionTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    CacheClusterId: NotRequired[str],
    ServiceUpdateName: NotRequired[str],
    ErrorType: NotRequired[str],
    ErrorMessage: NotRequired[str],

UserGroupPendingChangesTypeDef#

# UserGroupPendingChangesTypeDef definition

class UserGroupPendingChangesTypeDef(TypedDict):
    UserIdsToRemove: NotRequired[List[str]],
    UserIdsToAdd: NotRequired[List[str]],

AddTagsToResourceMessageRequestTypeDef#

# AddTagsToResourceMessageRequestTypeDef definition

class AddTagsToResourceMessageRequestTypeDef(TypedDict):
    ResourceName: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CopyServerlessCacheSnapshotRequestRequestTypeDef#

# CopyServerlessCacheSnapshotRequestRequestTypeDef definition

class CopyServerlessCacheSnapshotRequestRequestTypeDef(TypedDict):
    SourceServerlessCacheSnapshotName: str,
    TargetServerlessCacheSnapshotName: str,
    KmsKeyId: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CopySnapshotMessageRequestTypeDef#

# CopySnapshotMessageRequestTypeDef definition

class CopySnapshotMessageRequestTypeDef(TypedDict):
    SourceSnapshotName: str,
    TargetSnapshotName: str,
    TargetBucket: NotRequired[str],
    KmsKeyId: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateCacheParameterGroupMessageRequestTypeDef#

# CreateCacheParameterGroupMessageRequestTypeDef definition

class CreateCacheParameterGroupMessageRequestTypeDef(TypedDict):
    CacheParameterGroupName: str,
    CacheParameterGroupFamily: str,
    Description: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateCacheSecurityGroupMessageRequestTypeDef#

# CreateCacheSecurityGroupMessageRequestTypeDef definition

class CreateCacheSecurityGroupMessageRequestTypeDef(TypedDict):
    CacheSecurityGroupName: str,
    Description: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateCacheSubnetGroupMessageRequestTypeDef#

# CreateCacheSubnetGroupMessageRequestTypeDef definition

class CreateCacheSubnetGroupMessageRequestTypeDef(TypedDict):
    CacheSubnetGroupName: str,
    CacheSubnetGroupDescription: str,
    SubnetIds: Sequence[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateServerlessCacheSnapshotRequestRequestTypeDef#

# CreateServerlessCacheSnapshotRequestRequestTypeDef definition

class CreateServerlessCacheSnapshotRequestRequestTypeDef(TypedDict):
    ServerlessCacheSnapshotName: str,
    ServerlessCacheName: str,
    KmsKeyId: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateSnapshotMessageRequestTypeDef#

# CreateSnapshotMessageRequestTypeDef definition

class CreateSnapshotMessageRequestTypeDef(TypedDict):
    SnapshotName: str,
    ReplicationGroupId: NotRequired[str],
    CacheClusterId: NotRequired[str],
    KmsKeyId: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateUserGroupMessageRequestTypeDef#

# CreateUserGroupMessageRequestTypeDef definition

class CreateUserGroupMessageRequestTypeDef(TypedDict):
    UserGroupId: str,
    Engine: str,
    UserIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

PurchaseReservedCacheNodesOfferingMessageRequestTypeDef#

# PurchaseReservedCacheNodesOfferingMessageRequestTypeDef definition

class PurchaseReservedCacheNodesOfferingMessageRequestTypeDef(TypedDict):
    ReservedCacheNodesOfferingId: str,
    ReservedCacheNodeId: NotRequired[str],
    CacheNodeCount: NotRequired[int],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

AllowedNodeTypeModificationsMessageTypeDef#

# AllowedNodeTypeModificationsMessageTypeDef definition

class AllowedNodeTypeModificationsMessageTypeDef(TypedDict):
    ScaleUpModifications: List[str],
    ScaleDownModifications: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CacheParameterGroupNameMessageTypeDef#

# CacheParameterGroupNameMessageTypeDef definition

class CacheParameterGroupNameMessageTypeDef(TypedDict):
    CacheParameterGroupName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagListMessageTypeDef#

# TagListMessageTypeDef definition

class TagListMessageTypeDef(TypedDict):
    TagList: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

CreateUserMessageRequestTypeDef#

# CreateUserMessageRequestTypeDef definition

class CreateUserMessageRequestTypeDef(TypedDict):
    UserId: str,
    UserName: str,
    Engine: str,
    AccessString: str,
    Passwords: NotRequired[Sequence[str]],
    NoPasswordRequired: NotRequired[bool],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    AuthenticationMode: NotRequired[AuthenticationModeTypeDef],  # (2)
  1. See TagTypeDef
  2. See AuthenticationModeTypeDef

ModifyUserMessageRequestTypeDef#

# ModifyUserMessageRequestTypeDef definition

class ModifyUserMessageRequestTypeDef(TypedDict):
    UserId: str,
    AccessString: NotRequired[str],
    AppendAccessString: NotRequired[str],
    Passwords: NotRequired[Sequence[str]],
    NoPasswordRequired: NotRequired[bool],
    AuthenticationMode: NotRequired[AuthenticationModeTypeDef],  # (1)
  1. See AuthenticationModeTypeDef

UserResponseTypeDef#

# UserResponseTypeDef definition

class UserResponseTypeDef(TypedDict):
    UserId: str,
    UserName: str,
    Status: str,
    Engine: str,
    MinimumEngineVersion: str,
    AccessString: str,
    UserGroupIds: List[str],
    Authentication: AuthenticationTypeDef,  # (1)
    ARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AuthenticationTypeDef
  2. See ResponseMetadataTypeDef

UserTypeDef#

# UserTypeDef definition

class UserTypeDef(TypedDict):
    UserId: NotRequired[str],
    UserName: NotRequired[str],
    Status: NotRequired[str],
    Engine: NotRequired[str],
    MinimumEngineVersion: NotRequired[str],
    AccessString: NotRequired[str],
    UserGroupIds: NotRequired[List[str]],
    Authentication: NotRequired[AuthenticationTypeDef],  # (1)
    ARN: NotRequired[str],
  1. See AuthenticationTypeDef

CacheNodeTypeDef#

# CacheNodeTypeDef definition

class CacheNodeTypeDef(TypedDict):
    CacheNodeId: NotRequired[str],
    CacheNodeStatus: NotRequired[str],
    CacheNodeCreateTime: NotRequired[datetime],
    Endpoint: NotRequired[EndpointTypeDef],  # (1)
    ParameterGroupStatus: NotRequired[str],
    SourceCacheNodeId: NotRequired[str],
    CustomerAvailabilityZone: NotRequired[str],
    CustomerOutpostArn: NotRequired[str],
  1. See EndpointTypeDef

NodeGroupMemberTypeDef#

# NodeGroupMemberTypeDef definition

class NodeGroupMemberTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    CacheNodeId: NotRequired[str],
    ReadEndpoint: NotRequired[EndpointTypeDef],  # (1)
    PreferredAvailabilityZone: NotRequired[str],
    PreferredOutpostArn: NotRequired[str],
    CurrentRole: NotRequired[str],
  1. See EndpointTypeDef

CacheEngineVersionMessageTypeDef#

# CacheEngineVersionMessageTypeDef definition

class CacheEngineVersionMessageTypeDef(TypedDict):
    Marker: str,
    CacheEngineVersions: List[CacheEngineVersionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheEngineVersionTypeDef
  2. See ResponseMetadataTypeDef

CacheNodeTypeSpecificParameterTypeDef#

# CacheNodeTypeSpecificParameterTypeDef definition

class CacheNodeTypeSpecificParameterTypeDef(TypedDict):
    ParameterName: NotRequired[str],
    Description: NotRequired[str],
    Source: NotRequired[str],
    DataType: NotRequired[str],
    AllowedValues: NotRequired[str],
    IsModifiable: NotRequired[bool],
    MinimumEngineVersion: NotRequired[str],
    CacheNodeTypeSpecificValues: NotRequired[List[CacheNodeTypeSpecificValueTypeDef]],  # (1)
    ChangeType: NotRequired[ChangeTypeType],  # (2)
  1. See CacheNodeTypeSpecificValueTypeDef
  2. See ChangeTypeType

CacheParameterGroupsMessageTypeDef#

# CacheParameterGroupsMessageTypeDef definition

class CacheParameterGroupsMessageTypeDef(TypedDict):
    Marker: str,
    CacheParameterGroups: List[CacheParameterGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateCacheParameterGroupResultTypeDef#

# CreateCacheParameterGroupResultTypeDef definition

class CreateCacheParameterGroupResultTypeDef(TypedDict):
    CacheParameterGroup: CacheParameterGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheParameterGroupTypeDef
  2. See ResponseMetadataTypeDef

CacheSecurityGroupTypeDef#

# CacheSecurityGroupTypeDef definition

class CacheSecurityGroupTypeDef(TypedDict):
    OwnerId: NotRequired[str],
    CacheSecurityGroupName: NotRequired[str],
    Description: NotRequired[str],
    EC2SecurityGroups: NotRequired[List[EC2SecurityGroupTypeDef]],  # (1)
    ARN: NotRequired[str],
  1. See EC2SecurityGroupTypeDef

CacheUsageLimitsTypeDef#

# CacheUsageLimitsTypeDef definition

class CacheUsageLimitsTypeDef(TypedDict):
    DataStorage: NotRequired[DataStorageTypeDef],  # (1)
    ECPUPerSecond: NotRequired[ECPUPerSecondTypeDef],  # (2)
  1. See DataStorageTypeDef
  2. See ECPUPerSecondTypeDef

DecreaseReplicaCountMessageRequestTypeDef#

# DecreaseReplicaCountMessageRequestTypeDef definition

class DecreaseReplicaCountMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    ApplyImmediately: bool,
    NewReplicaCount: NotRequired[int],
    ReplicaConfiguration: NotRequired[Sequence[ConfigureShardTypeDef]],  # (1)
    ReplicasToRemove: NotRequired[Sequence[str]],
  1. See ConfigureShardTypeDef

IncreaseReplicaCountMessageRequestTypeDef#

# IncreaseReplicaCountMessageRequestTypeDef definition

class IncreaseReplicaCountMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    ApplyImmediately: bool,
    NewReplicaCount: NotRequired[int],
    ReplicaConfiguration: NotRequired[Sequence[ConfigureShardTypeDef]],  # (1)
  1. See ConfigureShardTypeDef

NodeSnapshotTypeDef#

# NodeSnapshotTypeDef definition

class NodeSnapshotTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    NodeGroupId: NotRequired[str],
    CacheNodeId: NotRequired[str],
    NodeGroupConfiguration: NotRequired[NodeGroupConfigurationTypeDef],  # (1)
    CacheSize: NotRequired[str],
    CacheNodeCreateTime: NotRequired[datetime],
    SnapshotCreateTime: NotRequired[datetime],
  1. See NodeGroupConfigurationTypeDef

StartMigrationMessageRequestTypeDef#

# StartMigrationMessageRequestTypeDef definition

class StartMigrationMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    CustomerNodeEndpointList: Sequence[CustomerNodeEndpointTypeDef],  # (1)
  1. See CustomerNodeEndpointTypeDef

TestMigrationMessageRequestTypeDef#

# TestMigrationMessageRequestTypeDef definition

class TestMigrationMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    CustomerNodeEndpointList: Sequence[CustomerNodeEndpointTypeDef],  # (1)
  1. See CustomerNodeEndpointTypeDef

DescribeCacheClustersMessageCacheClusterAvailableWaitTypeDef#

# DescribeCacheClustersMessageCacheClusterAvailableWaitTypeDef definition

class DescribeCacheClustersMessageCacheClusterAvailableWaitTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    ShowCacheNodeInfo: NotRequired[bool],
    ShowCacheClustersNotInReplicationGroups: NotRequired[bool],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeCacheClustersMessageCacheClusterDeletedWaitTypeDef#

# DescribeCacheClustersMessageCacheClusterDeletedWaitTypeDef definition

class DescribeCacheClustersMessageCacheClusterDeletedWaitTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    ShowCacheNodeInfo: NotRequired[bool],
    ShowCacheClustersNotInReplicationGroups: NotRequired[bool],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeReplicationGroupsMessageReplicationGroupAvailableWaitTypeDef#

# DescribeReplicationGroupsMessageReplicationGroupAvailableWaitTypeDef definition

class DescribeReplicationGroupsMessageReplicationGroupAvailableWaitTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeReplicationGroupsMessageReplicationGroupDeletedWaitTypeDef#

# DescribeReplicationGroupsMessageReplicationGroupDeletedWaitTypeDef definition

class DescribeReplicationGroupsMessageReplicationGroupDeletedWaitTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef#

# DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef definition

class DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    ShowCacheNodeInfo: NotRequired[bool],
    ShowCacheClustersNotInReplicationGroups: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef#

# DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef definition

class DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef(TypedDict):
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    CacheParameterGroupFamily: NotRequired[str],
    DefaultOnly: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef#

# DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef definition

class DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef(TypedDict):
    CacheParameterGroupName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef#

# DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef definition

class DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef(TypedDict):
    CacheParameterGroupName: str,
    Source: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef#

# DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef definition

class DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef(TypedDict):
    CacheSecurityGroupName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef#

# DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef definition

class DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef(TypedDict):
    CacheSubnetGroupName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef#

# DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef definition

class DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef(TypedDict):
    CacheParameterGroupFamily: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef#

# DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef definition

class DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef(TypedDict):
    GlobalReplicationGroupId: NotRequired[str],
    ShowMemberInfo: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef#

# DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef definition

class DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeReservedCacheNodesMessageDescribeReservedCacheNodesPaginateTypeDef#

# DescribeReservedCacheNodesMessageDescribeReservedCacheNodesPaginateTypeDef definition

class DescribeReservedCacheNodesMessageDescribeReservedCacheNodesPaginateTypeDef(TypedDict):
    ReservedCacheNodeId: NotRequired[str],
    ReservedCacheNodesOfferingId: NotRequired[str],
    CacheNodeType: NotRequired[str],
    Duration: NotRequired[str],
    ProductDescription: NotRequired[str],
    OfferingType: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeReservedCacheNodesOfferingsMessageDescribeReservedCacheNodesOfferingsPaginateTypeDef#

# DescribeReservedCacheNodesOfferingsMessageDescribeReservedCacheNodesOfferingsPaginateTypeDef definition

class DescribeReservedCacheNodesOfferingsMessageDescribeReservedCacheNodesOfferingsPaginateTypeDef(TypedDict):
    ReservedCacheNodesOfferingId: NotRequired[str],
    CacheNodeType: NotRequired[str],
    Duration: NotRequired[str],
    ProductDescription: NotRequired[str],
    OfferingType: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeServerlessCacheSnapshotsRequestDescribeServerlessCacheSnapshotsPaginateTypeDef#

# DescribeServerlessCacheSnapshotsRequestDescribeServerlessCacheSnapshotsPaginateTypeDef definition

class DescribeServerlessCacheSnapshotsRequestDescribeServerlessCacheSnapshotsPaginateTypeDef(TypedDict):
    ServerlessCacheName: NotRequired[str],
    ServerlessCacheSnapshotName: NotRequired[str],
    SnapshotType: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeServerlessCachesRequestDescribeServerlessCachesPaginateTypeDef#

# DescribeServerlessCachesRequestDescribeServerlessCachesPaginateTypeDef definition

class DescribeServerlessCachesRequestDescribeServerlessCachesPaginateTypeDef(TypedDict):
    ServerlessCacheName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeServiceUpdatesMessageDescribeServiceUpdatesPaginateTypeDef#

# DescribeServiceUpdatesMessageDescribeServiceUpdatesPaginateTypeDef definition

class DescribeServiceUpdatesMessageDescribeServiceUpdatesPaginateTypeDef(TypedDict):
    ServiceUpdateName: NotRequired[str],
    ServiceUpdateStatus: NotRequired[Sequence[ServiceUpdateStatusType]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ServiceUpdateStatusType
  2. See PaginatorConfigTypeDef

DescribeSnapshotsMessageDescribeSnapshotsPaginateTypeDef#

# DescribeSnapshotsMessageDescribeSnapshotsPaginateTypeDef definition

class DescribeSnapshotsMessageDescribeSnapshotsPaginateTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    CacheClusterId: NotRequired[str],
    SnapshotName: NotRequired[str],
    SnapshotSource: NotRequired[str],
    ShowNodeGroupConfig: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeUserGroupsMessageDescribeUserGroupsPaginateTypeDef#

# DescribeUserGroupsMessageDescribeUserGroupsPaginateTypeDef definition

class DescribeUserGroupsMessageDescribeUserGroupsPaginateTypeDef(TypedDict):
    UserGroupId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeEventsMessageDescribeEventsPaginateTypeDef#

# DescribeEventsMessageDescribeEventsPaginateTypeDef definition

class DescribeEventsMessageDescribeEventsPaginateTypeDef(TypedDict):
    SourceIdentifier: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    Duration: NotRequired[int],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SourceTypeType
  2. See PaginatorConfigTypeDef

DescribeEventsMessageRequestTypeDef#

# DescribeEventsMessageRequestTypeDef definition

class DescribeEventsMessageRequestTypeDef(TypedDict):
    SourceIdentifier: NotRequired[str],
    SourceType: NotRequired[SourceTypeType],  # (1)
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    Duration: NotRequired[int],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See SourceTypeType

TimeRangeFilterTypeDef#

# TimeRangeFilterTypeDef definition

class TimeRangeFilterTypeDef(TypedDict):
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],

DescribeUsersMessageDescribeUsersPaginateTypeDef#

# DescribeUsersMessageDescribeUsersPaginateTypeDef definition

class DescribeUsersMessageDescribeUsersPaginateTypeDef(TypedDict):
    Engine: NotRequired[str],
    UserId: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef

DescribeUsersMessageRequestTypeDef#

# DescribeUsersMessageRequestTypeDef definition

class DescribeUsersMessageRequestTypeDef(TypedDict):
    Engine: NotRequired[str],
    UserId: NotRequired[str],
    Filters: NotRequired[Sequence[FilterTypeDef]],  # (1)
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See FilterTypeDef

DestinationDetailsTypeDef#

# DestinationDetailsTypeDef definition

class DestinationDetailsTypeDef(TypedDict):
    CloudWatchLogsDetails: NotRequired[CloudWatchLogsDestinationDetailsTypeDef],  # (1)
    KinesisFirehoseDetails: NotRequired[KinesisFirehoseDestinationDetailsTypeDef],  # (2)
  1. See CloudWatchLogsDestinationDetailsTypeDef
  2. See KinesisFirehoseDestinationDetailsTypeDef

EventsMessageTypeDef#

# EventsMessageTypeDef definition

class EventsMessageTypeDef(TypedDict):
    Marker: str,
    Events: List[EventTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventTypeDef
  2. See ResponseMetadataTypeDef

GlobalReplicationGroupTypeDef#

# GlobalReplicationGroupTypeDef definition

class GlobalReplicationGroupTypeDef(TypedDict):
    GlobalReplicationGroupId: NotRequired[str],
    GlobalReplicationGroupDescription: NotRequired[str],
    Status: NotRequired[str],
    CacheNodeType: NotRequired[str],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    Members: NotRequired[List[GlobalReplicationGroupMemberTypeDef]],  # (1)
    ClusterEnabled: NotRequired[bool],
    GlobalNodeGroups: NotRequired[List[GlobalNodeGroupTypeDef]],  # (2)
    AuthTokenEnabled: NotRequired[bool],
    TransitEncryptionEnabled: NotRequired[bool],
    AtRestEncryptionEnabled: NotRequired[bool],
    ARN: NotRequired[str],
  1. See GlobalReplicationGroupMemberTypeDef
  2. See GlobalNodeGroupTypeDef

ModifyCacheParameterGroupMessageRequestTypeDef#

# ModifyCacheParameterGroupMessageRequestTypeDef definition

class ModifyCacheParameterGroupMessageRequestTypeDef(TypedDict):
    CacheParameterGroupName: str,
    ParameterNameValues: Sequence[ParameterNameValueTypeDef],  # (1)
  1. See ParameterNameValueTypeDef

ResetCacheParameterGroupMessageRequestTypeDef#

# ResetCacheParameterGroupMessageRequestTypeDef definition

class ResetCacheParameterGroupMessageRequestTypeDef(TypedDict):
    CacheParameterGroupName: str,
    ResetAllParameters: NotRequired[bool],
    ParameterNameValues: NotRequired[Sequence[ParameterNameValueTypeDef]],  # (1)
  1. See ParameterNameValueTypeDef

ModifyReplicationGroupShardConfigurationMessageRequestTypeDef#

# ModifyReplicationGroupShardConfigurationMessageRequestTypeDef definition

class ModifyReplicationGroupShardConfigurationMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    NodeGroupCount: int,
    ApplyImmediately: bool,
    ReshardingConfiguration: NotRequired[Sequence[ReshardingConfigurationTypeDef]],  # (1)
    NodeGroupsToRemove: NotRequired[Sequence[str]],
    NodeGroupsToRetain: NotRequired[Sequence[str]],
  1. See ReshardingConfigurationTypeDef

RegionalConfigurationTypeDef#

# RegionalConfigurationTypeDef definition

class RegionalConfigurationTypeDef(TypedDict):
    ReplicationGroupId: str,
    ReplicationGroupRegion: str,
    ReshardingConfiguration: Sequence[ReshardingConfigurationTypeDef],  # (1)
  1. See ReshardingConfigurationTypeDef

NodeGroupUpdateStatusTypeDef#

# NodeGroupUpdateStatusTypeDef definition

class NodeGroupUpdateStatusTypeDef(TypedDict):
    NodeGroupId: NotRequired[str],
    NodeGroupMemberUpdateStatus: NotRequired[List[NodeGroupMemberUpdateStatusTypeDef]],  # (1)
  1. See NodeGroupMemberUpdateStatusTypeDef

ReservedCacheNodeTypeDef#

# ReservedCacheNodeTypeDef definition

class ReservedCacheNodeTypeDef(TypedDict):
    ReservedCacheNodeId: NotRequired[str],
    ReservedCacheNodesOfferingId: NotRequired[str],
    CacheNodeType: NotRequired[str],
    StartTime: NotRequired[datetime],
    Duration: NotRequired[int],
    FixedPrice: NotRequired[float],
    UsagePrice: NotRequired[float],
    CacheNodeCount: NotRequired[int],
    ProductDescription: NotRequired[str],
    OfferingType: NotRequired[str],
    State: NotRequired[str],
    RecurringCharges: NotRequired[List[RecurringChargeTypeDef]],  # (1)
    ReservationARN: NotRequired[str],
  1. See RecurringChargeTypeDef

ReservedCacheNodesOfferingTypeDef#

# ReservedCacheNodesOfferingTypeDef definition

class ReservedCacheNodesOfferingTypeDef(TypedDict):
    ReservedCacheNodesOfferingId: NotRequired[str],
    CacheNodeType: NotRequired[str],
    Duration: NotRequired[int],
    FixedPrice: NotRequired[float],
    UsagePrice: NotRequired[float],
    ProductDescription: NotRequired[str],
    OfferingType: NotRequired[str],
    RecurringCharges: NotRequired[List[RecurringChargeTypeDef]],  # (1)
  1. See RecurringChargeTypeDef

ReshardingStatusTypeDef#

# ReshardingStatusTypeDef definition

class ReshardingStatusTypeDef(TypedDict):
    SlotMigration: NotRequired[SlotMigrationTypeDef],  # (1)
  1. See SlotMigrationTypeDef

ServerlessCacheSnapshotTypeDef#

# ServerlessCacheSnapshotTypeDef definition

class ServerlessCacheSnapshotTypeDef(TypedDict):
    ServerlessCacheSnapshotName: NotRequired[str],
    ARN: NotRequired[str],
    KmsKeyId: NotRequired[str],
    SnapshotType: NotRequired[str],
    Status: NotRequired[str],
    CreateTime: NotRequired[datetime],
    ExpiryTime: NotRequired[datetime],
    BytesUsedForCache: NotRequired[str],
    ServerlessCacheConfiguration: NotRequired[ServerlessCacheConfigurationTypeDef],  # (1)
  1. See ServerlessCacheConfigurationTypeDef

ServiceUpdatesMessageTypeDef#

# ServiceUpdatesMessageTypeDef definition

class ServiceUpdatesMessageTypeDef(TypedDict):
    Marker: str,
    ServiceUpdates: List[ServiceUpdateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceUpdateTypeDef
  2. See ResponseMetadataTypeDef

SubnetTypeDef#

# SubnetTypeDef definition

class SubnetTypeDef(TypedDict):
    SubnetIdentifier: NotRequired[str],
    SubnetAvailabilityZone: NotRequired[AvailabilityZoneTypeDef],  # (1)
    SubnetOutpost: NotRequired[SubnetOutpostTypeDef],  # (2)
    SupportedNetworkTypes: NotRequired[List[NetworkTypeType]],  # (3)
  1. See AvailabilityZoneTypeDef
  2. See SubnetOutpostTypeDef
  3. See NetworkTypeType

UpdateActionResultsMessageTypeDef#

# UpdateActionResultsMessageTypeDef definition

class UpdateActionResultsMessageTypeDef(TypedDict):
    ProcessedUpdateActions: List[ProcessedUpdateActionTypeDef],  # (1)
    UnprocessedUpdateActions: List[UnprocessedUpdateActionTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ProcessedUpdateActionTypeDef
  2. See UnprocessedUpdateActionTypeDef
  3. See ResponseMetadataTypeDef

UserGroupResponseTypeDef#

# UserGroupResponseTypeDef definition

class UserGroupResponseTypeDef(TypedDict):
    UserGroupId: str,
    Status: str,
    Engine: str,
    UserIds: List[str],
    MinimumEngineVersion: str,
    PendingChanges: UserGroupPendingChangesTypeDef,  # (1)
    ReplicationGroups: List[str],
    ServerlessCaches: List[str],
    ARN: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserGroupPendingChangesTypeDef
  2. See ResponseMetadataTypeDef

UserGroupTypeDef#

# UserGroupTypeDef definition

class UserGroupTypeDef(TypedDict):
    UserGroupId: NotRequired[str],
    Status: NotRequired[str],
    Engine: NotRequired[str],
    UserIds: NotRequired[List[str]],
    MinimumEngineVersion: NotRequired[str],
    PendingChanges: NotRequired[UserGroupPendingChangesTypeDef],  # (1)
    ReplicationGroups: NotRequired[List[str]],
    ServerlessCaches: NotRequired[List[str]],
    ARN: NotRequired[str],
  1. See UserGroupPendingChangesTypeDef

DescribeUsersResultTypeDef#

# DescribeUsersResultTypeDef definition

class DescribeUsersResultTypeDef(TypedDict):
    Users: List[UserTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. See ResponseMetadataTypeDef

NodeGroupTypeDef#

# NodeGroupTypeDef definition

class NodeGroupTypeDef(TypedDict):
    NodeGroupId: NotRequired[str],
    Status: NotRequired[str],
    PrimaryEndpoint: NotRequired[EndpointTypeDef],  # (1)
    ReaderEndpoint: NotRequired[EndpointTypeDef],  # (1)
    Slots: NotRequired[str],
    NodeGroupMembers: NotRequired[List[NodeGroupMemberTypeDef]],  # (3)
  1. See EndpointTypeDef
  2. See EndpointTypeDef
  3. See NodeGroupMemberTypeDef

CacheParameterGroupDetailsTypeDef#

# CacheParameterGroupDetailsTypeDef definition

class CacheParameterGroupDetailsTypeDef(TypedDict):
    Marker: str,
    Parameters: List[ParameterTypeDef],  # (1)
    CacheNodeTypeSpecificParameters: List[CacheNodeTypeSpecificParameterTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ParameterTypeDef
  2. See CacheNodeTypeSpecificParameterTypeDef
  3. See ResponseMetadataTypeDef

EngineDefaultsTypeDef#

# EngineDefaultsTypeDef definition

class EngineDefaultsTypeDef(TypedDict):
    CacheParameterGroupFamily: NotRequired[str],
    Marker: NotRequired[str],
    Parameters: NotRequired[List[ParameterTypeDef]],  # (1)
    CacheNodeTypeSpecificParameters: NotRequired[List[CacheNodeTypeSpecificParameterTypeDef]],  # (2)
  1. See ParameterTypeDef
  2. See CacheNodeTypeSpecificParameterTypeDef

AuthorizeCacheSecurityGroupIngressResultTypeDef#

# AuthorizeCacheSecurityGroupIngressResultTypeDef definition

class AuthorizeCacheSecurityGroupIngressResultTypeDef(TypedDict):
    CacheSecurityGroup: CacheSecurityGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheSecurityGroupTypeDef
  2. See ResponseMetadataTypeDef

CacheSecurityGroupMessageTypeDef#

# CacheSecurityGroupMessageTypeDef definition

class CacheSecurityGroupMessageTypeDef(TypedDict):
    Marker: str,
    CacheSecurityGroups: List[CacheSecurityGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheSecurityGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateCacheSecurityGroupResultTypeDef#

# CreateCacheSecurityGroupResultTypeDef definition

class CreateCacheSecurityGroupResultTypeDef(TypedDict):
    CacheSecurityGroup: CacheSecurityGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheSecurityGroupTypeDef
  2. See ResponseMetadataTypeDef

RevokeCacheSecurityGroupIngressResultTypeDef#

# RevokeCacheSecurityGroupIngressResultTypeDef definition

class RevokeCacheSecurityGroupIngressResultTypeDef(TypedDict):
    CacheSecurityGroup: CacheSecurityGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheSecurityGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateServerlessCacheRequestRequestTypeDef#

# CreateServerlessCacheRequestRequestTypeDef definition

class CreateServerlessCacheRequestRequestTypeDef(TypedDict):
    ServerlessCacheName: str,
    Engine: str,
    Description: NotRequired[str],
    MajorEngineVersion: NotRequired[str],
    CacheUsageLimits: NotRequired[CacheUsageLimitsTypeDef],  # (1)
    KmsKeyId: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    SnapshotArnsToRestore: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    UserGroupId: NotRequired[str],
    SubnetIds: NotRequired[Sequence[str]],
    SnapshotRetentionLimit: NotRequired[int],
    DailySnapshotTime: NotRequired[str],
  1. See CacheUsageLimitsTypeDef
  2. See TagTypeDef

ModifyServerlessCacheRequestRequestTypeDef#

# ModifyServerlessCacheRequestRequestTypeDef definition

class ModifyServerlessCacheRequestRequestTypeDef(TypedDict):
    ServerlessCacheName: str,
    Description: NotRequired[str],
    CacheUsageLimits: NotRequired[CacheUsageLimitsTypeDef],  # (1)
    RemoveUserGroup: NotRequired[bool],
    UserGroupId: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    SnapshotRetentionLimit: NotRequired[int],
    DailySnapshotTime: NotRequired[str],
  1. See CacheUsageLimitsTypeDef

ServerlessCacheTypeDef#

# ServerlessCacheTypeDef definition

class ServerlessCacheTypeDef(TypedDict):
    ServerlessCacheName: NotRequired[str],
    Description: NotRequired[str],
    CreateTime: NotRequired[datetime],
    Status: NotRequired[str],
    Engine: NotRequired[str],
    MajorEngineVersion: NotRequired[str],
    FullEngineVersion: NotRequired[str],
    CacheUsageLimits: NotRequired[CacheUsageLimitsTypeDef],  # (1)
    KmsKeyId: NotRequired[str],
    SecurityGroupIds: NotRequired[List[str]],
    Endpoint: NotRequired[EndpointTypeDef],  # (2)
    ReaderEndpoint: NotRequired[EndpointTypeDef],  # (2)
    ARN: NotRequired[str],
    UserGroupId: NotRequired[str],
    SubnetIds: NotRequired[List[str]],
    SnapshotRetentionLimit: NotRequired[int],
    DailySnapshotTime: NotRequired[str],
  1. See CacheUsageLimitsTypeDef
  2. See EndpointTypeDef
  3. See EndpointTypeDef

SnapshotTypeDef#

# SnapshotTypeDef definition

class SnapshotTypeDef(TypedDict):
    SnapshotName: NotRequired[str],
    ReplicationGroupId: NotRequired[str],
    ReplicationGroupDescription: NotRequired[str],
    CacheClusterId: NotRequired[str],
    SnapshotStatus: NotRequired[str],
    SnapshotSource: NotRequired[str],
    CacheNodeType: NotRequired[str],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    NumCacheNodes: NotRequired[int],
    PreferredAvailabilityZone: NotRequired[str],
    PreferredOutpostArn: NotRequired[str],
    CacheClusterCreateTime: NotRequired[datetime],
    PreferredMaintenanceWindow: NotRequired[str],
    TopicArn: NotRequired[str],
    Port: NotRequired[int],
    CacheParameterGroupName: NotRequired[str],
    CacheSubnetGroupName: NotRequired[str],
    VpcId: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    SnapshotRetentionLimit: NotRequired[int],
    SnapshotWindow: NotRequired[str],
    NumNodeGroups: NotRequired[int],
    AutomaticFailover: NotRequired[AutomaticFailoverStatusType],  # (1)
    NodeSnapshots: NotRequired[List[NodeSnapshotTypeDef]],  # (2)
    KmsKeyId: NotRequired[str],
    ARN: NotRequired[str],
    DataTiering: NotRequired[DataTieringStatusType],  # (3)
  1. See AutomaticFailoverStatusType
  2. See NodeSnapshotTypeDef
  3. See DataTieringStatusType

DescribeUpdateActionsMessageDescribeUpdateActionsPaginateTypeDef#

# DescribeUpdateActionsMessageDescribeUpdateActionsPaginateTypeDef definition

class DescribeUpdateActionsMessageDescribeUpdateActionsPaginateTypeDef(TypedDict):
    ServiceUpdateName: NotRequired[str],
    ReplicationGroupIds: NotRequired[Sequence[str]],
    CacheClusterIds: NotRequired[Sequence[str]],
    Engine: NotRequired[str],
    ServiceUpdateStatus: NotRequired[Sequence[ServiceUpdateStatusType]],  # (1)
    ServiceUpdateTimeRange: NotRequired[TimeRangeFilterTypeDef],  # (2)
    UpdateActionStatus: NotRequired[Sequence[UpdateActionStatusType]],  # (3)
    ShowNodeLevelUpdateStatus: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See ServiceUpdateStatusType
  2. See TimeRangeFilterTypeDef
  3. See UpdateActionStatusType
  4. See PaginatorConfigTypeDef

DescribeUpdateActionsMessageRequestTypeDef#

# DescribeUpdateActionsMessageRequestTypeDef definition

class DescribeUpdateActionsMessageRequestTypeDef(TypedDict):
    ServiceUpdateName: NotRequired[str],
    ReplicationGroupIds: NotRequired[Sequence[str]],
    CacheClusterIds: NotRequired[Sequence[str]],
    Engine: NotRequired[str],
    ServiceUpdateStatus: NotRequired[Sequence[ServiceUpdateStatusType]],  # (1)
    ServiceUpdateTimeRange: NotRequired[TimeRangeFilterTypeDef],  # (2)
    UpdateActionStatus: NotRequired[Sequence[UpdateActionStatusType]],  # (3)
    ShowNodeLevelUpdateStatus: NotRequired[bool],
    MaxRecords: NotRequired[int],
    Marker: NotRequired[str],
  1. See ServiceUpdateStatusType
  2. See TimeRangeFilterTypeDef
  3. See UpdateActionStatusType

LogDeliveryConfigurationRequestTypeDef#

# LogDeliveryConfigurationRequestTypeDef definition

class LogDeliveryConfigurationRequestTypeDef(TypedDict):
    LogType: NotRequired[LogTypeType],  # (1)
    DestinationType: NotRequired[DestinationTypeType],  # (2)
    DestinationDetails: NotRequired[DestinationDetailsTypeDef],  # (3)
    LogFormat: NotRequired[LogFormatType],  # (4)
    Enabled: NotRequired[bool],
  1. See LogTypeType
  2. See DestinationTypeType
  3. See DestinationDetailsTypeDef
  4. See LogFormatType

LogDeliveryConfigurationTypeDef#

# LogDeliveryConfigurationTypeDef definition

class LogDeliveryConfigurationTypeDef(TypedDict):
    LogType: NotRequired[LogTypeType],  # (1)
    DestinationType: NotRequired[DestinationTypeType],  # (2)
    DestinationDetails: NotRequired[DestinationDetailsTypeDef],  # (3)
    LogFormat: NotRequired[LogFormatType],  # (4)
    Status: NotRequired[LogDeliveryConfigurationStatusType],  # (5)
    Message: NotRequired[str],
  1. See LogTypeType
  2. See DestinationTypeType
  3. See DestinationDetailsTypeDef
  4. See LogFormatType
  5. See LogDeliveryConfigurationStatusType

PendingLogDeliveryConfigurationTypeDef#

# PendingLogDeliveryConfigurationTypeDef definition

class PendingLogDeliveryConfigurationTypeDef(TypedDict):
    LogType: NotRequired[LogTypeType],  # (1)
    DestinationType: NotRequired[DestinationTypeType],  # (2)
    DestinationDetails: NotRequired[DestinationDetailsTypeDef],  # (3)
    LogFormat: NotRequired[LogFormatType],  # (4)
  1. See LogTypeType
  2. See DestinationTypeType
  3. See DestinationDetailsTypeDef
  4. See LogFormatType

CreateGlobalReplicationGroupResultTypeDef#

# CreateGlobalReplicationGroupResultTypeDef definition

class CreateGlobalReplicationGroupResultTypeDef(TypedDict):
    GlobalReplicationGroup: GlobalReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef#

# DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef definition

class DecreaseNodeGroupsInGlobalReplicationGroupResultTypeDef(TypedDict):
    GlobalReplicationGroup: GlobalReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

DeleteGlobalReplicationGroupResultTypeDef#

# DeleteGlobalReplicationGroupResultTypeDef definition

class DeleteGlobalReplicationGroupResultTypeDef(TypedDict):
    GlobalReplicationGroup: GlobalReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

DescribeGlobalReplicationGroupsResultTypeDef#

# DescribeGlobalReplicationGroupsResultTypeDef definition

class DescribeGlobalReplicationGroupsResultTypeDef(TypedDict):
    Marker: str,
    GlobalReplicationGroups: List[GlobalReplicationGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

DisassociateGlobalReplicationGroupResultTypeDef#

# DisassociateGlobalReplicationGroupResultTypeDef definition

class DisassociateGlobalReplicationGroupResultTypeDef(TypedDict):
    GlobalReplicationGroup: GlobalReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

FailoverGlobalReplicationGroupResultTypeDef#

# FailoverGlobalReplicationGroupResultTypeDef definition

class FailoverGlobalReplicationGroupResultTypeDef(TypedDict):
    GlobalReplicationGroup: GlobalReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

IncreaseNodeGroupsInGlobalReplicationGroupResultTypeDef#

# IncreaseNodeGroupsInGlobalReplicationGroupResultTypeDef definition

class IncreaseNodeGroupsInGlobalReplicationGroupResultTypeDef(TypedDict):
    GlobalReplicationGroup: GlobalReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

ModifyGlobalReplicationGroupResultTypeDef#

# ModifyGlobalReplicationGroupResultTypeDef definition

class ModifyGlobalReplicationGroupResultTypeDef(TypedDict):
    GlobalReplicationGroup: GlobalReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

RebalanceSlotsInGlobalReplicationGroupResultTypeDef#

# RebalanceSlotsInGlobalReplicationGroupResultTypeDef definition

class RebalanceSlotsInGlobalReplicationGroupResultTypeDef(TypedDict):
    GlobalReplicationGroup: GlobalReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GlobalReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

IncreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef#

# IncreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef definition

class IncreaseNodeGroupsInGlobalReplicationGroupMessageRequestTypeDef(TypedDict):
    GlobalReplicationGroupId: str,
    NodeGroupCount: int,
    ApplyImmediately: bool,
    RegionalConfigurations: NotRequired[Sequence[RegionalConfigurationTypeDef]],  # (1)
  1. See RegionalConfigurationTypeDef

UpdateActionTypeDef#

# UpdateActionTypeDef definition

class UpdateActionTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    CacheClusterId: NotRequired[str],
    ServiceUpdateName: NotRequired[str],
    ServiceUpdateReleaseDate: NotRequired[datetime],
    ServiceUpdateSeverity: NotRequired[ServiceUpdateSeverityType],  # (1)
    ServiceUpdateStatus: NotRequired[ServiceUpdateStatusType],  # (2)
    ServiceUpdateRecommendedApplyByDate: NotRequired[datetime],
    ServiceUpdateType: NotRequired[ServiceUpdateTypeType],  # (3)
    UpdateActionAvailableDate: NotRequired[datetime],
    UpdateActionStatus: NotRequired[UpdateActionStatusType],  # (4)
    NodesUpdated: NotRequired[str],
    UpdateActionStatusModifiedDate: NotRequired[datetime],
    SlaMet: NotRequired[SlaMetType],  # (5)
    NodeGroupUpdateStatus: NotRequired[List[NodeGroupUpdateStatusTypeDef]],  # (6)
    CacheNodeUpdateStatus: NotRequired[List[CacheNodeUpdateStatusTypeDef]],  # (7)
    EstimatedUpdateTime: NotRequired[str],
    Engine: NotRequired[str],
  1. See ServiceUpdateSeverityType
  2. See ServiceUpdateStatusType
  3. See ServiceUpdateTypeType
  4. See UpdateActionStatusType
  5. See SlaMetType
  6. See NodeGroupUpdateStatusTypeDef
  7. See CacheNodeUpdateStatusTypeDef

PurchaseReservedCacheNodesOfferingResultTypeDef#

# PurchaseReservedCacheNodesOfferingResultTypeDef definition

class PurchaseReservedCacheNodesOfferingResultTypeDef(TypedDict):
    ReservedCacheNode: ReservedCacheNodeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReservedCacheNodeTypeDef
  2. See ResponseMetadataTypeDef

ReservedCacheNodeMessageTypeDef#

# ReservedCacheNodeMessageTypeDef definition

class ReservedCacheNodeMessageTypeDef(TypedDict):
    Marker: str,
    ReservedCacheNodes: List[ReservedCacheNodeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReservedCacheNodeTypeDef
  2. See ResponseMetadataTypeDef

ReservedCacheNodesOfferingMessageTypeDef#

# ReservedCacheNodesOfferingMessageTypeDef definition

class ReservedCacheNodesOfferingMessageTypeDef(TypedDict):
    Marker: str,
    ReservedCacheNodesOfferings: List[ReservedCacheNodesOfferingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReservedCacheNodesOfferingTypeDef
  2. See ResponseMetadataTypeDef

CopyServerlessCacheSnapshotResponseTypeDef#

# CopyServerlessCacheSnapshotResponseTypeDef definition

class CopyServerlessCacheSnapshotResponseTypeDef(TypedDict):
    ServerlessCacheSnapshot: ServerlessCacheSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheSnapshotTypeDef
  2. See ResponseMetadataTypeDef

CreateServerlessCacheSnapshotResponseTypeDef#

# CreateServerlessCacheSnapshotResponseTypeDef definition

class CreateServerlessCacheSnapshotResponseTypeDef(TypedDict):
    ServerlessCacheSnapshot: ServerlessCacheSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DeleteServerlessCacheSnapshotResponseTypeDef#

# DeleteServerlessCacheSnapshotResponseTypeDef definition

class DeleteServerlessCacheSnapshotResponseTypeDef(TypedDict):
    ServerlessCacheSnapshot: ServerlessCacheSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheSnapshotTypeDef
  2. See ResponseMetadataTypeDef

DescribeServerlessCacheSnapshotsResponseTypeDef#

# DescribeServerlessCacheSnapshotsResponseTypeDef definition

class DescribeServerlessCacheSnapshotsResponseTypeDef(TypedDict):
    NextToken: str,
    ServerlessCacheSnapshots: List[ServerlessCacheSnapshotTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheSnapshotTypeDef
  2. See ResponseMetadataTypeDef

ExportServerlessCacheSnapshotResponseTypeDef#

# ExportServerlessCacheSnapshotResponseTypeDef definition

class ExportServerlessCacheSnapshotResponseTypeDef(TypedDict):
    ServerlessCacheSnapshot: ServerlessCacheSnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheSnapshotTypeDef
  2. See ResponseMetadataTypeDef

CacheSubnetGroupTypeDef#

# CacheSubnetGroupTypeDef definition

class CacheSubnetGroupTypeDef(TypedDict):
    CacheSubnetGroupName: NotRequired[str],
    CacheSubnetGroupDescription: NotRequired[str],
    VpcId: NotRequired[str],
    Subnets: NotRequired[List[SubnetTypeDef]],  # (1)
    ARN: NotRequired[str],
    SupportedNetworkTypes: NotRequired[List[NetworkTypeType]],  # (2)
  1. See SubnetTypeDef
  2. See NetworkTypeType

DescribeUserGroupsResultTypeDef#

# DescribeUserGroupsResultTypeDef definition

class DescribeUserGroupsResultTypeDef(TypedDict):
    UserGroups: List[UserGroupTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserGroupTypeDef
  2. See ResponseMetadataTypeDef

DescribeEngineDefaultParametersResultTypeDef#

# DescribeEngineDefaultParametersResultTypeDef definition

class DescribeEngineDefaultParametersResultTypeDef(TypedDict):
    EngineDefaults: EngineDefaultsTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EngineDefaultsTypeDef
  2. See ResponseMetadataTypeDef

CreateServerlessCacheResponseTypeDef#

# CreateServerlessCacheResponseTypeDef definition

class CreateServerlessCacheResponseTypeDef(TypedDict):
    ServerlessCache: ServerlessCacheTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheTypeDef
  2. See ResponseMetadataTypeDef

DeleteServerlessCacheResponseTypeDef#

# DeleteServerlessCacheResponseTypeDef definition

class DeleteServerlessCacheResponseTypeDef(TypedDict):
    ServerlessCache: ServerlessCacheTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheTypeDef
  2. See ResponseMetadataTypeDef

DescribeServerlessCachesResponseTypeDef#

# DescribeServerlessCachesResponseTypeDef definition

class DescribeServerlessCachesResponseTypeDef(TypedDict):
    NextToken: str,
    ServerlessCaches: List[ServerlessCacheTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheTypeDef
  2. See ResponseMetadataTypeDef

ModifyServerlessCacheResponseTypeDef#

# ModifyServerlessCacheResponseTypeDef definition

class ModifyServerlessCacheResponseTypeDef(TypedDict):
    ServerlessCache: ServerlessCacheTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerlessCacheTypeDef
  2. See ResponseMetadataTypeDef

CopySnapshotResultTypeDef#

# CopySnapshotResultTypeDef definition

class CopySnapshotResultTypeDef(TypedDict):
    Snapshot: SnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotTypeDef
  2. See ResponseMetadataTypeDef

CreateSnapshotResultTypeDef#

# CreateSnapshotResultTypeDef definition

class CreateSnapshotResultTypeDef(TypedDict):
    Snapshot: SnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotTypeDef
  2. See ResponseMetadataTypeDef

DeleteSnapshotResultTypeDef#

# DeleteSnapshotResultTypeDef definition

class DeleteSnapshotResultTypeDef(TypedDict):
    Snapshot: SnapshotTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotTypeDef
  2. See ResponseMetadataTypeDef

DescribeSnapshotsListMessageTypeDef#

# DescribeSnapshotsListMessageTypeDef definition

class DescribeSnapshotsListMessageTypeDef(TypedDict):
    Marker: str,
    Snapshots: List[SnapshotTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SnapshotTypeDef
  2. See ResponseMetadataTypeDef

CreateCacheClusterMessageRequestTypeDef#

# CreateCacheClusterMessageRequestTypeDef definition

class CreateCacheClusterMessageRequestTypeDef(TypedDict):
    CacheClusterId: str,
    ReplicationGroupId: NotRequired[str],
    AZMode: NotRequired[AZModeType],  # (1)
    PreferredAvailabilityZone: NotRequired[str],
    PreferredAvailabilityZones: NotRequired[Sequence[str]],
    NumCacheNodes: NotRequired[int],
    CacheNodeType: NotRequired[str],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    CacheParameterGroupName: NotRequired[str],
    CacheSubnetGroupName: NotRequired[str],
    CacheSecurityGroupNames: NotRequired[Sequence[str]],
    SecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    SnapshotArns: NotRequired[Sequence[str]],
    SnapshotName: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    Port: NotRequired[int],
    NotificationTopicArn: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    SnapshotRetentionLimit: NotRequired[int],
    SnapshotWindow: NotRequired[str],
    AuthToken: NotRequired[str],
    OutpostMode: NotRequired[OutpostModeType],  # (3)
    PreferredOutpostArn: NotRequired[str],
    PreferredOutpostArns: NotRequired[Sequence[str]],
    LogDeliveryConfigurations: NotRequired[Sequence[LogDeliveryConfigurationRequestTypeDef]],  # (4)
    TransitEncryptionEnabled: NotRequired[bool],
    NetworkType: NotRequired[NetworkTypeType],  # (5)
    IpDiscovery: NotRequired[IpDiscoveryType],  # (6)
  1. See AZModeType
  2. See TagTypeDef
  3. See OutpostModeType
  4. See LogDeliveryConfigurationRequestTypeDef
  5. See NetworkTypeType
  6. See IpDiscoveryType

CreateReplicationGroupMessageRequestTypeDef#

# CreateReplicationGroupMessageRequestTypeDef definition

class CreateReplicationGroupMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    ReplicationGroupDescription: str,
    GlobalReplicationGroupId: NotRequired[str],
    PrimaryClusterId: NotRequired[str],
    AutomaticFailoverEnabled: NotRequired[bool],
    MultiAZEnabled: NotRequired[bool],
    NumCacheClusters: NotRequired[int],
    PreferredCacheClusterAZs: NotRequired[Sequence[str]],
    NumNodeGroups: NotRequired[int],
    ReplicasPerNodeGroup: NotRequired[int],
    NodeGroupConfiguration: NotRequired[Sequence[NodeGroupConfigurationTypeDef]],  # (1)
    CacheNodeType: NotRequired[str],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    CacheParameterGroupName: NotRequired[str],
    CacheSubnetGroupName: NotRequired[str],
    CacheSecurityGroupNames: NotRequired[Sequence[str]],
    SecurityGroupIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    SnapshotArns: NotRequired[Sequence[str]],
    SnapshotName: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    Port: NotRequired[int],
    NotificationTopicArn: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    SnapshotRetentionLimit: NotRequired[int],
    SnapshotWindow: NotRequired[str],
    AuthToken: NotRequired[str],
    TransitEncryptionEnabled: NotRequired[bool],
    AtRestEncryptionEnabled: NotRequired[bool],
    KmsKeyId: NotRequired[str],
    UserGroupIds: NotRequired[Sequence[str]],
    LogDeliveryConfigurations: NotRequired[Sequence[LogDeliveryConfigurationRequestTypeDef]],  # (3)
    DataTieringEnabled: NotRequired[bool],
    NetworkType: NotRequired[NetworkTypeType],  # (4)
    IpDiscovery: NotRequired[IpDiscoveryType],  # (5)
    TransitEncryptionMode: NotRequired[TransitEncryptionModeType],  # (6)
    ClusterMode: NotRequired[ClusterModeType],  # (7)
    ServerlessCacheSnapshotName: NotRequired[str],
  1. See NodeGroupConfigurationTypeDef
  2. See TagTypeDef
  3. See LogDeliveryConfigurationRequestTypeDef
  4. See NetworkTypeType
  5. See IpDiscoveryType
  6. See TransitEncryptionModeType
  7. See ClusterModeType

ModifyCacheClusterMessageRequestTypeDef#

# ModifyCacheClusterMessageRequestTypeDef definition

class ModifyCacheClusterMessageRequestTypeDef(TypedDict):
    CacheClusterId: str,
    NumCacheNodes: NotRequired[int],
    CacheNodeIdsToRemove: NotRequired[Sequence[str]],
    AZMode: NotRequired[AZModeType],  # (1)
    NewAvailabilityZones: NotRequired[Sequence[str]],
    CacheSecurityGroupNames: NotRequired[Sequence[str]],
    SecurityGroupIds: NotRequired[Sequence[str]],
    PreferredMaintenanceWindow: NotRequired[str],
    NotificationTopicArn: NotRequired[str],
    CacheParameterGroupName: NotRequired[str],
    NotificationTopicStatus: NotRequired[str],
    ApplyImmediately: NotRequired[bool],
    EngineVersion: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    SnapshotRetentionLimit: NotRequired[int],
    SnapshotWindow: NotRequired[str],
    CacheNodeType: NotRequired[str],
    AuthToken: NotRequired[str],
    AuthTokenUpdateStrategy: NotRequired[AuthTokenUpdateStrategyTypeType],  # (2)
    LogDeliveryConfigurations: NotRequired[Sequence[LogDeliveryConfigurationRequestTypeDef]],  # (3)
    IpDiscovery: NotRequired[IpDiscoveryType],  # (4)
  1. See AZModeType
  2. See AuthTokenUpdateStrategyTypeType
  3. See LogDeliveryConfigurationRequestTypeDef
  4. See IpDiscoveryType

ModifyReplicationGroupMessageRequestTypeDef#

# ModifyReplicationGroupMessageRequestTypeDef definition

class ModifyReplicationGroupMessageRequestTypeDef(TypedDict):
    ReplicationGroupId: str,
    ReplicationGroupDescription: NotRequired[str],
    PrimaryClusterId: NotRequired[str],
    SnapshottingClusterId: NotRequired[str],
    AutomaticFailoverEnabled: NotRequired[bool],
    MultiAZEnabled: NotRequired[bool],
    NodeGroupId: NotRequired[str],
    CacheSecurityGroupNames: NotRequired[Sequence[str]],
    SecurityGroupIds: NotRequired[Sequence[str]],
    PreferredMaintenanceWindow: NotRequired[str],
    NotificationTopicArn: NotRequired[str],
    CacheParameterGroupName: NotRequired[str],
    NotificationTopicStatus: NotRequired[str],
    ApplyImmediately: NotRequired[bool],
    EngineVersion: NotRequired[str],
    AutoMinorVersionUpgrade: NotRequired[bool],
    SnapshotRetentionLimit: NotRequired[int],
    SnapshotWindow: NotRequired[str],
    CacheNodeType: NotRequired[str],
    AuthToken: NotRequired[str],
    AuthTokenUpdateStrategy: NotRequired[AuthTokenUpdateStrategyTypeType],  # (1)
    UserGroupIdsToAdd: NotRequired[Sequence[str]],
    UserGroupIdsToRemove: NotRequired[Sequence[str]],
    RemoveUserGroups: NotRequired[bool],
    LogDeliveryConfigurations: NotRequired[Sequence[LogDeliveryConfigurationRequestTypeDef]],  # (2)
    IpDiscovery: NotRequired[IpDiscoveryType],  # (3)
    TransitEncryptionEnabled: NotRequired[bool],
    TransitEncryptionMode: NotRequired[TransitEncryptionModeType],  # (4)
    ClusterMode: NotRequired[ClusterModeType],  # (5)
  1. See AuthTokenUpdateStrategyTypeType
  2. See LogDeliveryConfigurationRequestTypeDef
  3. See IpDiscoveryType
  4. See TransitEncryptionModeType
  5. See ClusterModeType

PendingModifiedValuesTypeDef#

# PendingModifiedValuesTypeDef definition

class PendingModifiedValuesTypeDef(TypedDict):
    NumCacheNodes: NotRequired[int],
    CacheNodeIdsToRemove: NotRequired[List[str]],
    EngineVersion: NotRequired[str],
    CacheNodeType: NotRequired[str],
    AuthTokenStatus: NotRequired[AuthTokenUpdateStatusType],  # (1)
    LogDeliveryConfigurations: NotRequired[List[PendingLogDeliveryConfigurationTypeDef]],  # (2)
    TransitEncryptionEnabled: NotRequired[bool],
    TransitEncryptionMode: NotRequired[TransitEncryptionModeType],  # (3)
  1. See AuthTokenUpdateStatusType
  2. See PendingLogDeliveryConfigurationTypeDef
  3. See TransitEncryptionModeType

ReplicationGroupPendingModifiedValuesTypeDef#

# ReplicationGroupPendingModifiedValuesTypeDef definition

class ReplicationGroupPendingModifiedValuesTypeDef(TypedDict):
    PrimaryClusterId: NotRequired[str],
    AutomaticFailoverStatus: NotRequired[PendingAutomaticFailoverStatusType],  # (1)
    Resharding: NotRequired[ReshardingStatusTypeDef],  # (2)
    AuthTokenStatus: NotRequired[AuthTokenUpdateStatusType],  # (3)
    UserGroups: NotRequired[UserGroupsUpdateStatusTypeDef],  # (4)
    LogDeliveryConfigurations: NotRequired[List[PendingLogDeliveryConfigurationTypeDef]],  # (5)
    TransitEncryptionEnabled: NotRequired[bool],
    TransitEncryptionMode: NotRequired[TransitEncryptionModeType],  # (6)
    ClusterMode: NotRequired[ClusterModeType],  # (7)
  1. See PendingAutomaticFailoverStatusType
  2. See ReshardingStatusTypeDef
  3. See AuthTokenUpdateStatusType
  4. See UserGroupsUpdateStatusTypeDef
  5. See PendingLogDeliveryConfigurationTypeDef
  6. See TransitEncryptionModeType
  7. See ClusterModeType

UpdateActionsMessageTypeDef#

# UpdateActionsMessageTypeDef definition

class UpdateActionsMessageTypeDef(TypedDict):
    Marker: str,
    UpdateActions: List[UpdateActionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UpdateActionTypeDef
  2. See ResponseMetadataTypeDef

CacheSubnetGroupMessageTypeDef#

# CacheSubnetGroupMessageTypeDef definition

class CacheSubnetGroupMessageTypeDef(TypedDict):
    Marker: str,
    CacheSubnetGroups: List[CacheSubnetGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheSubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateCacheSubnetGroupResultTypeDef#

# CreateCacheSubnetGroupResultTypeDef definition

class CreateCacheSubnetGroupResultTypeDef(TypedDict):
    CacheSubnetGroup: CacheSubnetGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheSubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

ModifyCacheSubnetGroupResultTypeDef#

# ModifyCacheSubnetGroupResultTypeDef definition

class ModifyCacheSubnetGroupResultTypeDef(TypedDict):
    CacheSubnetGroup: CacheSubnetGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheSubnetGroupTypeDef
  2. See ResponseMetadataTypeDef

CacheClusterTypeDef#

# CacheClusterTypeDef definition

class CacheClusterTypeDef(TypedDict):
    CacheClusterId: NotRequired[str],
    ConfigurationEndpoint: NotRequired[EndpointTypeDef],  # (1)
    ClientDownloadLandingPage: NotRequired[str],
    CacheNodeType: NotRequired[str],
    Engine: NotRequired[str],
    EngineVersion: NotRequired[str],
    CacheClusterStatus: NotRequired[str],
    NumCacheNodes: NotRequired[int],
    PreferredAvailabilityZone: NotRequired[str],
    PreferredOutpostArn: NotRequired[str],
    CacheClusterCreateTime: NotRequired[datetime],
    PreferredMaintenanceWindow: NotRequired[str],
    PendingModifiedValues: NotRequired[PendingModifiedValuesTypeDef],  # (2)
    NotificationConfiguration: NotRequired[NotificationConfigurationTypeDef],  # (3)
    CacheSecurityGroups: NotRequired[List[CacheSecurityGroupMembershipTypeDef]],  # (4)
    CacheParameterGroup: NotRequired[CacheParameterGroupStatusTypeDef],  # (5)
    CacheSubnetGroupName: NotRequired[str],
    CacheNodes: NotRequired[List[CacheNodeTypeDef]],  # (6)
    AutoMinorVersionUpgrade: NotRequired[bool],
    SecurityGroups: NotRequired[List[SecurityGroupMembershipTypeDef]],  # (7)
    ReplicationGroupId: NotRequired[str],
    SnapshotRetentionLimit: NotRequired[int],
    SnapshotWindow: NotRequired[str],
    AuthTokenEnabled: NotRequired[bool],
    AuthTokenLastModifiedDate: NotRequired[datetime],
    TransitEncryptionEnabled: NotRequired[bool],
    AtRestEncryptionEnabled: NotRequired[bool],
    ARN: NotRequired[str],
    ReplicationGroupLogDeliveryEnabled: NotRequired[bool],
    LogDeliveryConfigurations: NotRequired[List[LogDeliveryConfigurationTypeDef]],  # (8)
    NetworkType: NotRequired[NetworkTypeType],  # (9)
    IpDiscovery: NotRequired[IpDiscoveryType],  # (10)
    TransitEncryptionMode: NotRequired[TransitEncryptionModeType],  # (11)
  1. See EndpointTypeDef
  2. See PendingModifiedValuesTypeDef
  3. See NotificationConfigurationTypeDef
  4. See CacheSecurityGroupMembershipTypeDef
  5. See CacheParameterGroupStatusTypeDef
  6. See CacheNodeTypeDef
  7. See SecurityGroupMembershipTypeDef
  8. See LogDeliveryConfigurationTypeDef
  9. See NetworkTypeType
  10. See IpDiscoveryType
  11. See TransitEncryptionModeType

ReplicationGroupTypeDef#

# ReplicationGroupTypeDef definition

class ReplicationGroupTypeDef(TypedDict):
    ReplicationGroupId: NotRequired[str],
    Description: NotRequired[str],
    GlobalReplicationGroupInfo: NotRequired[GlobalReplicationGroupInfoTypeDef],  # (1)
    Status: NotRequired[str],
    PendingModifiedValues: NotRequired[ReplicationGroupPendingModifiedValuesTypeDef],  # (2)
    MemberClusters: NotRequired[List[str]],
    NodeGroups: NotRequired[List[NodeGroupTypeDef]],  # (3)
    SnapshottingClusterId: NotRequired[str],
    AutomaticFailover: NotRequired[AutomaticFailoverStatusType],  # (4)
    MultiAZ: NotRequired[MultiAZStatusType],  # (5)
    ConfigurationEndpoint: NotRequired[EndpointTypeDef],  # (6)
    SnapshotRetentionLimit: NotRequired[int],
    SnapshotWindow: NotRequired[str],
    ClusterEnabled: NotRequired[bool],
    CacheNodeType: NotRequired[str],
    AuthTokenEnabled: NotRequired[bool],
    AuthTokenLastModifiedDate: NotRequired[datetime],
    TransitEncryptionEnabled: NotRequired[bool],
    AtRestEncryptionEnabled: NotRequired[bool],
    MemberClustersOutpostArns: NotRequired[List[str]],
    KmsKeyId: NotRequired[str],
    ARN: NotRequired[str],
    UserGroupIds: NotRequired[List[str]],
    LogDeliveryConfigurations: NotRequired[List[LogDeliveryConfigurationTypeDef]],  # (7)
    ReplicationGroupCreateTime: NotRequired[datetime],
    DataTiering: NotRequired[DataTieringStatusType],  # (8)
    AutoMinorVersionUpgrade: NotRequired[bool],
    NetworkType: NotRequired[NetworkTypeType],  # (9)
    IpDiscovery: NotRequired[IpDiscoveryType],  # (10)
    TransitEncryptionMode: NotRequired[TransitEncryptionModeType],  # (11)
    ClusterMode: NotRequired[ClusterModeType],  # (12)
  1. See GlobalReplicationGroupInfoTypeDef
  2. See ReplicationGroupPendingModifiedValuesTypeDef
  3. See NodeGroupTypeDef
  4. See AutomaticFailoverStatusType
  5. See MultiAZStatusType
  6. See EndpointTypeDef
  7. See LogDeliveryConfigurationTypeDef
  8. See DataTieringStatusType
  9. See NetworkTypeType
  10. See IpDiscoveryType
  11. See TransitEncryptionModeType
  12. See ClusterModeType

CacheClusterMessageTypeDef#

# CacheClusterMessageTypeDef definition

class CacheClusterMessageTypeDef(TypedDict):
    Marker: str,
    CacheClusters: List[CacheClusterTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheClusterTypeDef
  2. See ResponseMetadataTypeDef

CreateCacheClusterResultTypeDef#

# CreateCacheClusterResultTypeDef definition

class CreateCacheClusterResultTypeDef(TypedDict):
    CacheCluster: CacheClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheClusterTypeDef
  2. See ResponseMetadataTypeDef

DeleteCacheClusterResultTypeDef#

# DeleteCacheClusterResultTypeDef definition

class DeleteCacheClusterResultTypeDef(TypedDict):
    CacheCluster: CacheClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheClusterTypeDef
  2. See ResponseMetadataTypeDef

ModifyCacheClusterResultTypeDef#

# ModifyCacheClusterResultTypeDef definition

class ModifyCacheClusterResultTypeDef(TypedDict):
    CacheCluster: CacheClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheClusterTypeDef
  2. See ResponseMetadataTypeDef

RebootCacheClusterResultTypeDef#

# RebootCacheClusterResultTypeDef definition

class RebootCacheClusterResultTypeDef(TypedDict):
    CacheCluster: CacheClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CacheClusterTypeDef
  2. See ResponseMetadataTypeDef

CompleteMigrationResponseTypeDef#

# CompleteMigrationResponseTypeDef definition

class CompleteMigrationResponseTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

CreateReplicationGroupResultTypeDef#

# CreateReplicationGroupResultTypeDef definition

class CreateReplicationGroupResultTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

DecreaseReplicaCountResultTypeDef#

# DecreaseReplicaCountResultTypeDef definition

class DecreaseReplicaCountResultTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

DeleteReplicationGroupResultTypeDef#

# DeleteReplicationGroupResultTypeDef definition

class DeleteReplicationGroupResultTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

IncreaseReplicaCountResultTypeDef#

# IncreaseReplicaCountResultTypeDef definition

class IncreaseReplicaCountResultTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

ModifyReplicationGroupResultTypeDef#

# ModifyReplicationGroupResultTypeDef definition

class ModifyReplicationGroupResultTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

ModifyReplicationGroupShardConfigurationResultTypeDef#

# ModifyReplicationGroupShardConfigurationResultTypeDef definition

class ModifyReplicationGroupShardConfigurationResultTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

ReplicationGroupMessageTypeDef#

# ReplicationGroupMessageTypeDef definition

class ReplicationGroupMessageTypeDef(TypedDict):
    Marker: str,
    ReplicationGroups: List[ReplicationGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

StartMigrationResponseTypeDef#

# StartMigrationResponseTypeDef definition

class StartMigrationResponseTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

TestFailoverResultTypeDef#

# TestFailoverResultTypeDef definition

class TestFailoverResultTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef

TestMigrationResponseTypeDef#

# TestMigrationResponseTypeDef definition

class TestMigrationResponseTypeDef(TypedDict):
    ReplicationGroup: ReplicationGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ReplicationGroupTypeDef
  2. See ResponseMetadataTypeDef